Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CC-31362 Click and collect developer overview #2266

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
94834c9
CC-31362 Begin adding the information
AsonUnique Oct 12, 2023
55405fb
CC-31363 add extension points
artem-png Oct 19, 2023
1edb3bf
CC-31362 add domains and subdomains with extension points
artem-png Oct 24, 2023
c989b38
Merge branch 'master' of github.com:spryker/spryker-docs into feature…
artem-png Nov 2, 2023
6a02482
CC-31362 Split documentation + fixes
artem-png Nov 2, 2023
d2b534d
CC-31362 update domain model
artem-png Nov 2, 2023
ae321b0
CC-31362: Added the fixes after the technical review.
abitskil Nov 13, 2023
6b9f8ee
CC-31362: Added improvements to the documentation.
abitskil Nov 14, 2023
96cbcf9
CC-31362: Extended the Domain model description.
abitskil Nov 14, 2023
d39a754
CC-32362: Improved the domain model description.
abitskil Nov 14, 2023
a54aff0
CC-32362: Fixed the name of the paragraph.
abitskil Nov 14, 2023
db7c207
CC-32362: Fixed the product offer link.
abitskil Nov 14, 2023
bbe9e7a
CC-32362: Restored the ERD diagram.
abitskil Nov 14, 2023
4640bbc
Improved Click and Collect feature walkthrough doc
valerio8787 Nov 16, 2023
63caf68
Fix typos
valerio8787 Nov 17, 2023
8591d1b
CC-31210: Added merchant subdomain and address substitution.
abitskil Nov 17, 2023
d3d2878
CC-31210: Added an address substitution in Yves.
abitskil Nov 20, 2023
4a8496e
CC-31210: Fixed the sentence.
abitskil Nov 20, 2023
b7440c7
CC-31210: Fixed the sentence.
abitskil Nov 20, 2023
fdb9928
Updated Click and Collect dev guidlines
valerio8787 Nov 21, 2023
fd06ea1
CC-31362: Updated the guide with the cart merge information.
abitskil Dec 7, 2023
26399a1
Merge branch 'master' of github.com:spryker/spryker-docs into feature…
artem-png Dec 12, 2023
84fc181
Merge branch 'feature/cc-31362/dev-click-and-collect-developer-overvi…
artem-png Dec 12, 2023
d6c4f50
Merge branch 'master' into feature/cc-31362/dev-click-and-collect-dev…
andriitserkovnyi Dec 18, 2023
9ce3713
move docs
andriitserkovnyi Dec 18, 2023
9758200
review
andriitserkovnyi Dec 18, 2023
94ca6a3
review
andriitserkovnyi Dec 19, 2023
e5d67d6
review
andriitserkovnyi Dec 19, 2023
f31ca63
Merge branch 'master' into feature/cc-31362/dev-click-and-collect-dev…
andriitserkovnyi Dec 26, 2023
04733b9
Update shipment-types-domain-walkthrough.md
andriitserkovnyi Dec 26, 2023
c475baf
review
andriitserkovnyi Dec 26, 2023
2eae994
sidebar
andriitserkovnyi Jan 2, 2024
ca69e56
Merge branch 'master' into feature/cc-31362/dev-click-and-collect-dev…
andriitserkovnyi Jan 2, 2024
d377c96
Update click-collect-domains.md
andriitserkovnyi Jan 2, 2024
8c42c83
Update click-collect-domains.md
andriitserkovnyi Jan 2, 2024
a7c7b9c
Merge branch 'master' into feature/cc-31362/dev-click-and-collect-dev…
andriitserkovnyi Jan 3, 2024
cd47035
finalize
andriitserkovnyi Jan 3, 2024
f181e50
links
andriitserkovnyi Jan 8, 2024
a76e63d
fixes
andriitserkovnyi Jan 8, 2024
06300b1
Update click-collect-product-offer-shipment-type-availability-subdoma…
andriitserkovnyi Jan 8, 2024
3cf616c
bugs
andriitserkovnyi Jan 8, 2024
c5f57d1
Update click-collect-domains.md
andriitserkovnyi Jan 8, 2024
2cdcdc0
Merge branch 'master' into feature/cc-31362/dev-click-and-collect-dev…
andriitserkovnyi Jan 8, 2024
82519f7
Merge branch 'master' into feature/cc-31362/dev-click-and-collect-dev…
andriitserkovnyi Jan 8, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions _data/sidebars/pbc_all_sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.-->

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.-->

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.-->

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.-->

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ This endpoint lets you retrieve shipment types.
}
```

<details>
</details>

<details>
<summary>Storefront: Retrieve shipment types</summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}**
***


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}***
***


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}**
***


Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -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 |
Original file line number Diff line number Diff line change
@@ -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`.
Original file line number Diff line number Diff line change
@@ -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`.
Original file line number Diff line number Diff line change
@@ -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 |
Original file line number Diff line number Diff line change
@@ -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`.
Loading
Loading