tig/postnl-magento2

TIG Magento 2 PostNL extension

Installs: 373 379

Dependents: 2

Suggesters: 0

Security: 0

Stars: 58

Watchers: 26

Forks: 61

Open Issues: 3

Type:magento2-module


README

PostNL Logo

PostNL Magento 2

Lastest Stable Version TIG PostNL tested 2.3.7 versions TIG PostNL tested 2.4.7 versions Total Extension downloads Build Status

This is the official PostNL Magento 2 extension to connect your Magento 2 webshop with PostNL.

Requirements

  • Magento version 2.3.6 - 2.3.7-p4, 2.4.3 - 2.4.7
  • 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.

Installation

We strongly recommend that you use a Staging Environment for the installation, and to also make a backup of your environment.

Installation using composer (recommended)

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
  1. Install the extension:
composer require tig/postnl-magento2
  1. Enable the PostNL Magento 2 plugin
php bin/magento module:enable TIG_PostNL
  1. 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:

  1. Compile DI:
php bin/magento setup:di:compile
  1. Deploy static content:
php bin/magento setup:static-content:deploy
  1. Disable maintenance mode:
php bin/magento maintenance:disable

Installation manually

  1. Download the extension directly from github by clicking on Code and then Download ZIP.
  2. Create the directory app/code/TIG/PostNL (Case-sensitive)
  3. Extract the zip and upload the code into app/code/TIG/PostNL
  4. Enable the PostNL Magento 2 plugin
php bin/magento module:enable TIG_PostNL
  1. Update the Magento 2 environment:
php bin/magento setup:upgrade

Update

To update the PostNL Extension run the following commands:

composer update tig/postnl-magento2
php bin/magento setup:upgrade

Uninstalling the PostNL extension

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`

Running tests (advanced)

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:

The build status can be viewed on Travis-ci.com

Support

This extension is developed by Total Internet Group (TIG) commissioned by PostNL.

Extension basic configuration and account information

For questions related to your PostNL account and PostNL delivery options, please contact PostNL.

Extension support and advanced configuration

For questions about installing and configuring the extension please consult the relevant documentation: