Skip to content

Commit a2950fb

Browse files
committed
Fix doc links
1 parent 05d30cc commit a2950fb

7 files changed

Lines changed: 25 additions & 25 deletions

File tree

docs/Actions/GLS/configs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,4 +107,4 @@ The value must be a valid `GLS_SHIPPER` object:
107107
}
108108
```
109109

110-
See [Types — GLS_SHIPPER](../types/#GLS_SHIPPER) for the full field reference.
110+
See [Types — GLS_SHIPPER](../GLS/types.md/#GLS_SHIPPER) for the full field reference.

docs/Actions/GLS/functions.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ createAddress(
5656
| `MobilePhonenumber` | string (min 4, max 35) | No | Mobile phone number |
5757
| `eMail` | string (max 80) | No | Email address |
5858

59-
**Returns:** [`GLS_ADDRESS`](../types#GLS_ADDRESS)
59+
**Returns:** [`GLS_ADDRESS`](../GLS/types.md#GLS_ADDRESS)
6060

6161
---
6262

@@ -83,7 +83,7 @@ createConsignee(
8383
| `Address` | GLS_ADDRESS | **Yes** | The delivery address for this consignee |
8484
| `Category` | `"BUSINESS"` \| `"PRIVATE"` | **Yes** | Whether the consignee is a business or private recipient |
8585

86-
**Returns:** [`GLS_CONSIGNEE`](../types#GLS_CONSIGNEE)
86+
**Returns:** [`GLS_CONSIGNEE`](../GLS/types.md#GLS_CONSIGNEE)
8787

8888
---
8989

@@ -114,7 +114,7 @@ createShipmentUnit(
114114
| `note2` | string (max 50) | No | Additional note printed on the label (line 2) |
115115
| `shipmentUnitService` | GLS_UNIT_SERVICE | No | Unit-level services (Cash, AddonLiability, HazardousGoods, etc.) |
116116

117-
**Returns:** [`GLS_SHIPMENT_UNIT`](../types#GLS_SHIPMENT_UNIT)
117+
**Returns:** [`GLS_SHIPMENT_UNIT`](../GLS/types.md#GLS_SHIPMENT_UNIT)
118118

119119
---
120120

@@ -140,7 +140,7 @@ createPrintingOptions(returnLabels: RETURN_LABELS): GLS_PRINTING_OPTIONS
140140
| `TemplateSet` | `NONE`, `D_200`, `PF_4_I`, `ZPL_200`, `ZPL_300`, ... | Label template set |
141141
| `LabelFormat` | `PDF`, `ZEBRA`, `INTERMEC`, `DATAMAX`, `TOSHIBA`, `PNG` | Output format |
142142

143-
**Returns:** [`GLS_PRINTING_OPTIONS`](../types#GLS_PRINTING_OPTIONS)
143+
**Returns:** [`GLS_PRINTING_OPTIONS`](../GLS/types.md#GLS_PRINTING_OPTIONS)
144144

145145
---
146146

@@ -169,7 +169,7 @@ createCustomContent(
169169
| `barcodeType` | `"EAN_128"` \| `"CODE_39"` | No | Barcode symbology |
170170
| `barcode` | string | No | Custom barcode value |
171171

172-
**Returns:** [`GLS_CUSTOM_CONTENT`](../types#GLS_CUSTOM_CONTENT)
172+
**Returns:** [`GLS_CUSTOM_CONTENT`](../GLS/types.md#GLS_CUSTOM_CONTENT)
173173

174174
---
175175

@@ -536,7 +536,7 @@ validateShipment
536536
└── validationResult.Issues[]
537537
```
538538

