Shipment feature overview

Last updated:
Edit on GitHub

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

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.

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.

To add service types using Glue API, see Backend API Marketplace B2C Demo Shop reference.

To import shipment types, see Import file details: shipment_type.csv.

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.

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.

Shipment method plugins

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.

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

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.

Current constraints

  • Product catalog can’t be filtered by a shipment type.
  • Customers can’t add products with preselected shipment types to cart. They can select shipment types only during checkout.
  • If a product is added to cart without a product offer attached to it, this product can be purchased only with the Delivery shipment type.
BACK OFFICE USER GUIDES THIRD-PARTY INTEGRATIONS
Add carrier companies Seven Senders
Add delivery methods Paazl
Edit delivery methods Paqato
INSTALLATION GUIDES UPGRADE GUIDES TUTORIALS AND HOWTOS DATA IMPORT GLUE API GUIDES REFERENCES
Install the Shipment feature Upgrade the Shipment module HowTo: Create discounts based on shipment Import file details: shipment_type.csv Retrieve shipments and shipment methods when submitting checkout data Shipment method plugins: reference information
Install the Shipment Glue API Upgrade the ShipmentGui module HowTo: Add a new shipment method 2.0 Import file details: shipment_type_store.csv Retrieve shipments in orders Shipment method entities in the database: reference information
Integrate the Shipment + Approval Process feature Upgrade the ShipmentCartConnector module Import file details: shipment_method_shipment_type.csv Retrieve shipments when checking out purchases
Integrate the Shipment + Cart feature Upgrade the ShipmentCheckoutConnector module Add shipment types
Upgrade the ShipmentDiscountConnector module Retrieve shipment types
Update shipment types