Page tree
Skip to end of metadata
Go to start of metadata

Introduction 

This manual describes the functionality of the GLS Magento 2 extension. The GLS Magento 2 extension is developed by TIG for GLS. The extension makes it possible for Merchants to ship via the GLS Worldwide Logistics Network in Magento.

For the installation of the extension in Magento 2 we use Composer as the package manager.

If you have any questions regarding the extension, please contact the TIG Servicedesk.

Test API Credentials

Use the following API Credentials when you want to test the GLS Magento 2 Extension to see if it fits your needs. (do not use in production environments)

Key

Value

Userapitest3@gls-netherlands.com
PasswordTestUser
Subscription key8c78181337114438be1c6bb95a755ccf


Production API Credentials 

API Credentials from the https://api-portal.gls.nl/products will not directly work in the extension. You need to register an account and GLS will need to activate them for your account.

Contact information GLS:

GLS

Support

Phone(+31) (0) 88 550 3053 during business hours
EmailE-mail: helpdesk@gls-netherlands.com
GLS Websitehttps://gls-group.eu/


1. Installation 

1.1. Back-up 

We strongly advise to install and update the extension on a staging environment first and make a back-up of your webshop prior to the installation.

1.2. Composer installation Login via SSH and execute the following commands via the command line:

  • composer require tig/gls-magento2

1.3. Extension activation and updates

Execute the following commands via the command line:

  • php bin/magento module:enable TIG_GLS
  • php bin/magento setup:upgrade

1.4. File access rights

Depending on the operating system, make sure the just added files have the correct access rights so that the web server can access and execute the files correctly.

The composer command can be executed by the logged in user on the server which is sometimes not the same as the user of the web server. The files created by composer can’t be read by the web server which can lead to unexpected behaviour.

Composer will install the files in:

  • vendor/tig/gls-magento2/

1.5. Remove static files

Depending on your webshop configuration, empty static files directories.

1.6. Flush cache and reindex

Flush your Magento cache using the following command:

  • php bin/magento cache:flush


Depending on your configuration, make sure the following directories are emptied:

  • var/cache
  • var/page_cache
  • generation
  • var/di (if this folder exists)


Execute the following command via the command line to force a re-index:

  • php bin/magento indexer:reindex


The installation is now completed. 

Update the extension

To be able to make use of the latest features and bugfixes you should update the extension frequently. To do this you have to execute the following commands and flush your Magento cache.

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


2 Configuration 

Login at the Magento backend and go to Stores → Configuration → Sales → GLS.

2.1 General configuration and account information 

Type
By default is the extension is in test mode in the Magento back-end. In production this can be set to live mode in the extension.
In order to continue, you need the GLS account details. Please contact GLS if you do not have these details.


Username, Password and Subscription key

Fill in these account details you received from GLS. When the credentials are correct there will be a green bar.


Label Format

Depending on the printer you are using you can setup the label format.

  • PDF A6
  • PDF A4; 2 per page*
  • PDF A4; 4 per page*

* PDF A4 has additional option to position the labels on the A4 paper by setting up the top and left position in mm.


2.2 Setup Store Address

Login at the Magento backend and go to Stores → Configuration → General → General → Store Information.


Make sure the address details are filled in correctly, where this is used as address for the return label. 

The street name should always be in the first street-field

The house number should always be in the second street-field.


2.3 Setup the GLS shipping method

Login at the Magento backend and go to Stores → Configuration → Sales → Shipping Methods → GLS.


PDF A6

  • PDF A4; 2 per page*
  • PDF A4; 4 per page*

* PDF A4 has additional option to position the labels on the A4 paper by setting up the top and left position in mm.


  • No labels