LokiCheckout_Bpost
This Magento 2 module is an add-on package to the LokiCheckout.
It integrates the Belgian bpost shipping services directly with the bpost APIs, without any third party bpost extension:
- Home delivery (bpack 24h Pro) for Belgian addresses
- Pickup point (bpack@bpost): the shopper picks a post office or post point on a map
- Parcel locker (bpack 24/7): the shopper picks a parcel locker on a map
- International delivery (bpack World Business, bpack World Express Pro or bpack Europe Business) outside of Belgium
Configuration
Go to Stores > Configuration > Sales > Delivery Methods > bpost (Loki Checkout):
- Account ID and Passphrase: the credentials of your bpost Shipping Manager account. The passphrase is found in the Shipping Manager under Admin > Shipping Manager settings.
- Pickup Point Locator Partner ID: the partner ID used for the bpost pickup point locator. When left empty, the Account ID is used. Without either, the pickup point and parcel locker methods are hidden.
- Use Prices from bpost Shipping Manager: when enabled, the prices of the products in your Shipping Manager account are used (per destination country and weight), and methods that are not active in your account are hidden. The fixed prices per method are used as a fallback, for instance when the bpost API is unreachable.
- Send Orders to bpost Shipping Manager: when enabled, every placed bpost order is created in the Shipping Manager (including the selected pickup point), so that you can print the label there. The sender address is taken from Stores > Configuration > General > Store Information. Failures never block the checkout; they are logged and added as an order comment.
The bpost APIs work with weights in grams up to 30 kg. Carts without weight use the configured default weight.
How it works
- Rates:
GET https://shm-rest.bpost.cloud/services/shm/{accountId}/productconfig(cached for an hour) - Pickup points:
https://pudo.bpost.be/Locator(Function=search, cached for 15 minutes), searched around the billing address of the shopper - Orders:
POST https://shm-rest.bpost.cloud/services/shm/{accountId}/orders
The selected pickup point is stored in the table loki_quote_address_extended (module Loki_QuoteAddressExtended), in the columns bpost_pickup_point_*. Once the order is placed, the order shipping address is replaced with the address of the pickup point, while the name of the shopper is kept. The Shipping Manager reference is stored in the column bpost_order_reference. Both are shown in the admin order view.
Installation
Install this package via composer:
composer require loki-checkout/magento2-bpost
Next, enable this module:
bin/magento module:enable LokiCheckout_Bpost
Current status
@dev
to the composer command.
Support
For getting support, create an Issue under the following project URL:
https://gitlab.yireo.com/loki-checkout/LokiCheckout_Bpost.git
Loki Components
The following LokiComponents are created or references in this module:
loki-checkout.shipping.methods.lokibpost_pickup.form
loki-checkout.shipping.methods.lokibpost_pickup.form.map
loki-checkout.shipping.methods.lokibpost_locker.form
loki-checkout.shipping.methods.lokibpost_locker.form.map
Module Dependencies
The following dependencies are declared in the module its `etc/module.xml` file:
LokiCheckout_Core
LokiCheckout_ShippingMaps
Loki_Base
Loki_Components
Loki_CssUtils
Loki_FieldComponents
Loki_MapComponents
Loki_QuoteAddressExtended
Magento_Backend
Magento_Catalog
Magento_Checkout
Magento_CheckoutAgreements
Magento_Config
Magento_Customer
Magento_Directory
Magento_Eav
Magento_Newsletter
Magento_Payment
Magento_Quote
Magento_Sales
Magento_Shipping
Magento_Store
Magento_Tax
Magento_Theme
Magento_Vault
Yireo_CspUtilities
Composer details
LokiCheckout_Bpostloki-checkout/magento2-bpost
ext-dom: *
ext-json: *
ext-pcre: *
ext-simplexml: *
guzzlehttp/guzzle: ^6.0 | ^7.0
loki-checkout/magento2-core: ^2.5
loki-checkout/magento2-quote-address-extended: ~0.0
loki-checkout/magento2-shipping-maps: ^1.0
loki/magento2-components: ^2.6
loki/magento2-css-utils: ^1.0
loki/magento2-map-components: ^1.0
magento/framework: ^103.0
magento/module-quote: ^101.0
magento/module-sales: ^103.0
magento/module-shipping: ^100.0
magento/module-store: ^101.0
php: >=8.2 <8.6
Releases
Changelog
Added
- bpost carrier
lokibpostwith home delivery (bpack 24h Pro), pickup point (bpack@bpost), parcel locker (bpack 24/7) and international delivery (bpack World/Europe) - Prices from the bpost Shipping Manager product configuration, with fixed prices as fallback
- Pickup point and parcel locker selection on a map via the bpost pickup point locator
- Selected pickup point stored via
Loki_QuoteAddressExtendedand shown in the checkout sidebar and admin order view - Placed orders are sent to the bpost Shipping Manager
- Translations for Dutch and French