Merge pull request #2266 from spryker/feature/cc-31362/dev-click-and-…

…collect-developer-overview CC-31362 Click and collect developer overview
spryker · Jan 8, 2024 · 1b0d467 · 1b0d467
2 parents b497404 + 82519f7
commit 1b0d467
Show file tree

Hide file tree

Showing 21 changed files with 541 additions and 12 deletions.
diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml
@@ -3549,6 +3549,27 @@ entries:
                 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: Click & Collect domains
+                url: /docs/pbc/all/service-point-management/unified-commerce/click-collect-domains/click-collect-domains.html
+                nested:
+                  - title: Marketplace Merchant Product Offer Service Point subdomain
+                    url: /docs/pbc/all/service-point-management/unified-commerce/click-collect-domains/click-collect-marketplace-merchant-product-offer-service-point-availability-subdomain.html
+                  - title: Product Offer Service Point Availability subdomain
+                    url: /docs/pbc/all/service-point-management/unified-commerce/click-collect-domains/click-collect-product-offer-service-point-availability-subdomain.html
+                  - title: Product Offer Service Point subdomain
+                    url: /docs/pbc/all/service-point-management/unified-commerce/click-collect-domains/click-collect-product-offer-service-point-subdomain.html
+                  - title: Product Offer Shipment Type Availability subdomain
+                    url: /docs/pbc/all/service-point-management/unified-commerce/click-collect-domains/click-collect-product-offer-shipment-type-availability-subdomain.html
+                  - title: Product Offer Shipment Type subdomain
+                    url: /docs/pbc/all/service-point-management/unified-commerce/click-collect-domains/click-collect-product-offer-shipment-type-subdomain.html
+                  - title: Service Point Cart subdomain
+                    url: /docs/pbc/all/service-point-management/unified-commerce/click-collect-domains/click-collect-service-point-cart-subdomain.html
+                  - title: Service Points domain
+                    url: /docs/pbc/all/service-point-management/unified-commerce/click-collect-domains/click-collect-service-points-domain.html
+                  - title: Shipment Type Service Point subdomain
+                    url: /docs/pbc/all/service-point-management/unified-commerce/click-collect-domains/click-collect-shipment-type-service-point-subdomain.html
+                  - title: Shipment Types domain
+                    url: /docs/pbc/all/service-point-management/unified-commerce/click-collect-domains/click-collect-shipment-types-domain.html
               - title: Enable Click & Collect
                 url: /docs/pbc/all/service-point-management/unified-commerce/enable-click-collect.html
               - title: Install features

diff --git a/_includes/pbc/all/install-features/202204.0/install-the-navigation-module.md b/_includes/pbc/all/install-features/202204.0/install-the-navigation-module.md
@@ -56,7 +56,7 @@ class CollectorDependencyProvider extends SprykerCollectorDependencyProvider
 }
 ```
 
-### Data Setup
+### 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. <!--Check out our Demoshop implementation for examples and ideas.-->
 

diff --git a/_includes/pbc/all/install-features/202212.0/install-the-navigation-module.md b/_includes/pbc/all/install-features/202212.0/install-the-navigation-module.md
@@ -56,7 +56,7 @@ class CollectorDependencyProvider extends SprykerCollectorDependencyProvider
 }
 ```
 
-### Data Setup
+### 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. <!--Check out our Demoshop implementation for examples and ideas.-->
 

diff --git a/_includes/pbc/all/install-features/202307.0/install-the-navigation-module.md b/_includes/pbc/all/install-features/202307.0/install-the-navigation-module.md
@@ -56,7 +56,7 @@ class CollectorDependencyProvider extends SprykerCollectorDependencyProvider
 }
 ```
 
-### Data Setup
+### 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. <!--Check out our Demoshop implementation for examples and ideas.-->
 

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
@@ -56,7 +56,7 @@ class CollectorDependencyProvider extends SprykerCollectorDependencyProvider
 }
 ```
 
-### Data Setup
+### 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. <!--Check out our Demoshop implementation for examples and ideas.-->
 

