Shipment feature overview

Edit on GitHub

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.

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.

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.

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 using Composer:
composer require spryker-feature/shipment:"202307.0" --update-with-dependencies
  1. Follow the integration guides in Related Developer documents.
Add carrier companies Seven Senders
Add delivery methods Paazl
Edit delivery methods Paqato
Integrate the Shipment feature Upgrade the Shipment module HowTo: Create discounts based on shipment Shipment method plugins: reference information
Install the Shipment Glue API Upgrade the ShipmentGui module HowTo: Add a new shipment method 2.0 Shipment method entities in the database: reference information
Integrate the Shipment + Approval Process feature Upgrade the ShipmentCartConnector module
Integrate the Shipment + Cart feature Upgrade the ShipmentCheckoutConnector module
Upgrade the ShipmentDiscountConnector module