The Xentral shipping method GLS (API) shipping method offers you to integrate domestic and international shipping of your products with the shipping service provider GLS.
In order to ship your products with the shipping service provider GLS, you need special login data from GLS. You can then use those credentials to easily connect Xentral to the GLS interface. In addition, you can integrate the shipping method GLS (API) into your shipping process as follows:
-
Manual creation of shipping labels for individual delivery notes
-
Automatic creation of shipping labels within various logistics processes
-
Reliable shipping of different shipment sizes
-
Transparent feedback of tracking numbers to your online stores and other sales platforms
Tip
If your shipment volume exceeds 20 parcels per months, you can profit from the favorable conditions that come with being a GLS business customer.
Are you not working with GLS as a business customer yet, or would you like to get a comprehensive overview of the e-commerce solutions of this shipping service provider? Then, refer to GLS to learn more about a possible cooperation and the various services available.
The Xentral shipping method GLS (API) offers you the following features:
-
Selection of additional services for shipping with GLS
-
Saving additional sender addresses using the Xentral module GLS
-
Selection of delivery terms for different use cases
To use GLS (API) as a shipping method in Xentral, you first create a new shipping method. Then, you activate it with your existing contract data from GLS. It only takes a few minutes and a few steps to be able to ship your first products with GLS!
Important
To connect the GLS (API) shipping method, you must be granted to access to the GLS interface and have the access data to the respective credentials. This data is later entered in the settings of the shipping method.
You need the credentials API username, API password, CustomerID and ContactID in order to set up the shipping method GLS (API) in Xentral,
The first step consists of creating a new shipping method in Xentral and entering the credentials that you have received from your account manager at GLS.
-
Use the smart search to search for Shipping methods,
-
Click on + NEW in the upper right corner.
-
Click on GLS (API).
The settings of the shipping method are opened.
-
Enter your GLS credentials as described below.
-
Click on Save.
GLS Username |
Enter your API user name for accessing the GLS interface. Your GLS account manager will provide you with this information. |
GLS Password |
Enter your API password for accessing the GLS interface. Your GLS account manager will provide you with this information. |
GLS Customer ID |
Enter your GLS customer ID for accessing the GLS interface. Your GLS account manager will provide you with this information. |
GLS Contact ID |
Enter your GLS contact ID for accessing the GLS interface. Your GLS account manager will provide you with this information. |
After you have created the shipping method and entered your credentials as described above, you can continue with carrying out the settings for the shipping method GLS (API) in Xentral.
In case you have left the settings of the shipping method GLS (API) in the meantime, proceed as follows to access the settings:
-
Use the smart search to search for Shipping methods,
-
Click on the pencil icon on the right of the shipping method for which you want to carry out settings.
-
In the Expert settings section, activate the option Show additional settings.
-
Carry out the settings according to the information in the following table.
-
Click on Save.
Setting |
Explanation |
|
---|---|---|
Designation |
Here you can find the name of the shipping method, as it is displayed in Xentral, for example, during order processing. The designation is only visible to you and your employees. Make sure that each designation exists only once in Xentral so that the shipping method can always be uniquely identified. |
|
Type |
This is an internal field label that is required for mapping to your online stores and other sales platforms. Do not change this name if possible! If you do change this name, remember to change it exactly in the settings of your shop and other platforms. An exception is if you work without online stores or sales platforms. In this case, you can rename the type to your liking. |
|
Module |
Specify the appropriate Xentral module here. In this case, it is GLS API. It is also possible to assign a different module to the shipping method. Note, however, that all existing settings will be lost and the module name will update in editable receipts if you make a change here. |
|
Project |
Optionally, specify a project assignment. This is required if you want to limit the shipping method to a specific sales channel or project (for example, a specific branch office). If not, this field remains empty and therefore applies to all projects and user groups. |
|
Active |
Activate this option after you have carried all the necessary settings for the shipping method. NoteYou can deactivate shipping methods that are no longer in use later. Note, however, that deactivated shipping methods will only be displayed in documents that have already been created. In newly created documents and in user interfaces such as the order overview or in the customer data, a deactivated shipping method is no longer available for selection. You can also delete shipping methods. However, this will also delete the shipping history. Therefore, you should only delete incorrectly created shipping methods that you have not used productively. |
|
No postage check |
Use this option to disable the postage check in the order for the order traffic light. If the postage check remains active, a red traffic light icon is generated for orders as soon as at least one postage item is not included in the sales order. This usually prevents the postage item from being forgotten during manual order creation. Consider whether you want to activate or deactivate this option based on your own workflows and how you work with Xentral. If you typically create many orders manually in Xentral, it may be useful not to activate this option, so that the postage is always reliably included in the sales order, especially for high-priced products or international shipments. |
|
Printer shipping label |
Select the printer you want to use by default for the shipping labels from the drop-down menu. Note that only printers that you have already set up in Xentral can be selected here. Depending on how and where the shipping process is handled in your company, you can choose exactly the printer you need here - whether directly at your desk or at the packing table in the warehouse. |
|
Printer export |
From the drop-down menu, select the printer to use by default for customs forms (CN23). NoteNote that this setting is only relevant if you are shipping products to countries outside of the European Union. Refer to GLS for more information on the conditions for international shipping or contact your GLS account manager before carrying out the respective settings in Xentral. |
|
Shipping email to buyer |
Determine rules regarding the way shipping notifications should be sent to your customers by email as soon as the shipment is on its way. The following three options are available: Default behavior: The existing logistics settings from the project are used. You can carry out these settings in the Settings > Basic Settings > Projects > Open Project > Tab: Settings > Tab: Logistics / Shipping menu. In the Stage 1 (Picking/Order picking) and Stage 2 (Pack) sections, you can activate the check boxes named Email to inform your customers about the status of order processing. No shipping email: No shipping information will be sent by email for this shipping method. Custom text template: For this shipping method, the selected text template will be sent via email. You need to create this template in advance in the Settings > Basic Settings > Receipts > Text templates menu. Then select the desired template from the Text template drop-down menu. This selection will not use the project’s logistics settings for this shipping method. |
|
Text template |
This setting is only available if you have selected the Custom text template for the option Shipping mail to buyer. Select a specific text template to be sent for this shipping method. For example, this could be information tailored specifically to the shipping service provider or information for self pick-up, which may differ depending on the branch office. |
|
Deliveries supported |
When setting up the GLS (API) shipping method, this option is activated by default. Once you have carried out all the other necessary settings and set the shipping method to Active, you can select the shipping method in sales orders, delivery notes and in the dispatch center. This allows you to manually select the shipping method during all important steps of order processing in Xentral. |
|
Returns supported |
Enable this option to allow your customers to send returns for sales orders originally created using the GLS (API) shipping method. |
|
Preferred return shipping method |
Select a preferred shipping method for returns. If you create a return for a sales order in with the shipping method GLS (API) in Xentral, the shipping method selected here is automatically preselected in the return order. This setting applies to cases where you manually create returns in Xentral and also generate the return shipping yourself and send it to your customers. |
|
Service |
Select the shipping service that you have booked as part of your contract with GLS. For more information about the available services and their respective product identifiers, see the chapter Adding GLS shipping services in Xentral below. ImportantIn any case, discuss the available shipping services and all relevant details first with your GLS account manager before selecting an option here and using the shipping method productively. |
|
Frankatur |
Select the desired delivery terms for your GLS shipments from the drop-down menu. Refer to the guideline provided by GLS to learn more about delivery terms in general. ImportantIn any case, discuss the available delivery terms and their use cases first with your GLS account manager before selecting an option here and using the shipping method productively. |
|
Referenz für Nachnahme |
If you have booked the CashService service with GLS, you should enter a reference here which will later be included on the parcel label as additional information. You can also enter a free text. The following variables are available: {ORDER_ID}, {INVOICE_ID}, {DELIVERY_NOTE_ID}, {INTERNET}. Afterwards, the reference will be displayed in the row Ref. No on the shipping label: |
|
Minimum weight |
Enter the required minimum weight for GLS shipments here. Any value greater than 0 is allowed. This setting is optional. If in doubt, check with your GLS account manager to see what information is expected here. WarningThis field is mandatory. If the field is empty, an error message appears when creating the shipping label. In addition, none of the delivery note positions may have the quantity 0, as this also leads to errors in the shipping registration to GLS. If your shipping document contains items with the quantity 0, edit the delivery note first and outsource non-deliverable items to a partial shipping document if necessary. |
|
Adjust weight in |
To create the shipping label, an accurate calculation of the total weight of the shipment including packaging material is required. Xentral, automatically calculates the shipment weight in the background by adding up the total weight of the items included in the sales order. The present option adds a weight specified by you. This creates a total value for the shipping declaration, which is taken into account when creating the shipping label and is automatically reported to GLS. Decide whether the additional weight of the packaging material should be expressed in kg or %. Use the following setting called Adjust weight to define the extra weight more precisely. |
|
Adjust weight to |
This setting allows you to specify your details for the Adjust weight in setting. Enter the additional weight of the shipment in kilograms or percentages here, depending on the previous selection. Which calculation method and which specific values you choose depends on the packaging type of your products and the packaging materials you use. |
|
Apply tracking |
Activate this option to save the tracking number in Xentral directly to the corresponding sales order after the shipping label has been created. This means that the tracking number is permanently saved in your system and you do not have to rescan the shipping label after creation to record this data in Xentral. |
With GLS, you have the possibility to book further shipping services to your contract. These shipping services include different types of express shipping, which are explained in more detail directly at GLS.
Important
If you use multiple GLS shipping services at the same time, you need to create different shipping methods in Xentral. A separate shipping method is required for each shipping service.
Proceed as described below to add alternative shipping services for GLS in Xentral.
-
Use the smart search to search for Shipping methods,
-
Click on the pencil icon on the right of the shipping method you want to add a shipping service for.
-
In the Expert settings section, activate the option Show additional settings.
-
Select the desired shipping service from the drop-down menu Service. The table below contains additional information on the available services.
-
Click on Save.
Naming of the option in Xentral |
Further service information |
---|---|
Normal |
This option represents standard shipping without any additional GLS services. |
Flex Delivery Service |
This option represents the FlexDeliveryService service offered by GLS. With this service, different options for parcel receipt are offered to the recipient, such as delivery on a desired day, a new address or via a GLS parcel shop. More information on this service is available directly with GLS. |
Deposit Service |
This option represents the DepositService service offered by GLS. The parcel will be delivered to a place specified by the recipient, so that the delivery is always successful at the first attempt. More information on this service is available directly with GLS. |
Express / Garantie 24 |
This option represents the Guaranteed24Service service offered by GLS. In this case, deliveries take place over night so that parcels always reach the recipient within a 24-hour period. More information on this service is available directly with GLS. |
Nachnahme |
This option represents the CashService service offered by GLS. If a delivery is made using cash on delivery, the recipient makes payment by handing over the full invoice amount in cash to the delivery agent. Afterwards, GLS forwards the payment to you via bank transfer. More information on this service is available directly with GLS. |
Xentral allows you to add additional sender addresses for the shipping method GLS (API). If you ship your products from different branches or locations, you can select the desired sender address when creating the shipping label in Xentral so that the address is printed correctly on the label.
First, proceed as follows to save one or more additional sender addresses in Xentral.
-
Use the Smart Search to search for GLS,
-
Click on +NEW in the upper right corner.
-
Enter the desired address data for the additional sender address.
-
In the Template field, enter a name for this address so that it will be easier to select and identify this address later. For example, you can use keywords such as “Branch 2” or similar if you are shipping products from different branches of your business.
-
Optionally, enter a Note. This note is not visible to your customers, but serves internal information purposes for you and your employees. The note will only be visible later when accessing the saved addresses in the GLS module.
-
Activate the option Active so that the address is available for selection when creating shipping labels.
-
Click on Save.
In the Warehouse > Delivery note menu, you can select the shipping method GLS in the Details tab. There, you can also find a drop-down menu from which you can select one of the shipping methods you have saved. The selected address is then indicated as the sender address on the shipping label.
Once you have carried out all the settings as described above, you can test the parcel label printing in the dispatch center or in an individual delivery note. To do this, proceed as follows.
-
Click on the pencil icon on the right to open a delivery note in the Stock > Delivery note menu.
-
Open the Details tab.
-
Scroll down until you reach the Delivery note section.
-
Select the GLS (API) shipping method from the Shipping method drop-down menu.
-
Click on Save. You will then be redirected to the Parcel label tab of the delivery note. If necessary, adjust the address details and click on Print parcel label.
-
Download the shipping label. Then you can open it and check for any errors.
Important
If you have created shipping labels with incorrect information or for testing purposes, you must cancel them in the GLS Business Customer Portal (YourGLS). Cancelling shipping labels directly from Xentral is not possible.
Once you have carried out all the settings as described above, you can test the parcel label printing in the dispatch center or in an individual delivery note. To do so, select the shipping method GLS from the drop-down menu in the Delivery note tab of the delivery note.
Click on Save before navigating to the parcel label dialog.
Then open the Parcel label tab in the delivery note. Click on Print shipping label.
After your test print is complete, you can cancel the parcel label in the GLS Business Customer Portal.
In this chapter, we have listed the error messages that can occur when using the GLS (API) shipping method in Xentral.
Error message |
Explanation and solution |
---|---|
The user is allowed to access the API, but lacks necessary rights (account registration incomplete) |
This error message is passed directly from GLS to Xentral. This specific error occurs if the API account that has been entered when setting up the shipping method in Xentral has insufficient permissions. As a consequence, it is not possible to create a shipping label. Contact your GLS account manager to check and adjust the permissions. |
Quantity must be greater than zero. |
This error message occurs during creation of a shipping label in case the delivery note contains positions with the quantity 0. Remove the respective positions from the delivery note by outsourcing the positions that cannot be delivered right now to a partial delivery or to a partial order. Then, you can create the shipping label as desired. |
Internal system error. Please try again later. |
Error messages of this kind may occur during shipping label creation. They usually mean that there is an outage with GLS which makes communication with the shipping service provider interface impossible. In this case, contact your GLS account manager to learn more about the current status and the possible duration of the outage. |
Message with the component Argument #8 ($MinimalWeight) must be of type string, null given |
Error messages of this kind occur during shipping label creation if you have not entered a value in the Minimum weight field in the settings of the shipping method GLS. Additional information on the settings are available in the table ???. Enter a value in the Minimum weight field to be able to create the shipping label. Also, contact your GLS account manager to clarify which value is expected here. |
An error occurred when validating input: The provided shipper is not allowed to create shipments. |
This error message can be triggered by several different reasons. For example, it might be the case that not all required permissions and approvals have been granted for your GLS business customer account yet, so that you are not allowed to create shipping labels using external tools such as Xentral. Contact your GLS account manager to check and adjust the required permissions. |