diff --git a/...manage-using-glue-api/manage-shipment-types/glue-api-retrieve-shipment-types.md b/...manage-using-glue-api/manage-shipment-types/glue-api-retrieve-shipment-types.md
@@ -79,7 +79,7 @@ This endpoint lets you retrieve shipment types.
 }
 ```
 
-<details>
+</details>
 
 <details>
   <summary>Storefront: Retrieve shipment types</summary>

diff --git a/...nage-push-notification-providers/glue-api-delete-push-notification-providers.md b/...nage-push-notification-providers/glue-api-delete-push-notification-providers.md
@@ -14,7 +14,7 @@ This endpoint lets you delete push notification providers.
 ## Retrieve push notification providers
 
 ***
-`DELETE` **{% raw %}*{{backend_url}}*{% endraw %}/push-notification-providers/*{% raw %}{{push_notification_provider_id}}{% endraw %}***
+`DELETE` **{% raw %}*{{backend_url}}*{% endraw %}/push-notification-providers/*{% raw %}*{{push_notification_provider_id}}*{% endraw %}**
 ***
 
 

diff --git a/...ge-push-notification-providers/glue-api-retrieve-push-notification-providers.md b/...ge-push-notification-providers/glue-api-retrieve-push-notification-providers.md
@@ -80,7 +80,7 @@ Request sample: `GET https://glue-backend.de.b2c.demo-spryker.com/push-notificat
 
 
 ***