539-
See [Types — GLS_VALIDATE_SHIPMENT_REQUEST_DATA](../types#GLS_VALIDATE_SHIPMENT_REQUEST_DATA) for the input format.
539+
See [Types — GLS_VALIDATE_SHIPMENT_REQUEST_DATA](../GLS/types.md#GLS_VALIDATE_SHIPMENT_REQUEST_DATA) for the input format.
540540

541541
---
542542

docs/Actions/GLS/overview.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -87,10 +87,10 @@ GLS_CREATE_PARCELS_RESPONSE ← tracking IDs, barcode data, print data, routing
8787

8888
## Next steps
8989

90-
- [Quick Start](../quick-start) — Create your first shipment in a few steps
91-
- [Configuration](../configs) — Full list of configuration options and how to get credentials
92-
- [Functions](../functions) — All available functions with parameter details
93-
- [Types](../types) — All data types used in the GLS Action
94-
- [Events](../events) — Events emitted by the GLS Action
95-
- [Common Use Cases](../use-cases) — Example flows for real-world scenarios
96-
- [Troubleshooting](../troubleshooting) — FAQ and community support
90+
- [Quick Start](../GLS/quick-start.md) — Create your first shipment in a few steps
91+
- [Configuration](../GLS/configs.md) — Full list of configuration options and how to get credentials
92+
- [Functions](../GLS/functions.md) — All available functions with parameter details
93+
- [Types](../GLS/types.md) — All data types used in the GLS Action
94+
- [Events](../GLS/events.md) — Events emitted by the GLS Action
95+
- [Common Use Cases](../GLS/use-cases.md) — Example flows for real-world scenarios
96+
- [Troubleshooting](../GLS/troubleshooting.md) — FAQ and community support

docs/Actions/GLS/quick-start.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This guide walks you through creating your first GLS shipment using the GLS Acti
1111

1212
## Step 1: Install and configure the action
1313

14-
Follow the [Installation Guide](../../Guides/installation) to deploy the GLS Action, then set the following configuration values in your Hercules admin panel (or `.env` file):
14+
Follow the [Installation Guide](../../Guides/installation.md) to deploy the GLS Action, then set the following configuration values in your Hercules admin panel (or `.env` file):
1515

1616
| Config | Value |
1717
|--------|-------|
@@ -20,7 +20,7 @@ Follow the [Installation Guide](../../Guides/installation) to deploy the GLS Act
2020
| `ship_it_api_url` | GLS ShipIT endpoint (default: `https://api.gls-group.net/shipit-farm/v1/backend/rs`) |
2121
| `auth_url` | GLS auth endpoint (default: `https://api.gls-group.net/oauth2/v2/token`) |
2222

23-
See [Configuration](./configs) for the full list of options and how to obtain credentials.
23+
See [Configuration](./configs.md) for the full list of options and how to obtain credentials.
2424

2525
---
2626

@@ -128,7 +128,7 @@ The `GLS_CREATE_PARCELS_RESPONSE` contains everything you need:
128128

129129
## Common next steps
130130

131-
- [Validate before creating](./functions#validateShipment) — Call `validateShipment` first to catch errors before committing
132-
- [Cancel a shipment](./functions#cancelShipment) — Use `cancelShipment` with the `TrackID` if something changes
133-
- [Reprint a label](./functions#reprintParcel) — Use `reprintParcel` if a label is lost or damaged
134-
- [Common Use Cases](./use-cases) — End-to-end examples for real-world scenarios
131+
- [Validate before creating](./functions.md#validateShipment) — Call `validateShipment` first to catch errors before committing
132+
- [Cancel a shipment](./functions.md#cancelShipment) — Use `cancelShipment` with the `TrackID` if something changes
133+
- [Reprint a label](./functions.md#reprintParcel) — Use `reprintParcel` if a label is lost or damaged
134+
- [Common Use Cases](./use-cases.md) — End-to-end examples for real-world scenarios

docs/Actions/GLS/troubleshooting.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ A: The action supports all major GLS shipment types and services, including:
3030
- Tyre service, addressee-only delivery
3131
- Saturday and next-working-day delivery (EXPRESS only)
3232

33-
See [Functions](../functions.md) for the complete list.
33+
See [Functions](../GLS/functions.md) for the complete list.
3434

3535
---
3636

@@ -73,7 +73,7 @@ A: Saturday delivery (and next-working-day delivery) requires the shipment's `Pr
7373

7474
**Q: I get `ERROR_CREATING_GLS_SHIPMENT` — how do I find out what went wrong?**
7575

76-
A: Use `validateShipment` first to check your shipment data before creating it. The validation response includes specific `Issues` with `Rule` and `Location` fields pointing to the problematic field. See [Use Cases — Validate before creating](./use-cases#use-case-2-validate-before-creating).
76+
A: Use `validateShipment` first to check your shipment data before creating it. The validation response includes specific `Issues` with `Rule` and `Location` fields pointing to the problematic field. See [Use Cases — Validate before creating](../GLS/use-cases.md#use-case-2-validate-before-creating).
7777

7878
---
7979

docs/Actions/GLS/use-cases.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,7 @@ Response:
297297
"ShippingDate": "2025-01-15",
298298
"Product": "PARCEL",
299299
"Consignee": {
300-
"Address": { "Name1": "Jane Smith", "City": "Hamburg", ... }
300+
"Address": { "Name1": "Jane Smith", "City": "Hamburg" } // ... and other parameters
301301
},
302302
"ShipmentUnit": [
303303
{ "TrackID": "12345678", "Weight": "1.2", "ParcelNumber": "00123456789" }

docs/Guides/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Before you begin, make sure you have the following:
2020
- **Docker** and **Docker Compose** installed
2121
- A running **Aquila** server (part of the Hercules platform)
2222
- Your `HERCULES_AUTH_TOKEN` from the Aquila admin panel
23-
- Service-specific credentials (e.g. GLS API keys — see [GLS Configuration](../Actions/GLS/configs))
23+
- Service-specific credentials (e.g. GLS API keys — see [GLS Configuration](../Actions/GLS/configs.md))
2424

2525
---
2626

@@ -71,7 +71,7 @@ HERCULES_ACTION_ID=gls-action
7171
HERCULES_SDK_VERSION=1.0.0
7272
```
7373

74-
For action-specific variables (e.g. GLS API credentials), see the [GLS Configuration](../Actions/GLS/configs) page.
74+
For action-specific variables (e.g. GLS API credentials), see the [GLS Configuration](../Actions/GLS/configs.md) page.
7575

7676
---
7777

0 commit comments

Comments
 (0)