Install the shipping module
To begin using the shipping module with the checkout starter kit, ensure that you have completed the getting started and configuration steps.
For more ideas on how you can use the shipping module, refer to shipping use cases.
Prerequisites
- Adobe Commerce on cloud infrastructure or on-premises: 2.4.5+
- PHP 8.1+
- Magento Open Source is not supported.
Installation
Adobe Commerce as a Cloud Service is preconfigured with all the required modules for the checkout starter kit. Cloud Service users can proceed by configuring an App Builder project or configuring Commerce.
Before installing Commerce modules, ensure that you have the required credentials in auth.json
with access to the Adobe Commerce repository.
To enable out-of-process shipping methods in Adobe Commerce, install the magento/module-out-of-process-shipping-methods
module using the following command:
Copied to your clipboardcomposer require magento/module-out-of-process-shipping-methods --with-dependencies
Configuration
The starter kit provides the create-shipping-carriers
script to help configure Adobe Commerce. It reads the shipping carriers configuration from the shipping-carriers.yaml
file and creates the shipping carriers in Adobe Commerce.
To run this script, use the following command:
Copied to your clipboardnpm run create-shipping-carriers
To retrieve shipping carriers from Commerce, use the get-shipping-carriers
script:
Copied to your clipboardnpm run get-shipping-carriers