-`GET` **{% raw %}*{{backend_url}}*{% endraw %}/push-notification-providers/*{% raw %}{{push_notification_provider_id}}{% endraw %}***
+`GET` **{% raw %}*{{backend_url}}*{% endraw %}/push-notification-providers/*{% raw %}*{{push_notification_provider_id}}{% endraw %}***
 ***
 
 

diff --git a/...nage-push-notification-providers/glue-api-update-push-notification-providers.md b/...nage-push-notification-providers/glue-api-update-push-notification-providers.md
@@ -14,7 +14,7 @@ This endpoint lets you update push notification providers.
 ## Retrieve push notification providers
 
 ***
-`PATCH` **{% raw %}*{{backend_url}}*{% endraw %}/push-notification-providers/*{% raw %}{{push_notification_provider_id}}{% endraw %}***
+`PATCH` **{% raw %}*{{backend_url}}*{% endraw %}/push-notification-providers/{% raw %}*{{push_notification_provider_id}}*{% endraw %}**
 ***
 
 

diff --git a/...gement/202311.0/unified-commerce/click-collect-domains/click-collect-domains.md b/...gement/202311.0/unified-commerce/click-collect-domains/click-collect-domains.md
diff --git a/...lect-marketplace-merchant-product-offer-service-point-availability-subdomain.md b/...lect-marketplace-merchant-product-offer-service-point-availability-subdomain.md
@@ -0,0 +1,20 @@
+---
+title: "Click & Collect: Marketplace Merchant Product Offer Service Point subdomain"
+last_updated: Nov 02, 2023
+description: The Marketplace Merchant Product Offer Service Point Availability subdomain facilitates the calculation of merchant product availability at service points.
+template: concept-topic-template
+---
+
+The Marketplace Merchant Product Offer Service Point Availability subdomain is used to calculate merchant product availability at service points.
+
+## Installation
+
+[Marketplace Merchant Product Offer Service Points Availability feature](/docs/pbc/all/offer-management/{{page.version}}/unified-commerce/install-features/install-the-marketplace-merchant-product-offer-service-points-availability-feature.html)
+
+## Modules
+
+| MODULE                                                | EXPECTED DIRECTORY                                                           |
+|-------------------------------------------------------|------------------------------------------------------------------------------|
+| MerchantProductOfferServicePointAvailability          | vendor/spryker/merchant-product-offer-service-point-availability             |
+| MerchantProductOfferServicePointAvailabilitiesRestApi | vendor/spryker/merchant-product-offer-service-point-availabilities-rest-api  |
+| MerchantProductOfferServicePointAvailabilityWidget    | vendor/spryker-shop/merchant-product-offer-service-point-availability-widget |
diff --git a/...ect-domains/click-collect-product-offer-service-point-availability-subdomain.md b/...ect-domains/click-collect-product-offer-service-point-availability-subdomain.md
@@ -0,0 +1,38 @@
+---
+title: "Click & Collect: Product Offer Service Point Availability subdomain"
+last_updated: Nov 02, 2023
+description: The Product Offer Service Point Availability subdomain provides the extension points for calculating and filtering data related to the availability of a product offer at a service point.
+template: concept-topic-template
+---
+
+The Product Offer Service Point Availability subdomain is used to calculate product availability at service points.
+
+## Installation
+
+[Install the Product Offer Service Points Availability feature](/docs/pbc/all/offer-management/{{page.version}}/unified-commerce/install-features/install-the-product-offer-service-points-availability-feature.html)
+
+## Modules
+
+| MODULE                                                         | EXPECTED DIRECTORY                                                                   |
+|----------------------------------------------------------------|--------------------------------------------------------------------------------------|
+| ProductOfferServicePointAvailabilitiesRestApi                  | vendor/spryker/product-offer-service-point-availabilities-rest-api                   |
+| ProductOfferServicePointAvailability                           | vendor/spryker/product-offer-service-point-availability                              |
+| ProductOfferServicePointAvailabilityCalculatorStorage          | vendor/spryker/product-offer-service-point-availability-calculator-storage           |
+| ProductOfferServicePointAvailabilityCalculatorStorageExtension | vendor/spryker/product-offer-service-point-availability-calculator-storage-extension |
+| ProductOfferServicePointAvailabilityStorage                    | vendor/spryker/product-offer-service-point-availability-storage                      |
+| ProductOfferServicePointAvailabilityStorageExtension           | vendor/spryker/product-offer-service-point-availability-storage-extension            |
+
+## Extension point for calculating the availability of a product offer at a service point
+
+The plugin is used to calculate product offer availability at the service point based on specific needs: `\Spryker\Client\ProductOfferServicePointAvailabilityCalculatorStorageExtension\Dependency\Plugin\ProductOfferServicePointAvailabilityCalculatorStrategyPluginInterface`.
+
+The following example plugin calculates product offer availabilities per service point for each item in the request based on the provided conditions:
+`\Spryker\Client\ClickAndCollectExample\Plugin\ExampleClickAndCollectProductOfferServicePointAvailabilityCalculatorStrategyPlugin`.
+
+
+## Extension point for filtering data about the availability of a product offer at a service point
+
+Provides the ability to filter product offer service point availability collection by a provided criteria. The plugin gets executed after a list of `ProductOfferServicePointAvailabilityResponseItemTransfer` is created: `\Spryker\Client\ProductOfferServicePointAvailabilityStorageExtension\Dependency\Plugin\ProductOfferServicePointAvailabilityFilterPluginInterface`.
+
+
+The following example plugin filters product offer availability data at the service point by shipment type if it exists in the criteria of the availability request: `\Spryker\Client\ProductOfferShipmentTypeAvailabilityStorage\Plugin\ProductOfferServicePointAvailabilityStorage\ShipmentTypeProductOfferServicePointAvailabilityFilterPlugin`.
diff --git a/...ce/click-collect-domains/click-collect-product-offer-service-point-subdomain.md b/...ce/click-collect-domains/click-collect-product-offer-service-point-subdomain.md
@@ -0,0 +1,41 @@
+---
+title: "Click & Collect: Product Offer Service Point subdomain"
+last_updated: Nov 02, 2023
+description: The Product Offer Service Point subdomain establishes the connection between product offers and service points.
+template: concept-topic-template
+---
+
+
+The Product Offer Service Point subdomain refers to the connection between product offers and service points.
+
+## Installation
+
+[Install the Product Offer Service Points feature](/docs/pbc/all/offer-management/{{page.version}}/unified-commerce/install-features/install-the-product-offer-service-points-feature.html)
+
+## Modules
+
+| MODULE                                                         | EXPECTED DIRECTORY                                                                   |
+|----------------------------------------------------------------|--------------------------------------------------------------------------------------|
+| ProductOfferServicePoint                                       | vendor/spryker/product-offer-service-point                                           |
+| ProductOfferServicePointAvailabilitiesRestApi                  | vendor/spryker/product-offer-service-point-availabilities-rest-api                   |
+| ProductOfferServicePointAvailability                           | vendor/spryker/product-offer-service-point-availability                              |
+| ProductOfferServicePointAvailabilityCalculatorStorage          | vendor/spryker/product-offer-service-point-availability-calculator-storage           |
+| ProductOfferServicePointAvailabilityCalculatorStorageExtension | vendor/spryker/product-offer-service-point-availability-calculator-storage-extension |
+| ProductOfferServicePointAvailabilityStorage                    | vendor/spryker/product-offer-service-point-availability-storage                      |
+| ProductOfferServicePointAvailabilityStorageExtension           | vendor/spryker/product-offer-service-point-availability-storage-extension            |
+| ProductOfferServicePointDataImport                             | vendor/spryker/product-offer-service-point-data-import                               |
+| ProductOfferServicePointGui                                    | vendor/spryker/product-offer-service-point-gui                                       |
+| ProductOfferServicePointMerchantPortalGui                      | vendor/spryker/product-offer-service-point-merchant-portal-gui                       |
+| ProductOfferServicePointStorage                                | vendor/spryker/product-offer-service-point-storage                                   |
+| ProductOfferServicePointStorageExtension                       | vendor/spryker/product-offer-service-point-storage-extension                         |
+| ProductOfferServicePointAvailabilityWidget                     | vendor/spryker-shop/product-offer-service-point-availability-widget                  |
+
+## Data setup
+
+The `ProductOfferServicePointDataImport` module lets you import the relationships between product offers and service points.
+
+## Extension point for filtering services assigned to the product offers before publishing them to Storage
+
+This extension point provides the ability to filter the Product Offer Service collection before publishing it to storage: `\Spryker\Zed\ProductOfferServicePointStorageExtension\Dependency\Plugin\ProductOfferServiceCollectionStorageFilterPluginInterface`.
+
+The following example plugin filters the product offer services collection by active and approved merchants: `\Spryker\Zed\MerchantProductOfferStorage\Communication\Plugin\ProductOfferServicePointStorage\MerchantProductOfferServiceStorageFilterPlugin`.
diff --git a/...ect-domains/click-collect-product-offer-shipment-type-availability-subdomain.md b/...ect-domains/click-collect-product-offer-shipment-type-availability-subdomain.md
@@ -0,0 +1,19 @@
+---
+title: "Click & Collect: Product Offer Shipment Type Availability subdomain"
+last_updated: Nov 02, 2023
+description:  The Product Offer Shipment Type Availability subdomain enables the availability calculation.
+template: concept-topic-template
+---
+
+The Product Offer Shipment Type Availability subdomain focuses on the availability calculation.
+
+## Installation
+
+[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)
+
+## Modules
+
+| MODULE                                      | EXPECTED DIRECTORY                                              |
+|---------------------------------------------|-----------------------------------------------------------------|
+| ProductOfferShipmentTypeAvailability        | vendor/spryker/product-offer-shipment-type-availability         |
+| ProductOfferShipmentTypeAvailabilityStorage | vendor/spryker/product-offer-shipment-type-availability-storage |
diff --git a/...ce/click-collect-domains/click-collect-product-offer-shipment-type-subdomain.md b/...ce/click-collect-domains/click-collect-product-offer-shipment-type-subdomain.md
@@ -0,0 +1,35 @@
+---
+title: "Click & Collect: Product Offer Shipment Type subdomain"
+last_updated: Nov 02, 2023
+description: The Product Offer Shipment Type subdomain establishes the connection between product offers and shipment types.
+
+template: concept-topic-template
+---
+
+The Product Offer Shipment Type subdomain establishes the connection between product offers and shipment types.
+
+## Installation
+
+[Install the Product Offer Shipment feature](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-feature.html)
+
+## Modules
+
+| MODULE                                                  | EXPECTED DIRECTORY                                                           |
+|---------------------------------------------------------|------------------------------------------------------------------------------|
+| ProductOfferShipmentType                                | vendor/spryker/product-offer-shipment-type                                   |
+| ProductOfferShipmentTypeAvailability                    | vendor/spryker/product-offer-shipment-type-availability                      |
+| ProductOfferShipmentTypeDataImport                      | vendor/spryker/product-offer-shipment-type-data-import                       |
+| ProductOfferShipmentTypeGui                             | vendor/spryker/product-offer-shipment-type-gui                               |
+| ProductOfferShipmentTypeMerchantPortalGui               | vendor/spryker/product-offer-shipment-type-merchant-portal-gui               |
+| ProductOfferShipmentTypeStorage                         | vendor/spryker/product-offer-shipment-type-storage                           |
+| ProductOfferShipmentTypeStorageExtension                | vendor/spryker/product-offer-shipment-type-storage-extension                 |
+
+## Data setup
+
+The `ProductOfferShipmentTypeDataImport` module lets you import the relationships between shipment types and product offers.
+
+## Extension point for filtering shipment types assigned to product offers before publishing them to the Storage
+
+This extension point provides the ability to filter the product offer shipment type collection before publishing it to storage :`\Spryker\Zed\ProductOfferShipmentTypeStorageExtension\Dependency\Plugin\ProductOfferShipmentTypeStorageFilterPluginInterface`.
+
+The following example plugin filters out `ProductOfferShipmentTypeCollectionTransfer.productOfferShipmentTypes` with product offers from inactive merchants: `\Spryker\Zed\MerchantProductOfferStorage\Communication\Plugin\ProductOfferShipmentTypeStorage\MerchantProductOfferShipmentTypeStorageFilterPlugin`.