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

CnC docs #2292

Merged
merged 36 commits into from
Nov 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
3161768
Create service-points-feature-overview.md
andriitserkovnyi Nov 1, 2023
0c2a770
service points feature overview
andriitserkovnyi Nov 2, 2023
da440a6
Update shipment-feature-overview.md
andriitserkovnyi Nov 2, 2023
9501831
Merge branch 'master' into CnC
andriitserkovnyi Nov 14, 2023
ce7c7d0
Update shipment-feature-overview.md
andriitserkovnyi Nov 14, 2023
2430932
add-shipment-cart
andriitserkovnyi Nov 15, 2023
72ca705
add-feature-overviews
andriitserkovnyi Nov 16, 2023
78b6073
Create create-offers.md
andriitserkovnyi Nov 16, 2023
53ff622
rename
andriitserkovnyi Nov 16, 2023
e3d45d0
Merge branch 'master' into CnC
andriitserkovnyi Nov 17, 2023
0fcd935
reference-info
andriitserkovnyi Nov 17, 2023
a5a178d
create guides
andriitserkovnyi Nov 17, 2023
2605912
Update service-points-order-management-feature.md
andriitserkovnyi Nov 17, 2023
ac3a12c
add docs
andriitserkovnyi Nov 20, 2023
3ce0296
Merge branch 'master' into CnC
andriitserkovnyi Nov 20, 2023
65f440c
move-docs
andriitserkovnyi Nov 20, 2023
2b0abef
Create install-the-product-offer-service-points-availability-feature.md
andriitserkovnyi Nov 20, 2023
7ae98a0
Merge branch 'master' into CnC
andriitserkovnyi Nov 21, 2023
a28227d
add import files
andriitserkovnyi Nov 22, 2023
d51b87d
data-import-files
andriitserkovnyi Nov 22, 2023
7cc50bb
Merge branch 'master' into CnC
andriitserkovnyi Nov 22, 2023
a9d51d0
finalizing
andriitserkovnyi Nov 23, 2023
80d97fc
Merge branch 'master' into CnC
andriitserkovnyi Nov 23, 2023
37ea213
add overviws
andriitserkovnyi Nov 23, 2023
24b37df
move
andriitserkovnyi Nov 23, 2023
e9a78c7
Merge branch 'master' into CnC
andriitserkovnyi Nov 23, 2023
35d8454
fix build
andriitserkovnyi Nov 23, 2023
20c406b
ьщму
andriitserkovnyi Nov 23, 2023
5bbe68d
build
andriitserkovnyi Nov 23, 2023
81e9f3d
build
andriitserkovnyi Nov 23, 2023
af7b3f5
build
andriitserkovnyi Nov 23, 2023
0dd61d0
build
andriitserkovnyi Nov 23, 2023
7bc3a06
links
andriitserkovnyi Nov 23, 2023
6caaf51
links
andriitserkovnyi Nov 23, 2023
54c2156
Update pbc_all_sidebar.yml
andriitserkovnyi Nov 23, 2023
3b6ff22
links
andriitserkovnyi Nov 23, 2023
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
188 changes: 119 additions & 69 deletions _data/sidebars/pbc_all_sidebar.yml

Large diffs are not rendered by default.

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

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

Expand Down
Original file line number Diff line number Diff line change
@@ -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. |
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -32,4 +32,4 @@ This document describes the `shipment_method_shipment_type.csv` file to configur

```bash
data:import:shipment-method-shipment-type
```
```
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -31,4 +31,4 @@ This document describes the `shipment_type_store.csv` file to configure the [shi

```bash
data:import:shipment-type-store
```
```
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -29,4 +29,4 @@ This document describes the `shipment_type.csv` file to configure the [shipment

```bash
data:import:shipment-type
```
```
Original file line number Diff line number Diff line change
Expand Up @@ -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 %} <!-- To edit, see /_includes/pbc/all/install-features/202311.0/install-the-shipment-customer-account-management-feature.md -->
{% include pbc/all/install-features/202311.0/install-the-shipment-customer-account-management-feature.md %} <!-- To edit, see /_includes/pbc/all/install-features/202311.0/install-the-shipment-customer-account-management-feature.md -->
Original file line number Diff line number Diff line change
Expand Up @@ -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 %} <!-- To edit, see /_includes/pbc/all/install-features/202311.0/install-the-shipment-feature.md -->
{% include pbc/all/install-features/202311.0/install-the-shipment-feature.md %} <!-- To edit, see /_includes/pbc/all/install-features/202311.0/install-the-shipment-feature.md -->
Original file line number Diff line number Diff line change
@@ -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) |
Original file line number Diff line number Diff line change
@@ -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) |
Original file line number Diff line number Diff line change
@@ -1,68 +1,88 @@
---
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
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
- /docs/scos/user/features/202307.0/shipment-feature-overview.html
- /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, shipment types, and shipment methods. You can define shipment prices, expected shipment time, tax sets, and the availability of specific shipment 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 sales order can have multiple delivery methods from different carrier companies.
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).

## Shipment type

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.
* 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.

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).

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

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 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 shipment methods from different carrier companies.

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).

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.
* If a shipment 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).
### Shipment method plugins

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.
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).

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 method prices and discounts

## Install Carrier Management


1. Install the required modules:
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.

```bash
composer require spryker-feature/shipment:"{{page.version}}" --update-with-dependencies
```
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.

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 |
| INSTALLATION GUIDES | UPGRADE GUIDES | TUTORIALS AND HOWTOS | DATA IMPORT | 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) | | |
| [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) | [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) | | |
Loading
Loading