tig/postcode-magento2 1.5.5

TIG Magento 2 Postcode extension

Postcode Service Magento 2 extension

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

Install the extension:

composer require tig/postcode-magento2

Enable the Postcode Service Magento 2 extension

php bin/magento module:enable TIG_Postcode

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 commands:

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

How to update the extension

To update the Postcode Service Extension run the following commands:

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

Alternatively, install the extension manually

• Download the extension directly from github by clicking on Code and then Download ZIP.
• Create the directory app/code/TIG/Postcode (Case-sensitive)
• Extract the zip and upload the code into app/code/TIG/Postcode
• Enable the Postcode Service Magento 2 extension

php bin/magento module:enable TIG_Postcode

• Update the Magento 2 environment

php bin/magento setup:upgrade

Configuration

After completing the installation process, the extension should be readily available in the backend of your Magento webshop. From there, you can configure the extension according to your requirements:

1. Go to Stores -> Configuration -> Sales -> Postcode Service International

2. Open the Configuration tab

3. Change the Modus from "Off" to "Test" or "Live"

4. Insert your Client ID and Api key (Secure Code). When you selected “Test” at the Modus, you can find test credentials below the fields - keep in mind there is a daily limit -.\ To sign up for a paid account and get your Client ID and Api key, simply visit https://postcodeservice.com and subscribe.

5. In the 'Countries' section, select the country for which you wish to enable the Postcode Service.

6. Flush your cache

Visual representation of the Postcode Service Magento extension during the checkout process

For Dutch postcodes

For Belgium postcodes

Further documentation

You can find the underlying Postcode Service API documentation here: https://developers.postcodeservice.com

Frequently Asked Questions

Q: What are the costs for using the Postcode Service?\ A: The Adobe Magento extension can be used free of charge. The fee for using the Postcode Service can be found at our website https://postcodeservice.com
\ Q: Which third party extensions are supported and compatible?\ A: At this time, we do not support third-party checkout extensions, including OneStepCheckout.com, Amasty, and MagePlaza. While we understand the importance of these third party extensions for some webshops, we cannot guarantee their compatibility with our extension and therefore cannot provide support for any issues that may arise as a result of their use. We have received reports from some users about compatibility issues with OneStepCheckout and MagePlaza, but this experience may vary from agency to agency, depending on the custom implementations. However, we are constantly working to improve our extension's functionality and compatibility, and we may revisit this decision in the future.

Requirements

Adobe Magento Open Source (Community edition) or Adobe Commerce (Enterprise version).

Version support

We follow the release support lines dates from Adobe https://experienceleague.adobe.com/docs/commerce-operations/release/versions.html for the version support of this extension.

Release history

See https://github.com/postcodeservice/postcode-magento2/releases