This is the official PostNL Magento 2 extension to connect your Magento 2 webshop with PostNL.
- Magento version 2.3.6 - 2.3.7-p4, 2.4.3 - 2.4.6-p2
- PHP 7.3+, PHP 8.1+ for 2.4.4+
- In order to use this extension you need to be a contract customer of PostNL. If you are not a customer of PostNL, you can register yourself here.
We strongly recommend that you use a Staging Environment for the installation, and to also make a backup of your environment.
To install the extension login to your environment using SSH. Then navigate to the Magento 2 root directory and run the following commands in the same order as described:
Enable maintenance mode:
php bin/magento maintenance:enable
- Install the extension:
composer require tig/postnl-magento2
- Enable the PostNL Magento 2 plugin
php bin/magento module:enable TIG_PostNL
- Update the Magento 2 environment:
php bin/magento setup:upgrade
When your Magento environment is running in production mode, you also need to run the following comands:
- Compile DI:
php bin/magento setup:di:compile
- Deploy static content:
php bin/magento setup:static-content:deploy
- Disable maintenance mode:
php bin/magento maintenance:disable
- Download the extension directly from github by clicking on Code and then Download ZIP.
- Create the directory app/code/TIG/PostNL (Case-sensitive)
- Extract the zip and upload the code into app/code/TIG/PostNL
- Enable the PostNL Magento 2 plugin
php bin/magento module:enable TIG_PostNL
- Update the Magento 2 environment:
php bin/magento setup:upgrade
To update the PostNL Extension run the following commands:
composer update tig/postnl-magento2
php bin/magento setup:upgrade
To remove the PostNL extension, simply make use of the uninstall command Magento provides: https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-uninstall-mods.html#instgde-cli-uninst-mod-uninst
PostNL uses uninstall scripts. Please make sure to add the --remove-data flag to your command. The uninstall script will ask if you would like to remove Order related PostNL data. Removing this data is optional. The recommended uninstall command is:
php bin/magento module:uninstall TIG_PostNL --backup-db --remove-data --clear-static-content`
Place this code in a working Magento 2 installation in the folder app/code/TIG/PostNL (Case-sensitive).
Install all the dependencies:
- composer install
- npm install
- npm install -g grunt-cli
- Setup the integration tests as advised by Magento.
- Paste the following xml within the
<testsuites>
tag of dev/tests/integration/phpunit.xml:
<testsuite name="TIG PostNL Integration Tests">
<directory>../../../app/code/TIG/PostNL/Test/Integration</directory>
<directory>../../../vendor/tig/postnl/Test/Integration</directory>
<exclude>../../../app/code/Magento</exclude>
</testsuite>
Run:
grunt test
This command will run the following tests:
- Unit tests.
- Integration tests.
- CodeSniffer (PSR-2, Object Calisthenics and the Magento 2 Extension Quality Program).
- Lint all PHP files.
- JS lint all JS files.
The build status can be viewed on Travis-ci.com
This extension is developed by Total Internet Group (TIG) commissioned by PostNL.
For questions related to your PostNL account and PostNL delivery options, please contact PostNL.
- Phone: +31 (0)88-2255651
- Website: www.postnl.com
For questions about installing and configuring the extension please consult the relevant documentation:
- Knowledge base: PostNL Magento 2 Knowledge base
- Phone: +31 (0)88-2255652
- Email: [email protected]