-
Notifications
You must be signed in to change notification settings - Fork 4
Technical Documentation
GitLabCI edited this page Jul 4, 2024
·
4 revisions
The extension DHL Global Web Services (DHLGW) is a plugin to integrate DHL logistics APIs into the Magento 2 platform's order processing workflow. The core features of the extension are:
- Display shipping rates in checkout
- Offer value-added shipping services in checkout
- Retrieve shipping documentation (primarily the shipping label) manually via admin panel
- Automate shipping documentation retrieval
- Display parcel tracking information in customer account and admin panel
The extension is designed to connect to the web services of multiple DHL divisions (e.g. DHL Paket, DHL Express, DHL eCommerce). In order to support multi-carrier capabilities, the extension is composed of several packages:
- API SDKs (PHP libraries): encapsulate access to the DHL web services
- Carriers (Magento modules): consume the Magento platform's shipping-related interfaces, apply DHL business logic, pass service requests to API SDKs
- Shipping Core (Magento module): provide general, carrier-agnostic functionality, shared to and consumed by the carrier modules
- UI (Magento module): display the shipping core's features in the Magento frontend and admin panel
A technical overview can be found in the DHL Shipping Core Wiki.
The latest stable version is published on Magento Marketplace and Packagist.
For the latest development version, perform the following steps to install all required packages:
- Allow installation of development packages
- Add repositories to the root
composer.json
- Require the metapackage
{
"minimum-stability": "dev",
"prefer-stable": true,
"repositories": [
{
"type": "composer",
"url": "https://repo.magento.com/"
},
{
"type": "vcs",
"url": "[email protected]/netresearch:dhl-global-web-services/global-web-services.git"
},
{
"type": "vcs",
"url": "[email protected]/netresearch:dhl-global-web-services/sdk-api-bcs.git"
},
{
"type": "vcs",
"url": "[email protected]/netresearch:dhl-global-web-services/sdk-api-bcs-returns.git"
},
{
"type": "vcs",
"url": "[email protected]/netresearch:dhl-global-web-services/sdk-api-unified-location-finder.git"
},
{
"type": "vcs",
"url": "[email protected]/netresearch:dhl-global-web-services/sdk-api-parcel-management.git"
},
{
"type": "vcs",
"url": "[email protected]/netresearch:dhl-global-web-services/sdk-api-unified-tracking.git"
},
{
"type": "vcs",
"url": "[email protected]/netresearch:dhl-global-web-services/module-shipping-core.git"
},
{
"type": "vcs",
"url": "[email protected]/netresearch:dhl-global-web-services/module-ui.git"
},
{
"type": "vcs",
"url": "[email protected]/netresearch:dhl-global-web-services/module-carrier-paket.git"
},
{
"type": "vcs",
"url": "[email protected]/netresearch:dhl-global-web-services/module-carrier-paket-returns.git"
},
{
"type": "vcs",
"url": "[email protected]/netresearch:dhl-global-web-services/module-unified-tracking.git"
}
]
}
composer require dhl/shipping-m2:^1.1.0