Initial Setup
This guide walks you through the step-by-step setup of the GLS Connector in Business Central.
Prerequisites
Before you begin, you will need:
- [ ] GLS business customer contract with API access (ShipIT)
- [ ] Username and password for the GLS ShipIT API
- [ ] Contact ID (assigned during GLS registration)
- [ ] Shipper address for the shipping labels
GLS ShipIT API Access
You can obtain API access through your GLS account manager. The credentials consist of a username and a password for HTTP Basic Authentication β no API key or OAuth.
Step 1: Open the Setup Page
There are two ways:
Option A β Via Search:
- Press ++alt+q++ or click the magnifying glass in the menu bar
- Search for "GLS Shipment Setup"
- Open the setup page
Option B β Via the Dashboard:
- Open the merchantCENTRAL Dashboard
- Navigate to Shipping Carriers β GLS
Step 2: Enter API Credentials
API Base URL
The URL is set automatically:
| Mode | URL |
|---|---|
| Sandbox | https://shipit-wbm-sandbox01.gls-group.eu:443/backend/rs |
| Production | Provided by GLS after activation |
Start with Sandbox
Enable Sandbox Mode first to safely test the setup. The sandbox URL is automatically filled in.
Enter Credentials
| Field | Input | Example |
|---|---|---|
| Sandbox Mode | β enable (for testing) | β |
| Basic Auth User | GLS API username | 2761234567_API |
| Basic Auth Password | GLS API password | ******** |
Secure Storage
Username and password are stored encrypted in IsolatedStorage β not as plain text in the database. After entry, you will only see ***.
Step 3: Enter Contact ID
| Field | Input | Example |
|---|---|---|
| Contact ID | Your GLS Shipper ID | 2761234567 |
The Contact ID is your GLS customer number and is assigned during registration. It identifies you as the shipper to GLS.
Step 4: Test the Connection
- Click the Test Connection action (in the menu bar at the top)
- The connector sends a test request to the GLS AllowedServices endpoint
- On success, a success message appears
- On failure, an error message with details is shown
No Health Endpoint
GLS does not provide a dedicated health-check endpoint. The connection test uses the AllowedServices endpoint as a proxy instead. If it responds, the connection is active.
Step 5: Configure Shipper Address
Fill in the shipper address completely. This will be printed as the sender on every label.
| Field | Required | Example |
|---|---|---|
| Shipper Name 1 | β | ALTENBRAND Datentechnik GmbH |
| Shipper Name 2 | Optional | Shipping Dept. |
| Shipper Name 3 | Optional | |
| Shipper Street | β | IndustriestraΓe |
| Shipper Street No. | β | 5 |
| Shipper ZIP Code | β | 91126 |
| Shipper City | β | Schwabach |
| Shipper Country Code | β | DE |
| Shipper Contact Person | Recommended | Max Mustermann |
| Shipper Email | Recommended | versand@example.com |
| Shipper Phone | Recommended | +49 9122 123456 |
ISO-2 Country Codes
GLS uses ISO alpha-2 country codes (e.g., DE, AT, FR). This is the standard in Business Central β no conversion is needed. However, note that DHL uses ISO alpha-3 (e.g., DEU).
Step 6: Set Default Settings
Product
Choose the default product that will be preselected when creating new labels:
| Product | Description | Max. Weight |
|---|---|---|
| GLS Parcel | BusinessParcel β the standard for parcels | 31.5 kg |
| GLS Express | ExpressParcel β fast delivery | 31.5 kg |
| GLS Freight | General cargo β heavy/bulky goods | Variable |
Recommendation
For most use cases, GLS Parcel is the right choice.
Weight
| Field | Description | Example |
|---|---|---|
| Default Weight (kg) | Default weight in kilograms | 1.000 |
The default weight is used when no weight is specified during label creation. GLS expects the weight as a decimal number in kilograms (e.g., 0.500 for 500 g).
Maximum Weight
The maximum is 31.5 kg per parcel. Heavier shipments must be sent as GLS Freight (general cargo).
Label Format
| Format | Description | When to use? |
|---|---|---|
| PDF file | Standard for PC printers | |
| PNG | Image file | Alternative to PDF |
| Zebra (ZPL) | Zebra Programming Language | For Zebra thermal printers |
Template Set (ZPL only)
| Template | Description |
|---|---|
| None | Standard (PDF/PNG) β no template needed |
| ZPL 200 dpi | Zebra template for 200 dpi printers |
| ZPL 300 dpi | Zebra template for 300 dpi printers |
Template Set for Zebra only
The Template Set is only relevant when you have selected the label format Zebra (ZPL). For PDF and PNG, this field is ignored.
Incoterm Code
Set the default Incoterm for international shipments:
| Code | Meaning |
|---|---|
10 |
DDP β Delivered Duty Paid (seller pays customs) |
20 |
DAP β Delivered at Place (buyer pays customs) |
30 |
EXW β Ex Works (buyer bears all costs) |
Step 7: Customs Settings (optional)
If you ship internationally, configure the default export type:
| Export Type | Code | Description |
|---|---|---|
| Permanent/Sale | P |
Regular sale of goods (default) |
| Temporary | T |
Temporary export |
| Return | R |
Return shipment |
Step 8: Tracking URL (optional)
The tracking URL template is automatically filled in:
https://gls-group.eu/DE/de/paketverfolgung?match=%1
The %1 is automatically replaced with the Track ID of the respective shipment. You can customize the URL if GLS provides a different tracking page.
Setup Complete
Your setup page should now look like this:
βββββββββββββββββββββββββββββββββββββββββββ
β GLS Shipment Setup β
β β
β API Credentials: β
β API Base URL: https://shipit... β
β Sandbox Mode: β
β
β Basic Auth User: *** β
β Basic Auth Pwd: *** β
β β
β Account: β
β Contact ID: 2761234567 β
β β
β Shipper Address: β
β Name 1: ALTENBRAND D... β
β Street: IndustriestraΓe β
β Street No.: 5 β
β ZIP Code: 91126 β
β City: Schwabach β
β Country Code: DE β
β β
β Default Settings: β
β Product: GLS Parcel β
β Weight (kg): 1.000 β
β Label Format: PDF β
β Template Set: None β
β Incoterm Code: 10 β
β β
β Status: β
β Labels Today: 0 β
β Last Error: (empty) β
β β
β [Test Connection] β
βββββββββββββββββββββββββββββββββββββββββββ
Checklist
- [x] API credentials entered (Username + Password)
- [x] Contact ID entered
- [x] Connection test successful
- [x] Shipper address complete
- [x] Default product selected (GLS Parcel)
- [x] Default weight set
- [x] Label format selected (PDF/PNG/ZPL)
- [x] Incoterm Code set (for international shipments)
- [ ] Ready for the first label! β Create Label