Functions

The GLS Action exposes functions grouped into three categories:

Builder functions — Construct data objects (no API call)
Shipment functions — Create different types of GLS shipments (calls GLS API)
API functions — Query or modify shipments (calls GLS API)

Builder functions

`createShipmentUnit`

Parameter	Name	Type	Required	Description
weight	Weight (kg)	number	Yes	The weight of the shipment unit in kilograms. Must be a positive number and greater than 0.10 and less than 99.
shipmentUnitReference	Shipment unit reference	string	No	The reference for the shipment unit. Max length is 40 characters.
partnerParcelNumber	Partner parcel number	string	No	The partner parcel number for the shipment unit. Max length is 50 characters.
note1	Note 1	string	No	Note 1 for the shipment unit. Max length is 50 characters.
note2	Note 2	string	No	Note 2 for the shipment unit. Max length is 50 characters.
shipmentUnitService	Shipment unit service	GLS_SHIPMENT_UNIT$Service	Yes	The service associated with the shipment unit.

Return Type: GLS_SHIPMENT_UNIT

Creates a GLS shipment unit (an individual parcel within a shipment).

Create shipment unit

Weight (kg)

The weight of the shipment unit in kilograms. Must be a positive number and greater than 0.10 and less than 99.

Shipment unit reference

The reference for the shipment unit. Max length is 40 characters.

Partner parcel number

The partner parcel number for the shipment unit. Max length is 50 characters.

Note 1

Note 1 for the shipment unit. Max length is 50 characters.

Note 2

Note 2 for the shipment unit. Max length is 50 characters.

Shipment unit service

The service associated with the shipment unit.

`createPrintingOptions`

Parameter	Name	Type	Required	Description
returnLabels	Return labels	RETURN_LABELS	Yes	The return labels to be included in the shipment.

Return Type: GLS_PRINTING_OPTIONS

Creates GLS printing options that control how labels are generated.

Create printing options

Return labels

The return labels to be included in the shipment.

`createCustomContent`

Parameter	Name	Type	Required	Description
barcodeContentType	Barcode content type	"TRACK_ID"\|"GLS_SHIPMENT_REFERENCE"	Yes	Type of content encoded in the barcode (TRACK_ID or GLS_SHIPMENT_REFERENCE).
customerLogo	Customer logo	string	Yes	Base64-encoded customer logo to print on the label.
hideShipperAddress	Hide shipper address	boolean	No	Whether to hide the shipper address on the label.
barcodeType	Barcode type	"EAN_128"\|"CODE_39"	No	Type of barcode to use (EAN_128 or CODE_39).
barcode	Barcode	string	No	Barcode value to print on the label.

Return Type: GLS_CUSTOM_CONTENT

Creates custom content settings for GLS labels, including logos and barcodes.

Create custom content

Barcode content type

Type of content encoded in the barcode (TRACK_ID or GLS_SHIPMENT_REFERENCE).

Customer logo

Base64-encoded customer logo to print on the label.

Hide shipper address

Whether to hide the shipper address on the label.

Barcode type

Type of barcode to use (EAN_128 or CODE_39).

Barcode

Barcode value to print on the label.

`createConsignee`

Parameter	Name	Type	Required	Description
consigneeId	Consignee ID	string	Yes	The ID of the consignee. Max length is 40 characters.
costCenter	Cost center	string	Yes	The cost center for the consignee. Max length is 80 characters.
Address	Address	GLS_ADDRESS	Yes	The address of the consignee.
Category	Category	"BUSINESS"\|"PRIVATE"	Yes	The category of the consignee. Can be either BUSINESS or PRIVATE.

Return Type: GLS_CONSIGNEE

Creates a GLS consignee (recipient) object for use in shipments.

Create consignee

Consignee ID

The ID of the consignee. Max length is 40 characters.

Cost center

The cost center for the consignee. Max length is 80 characters.

Address

The address of the consignee.

`createAddress`

Parameter	Name	Type	Required	Description
Name1	Name 1	string	Yes	The name of the recipient or company. Max length is 40 characters.
CountryCode	Country code	string	Yes	The ISO alpha-2 country code. For example, DE for Germany or FR for France.
City	City	string	Yes	The city of the address. Max length is 40 characters.
Street	Street	string	Yes	The street name of the address. Min length is 4 characters.
ZIPCode	ZIP code	string	Yes	The ZIP code of the address. Max length is 10 characters.
Name2	Name 2	string	No	Additional name information. Max length is 40 characters.
Name3	Name 3	string	No	Additional name information. Max length is 40 characters.
Province	Province/State	string	No	The province or state of the address. Max length is 40 characters.
StreetNumber	Street number	string	No	The street number of the address. Max length is 40 characters.
ContactPerson	Contact person	string	No	The contact person for the address. Max length is 40 characters.
FixedLinePhonenumber	Fixed line phone number	string	No	The fixed line phone number for the address. Max length is 35 characters.
MobilePhonenumber	Mobile phone number	string	No	The mobile phone number for the address. Max length is 35 characters.
Email	Email	string	No	The email address for the address. Max length is 80 characters.

Return Type: GLS_ADDRESS

Creates a GLS address object (GLS_ADDRESS) for use in shipments as consignee, shipper, or return address.

Create address

Name 1

The name of the recipient or company. Max length is 40 characters.

Country code

The ISO alpha-2 country code. For example, DE for Germany or FR for France.

City

The city of the address. Max length is 40 characters.

Street

The street name of the address. Min length is 4 characters.

ZIP code

The ZIP code of the address. Max length is 10 characters.

Name 2

Additional name information. Max length is 40 characters.

Name 3

Additional name information. Max length is 40 characters.

Province/State

The province or state of the address. Max length is 40 characters.

Street number

The street number of the address. Max length is 40 characters.

Contact person

The contact person for the address. Max length is 40 characters.

Fixed line phone number

The fixed line phone number for the address. Max length is 35 characters.

Mobile phone number

The mobile phone number for the address. Max length is 35 characters.

The email address for the address. Max length is 80 characters.

Shipment functions

All shipment functions accept a common set of parameters in addition to their type-specific parameters. They call the GLS ShipIT API (POST /rs/shipments) and return a GLS_CREATE_PARCELS_RESPONSE.

Common parameters for all shipment functions:

Parameter	Type	Required	Description
`shipment`	GLS_SHIPMENT_WITHOUT_SERVICES	Yes	Shipment data (consignee, shipper, units, product)
`printingOptions`	GLS_PRINTING_OPTIONS	Yes	Label format settings
`returnOptions`	GLS_RETURN_OPTIONS	No	Whether to return print data and routing info
`customContent`	GLS_CUSTOM_CONTENT	No	Custom logo and barcode settings

`createTyreShipment`

Parameter	Name	Type	Required	Description
shipment	Shipment	GLS_SHIPMENT	Yes	The shipment for which to create the parcels. Must include all necessary information and services for the shipment.
printingOptions	Printing options	GLS_PRINTING_OPTIONS	Yes	The printing options for the shipment. Specifies options for the labels to be printed for the shipment.
returnOptions	Return options	GLS_RETURN_OPTIONS	No	The return options for the shipment. Specifies options for return shipments.
customContent	Custom content	GLS_CUSTOM_CONTENT	No	The custom content for the shipment. Specifies options for custom content to be printed on the labels.

Return Type: GLS_CREATE_PARCELS_RESPONSE

Creates a shipment specifically for tyre/wheel delivery (uses the GLS TyreService).

Create tyre shipment

Shipment

The shipment for which to create the parcels. Must include all necessary information and services for the shipment.

Printing options

The printing options for the shipment. Specifies options for the labels to be printed for the shipment.

Return options

The return options for the shipment. Specifies options for return shipments.

Custom content

The custom content for the shipment. Specifies options for custom content to be printed on the labels.

`createSignatureShipment`

Parameter	Name	Type	Required	Description
shipment	Shipment	GLS_SHIPMENT	Yes	The shipment for which to create the parcels. Must include all necessary information and services for the shipment.
printingOptions	Printing options	GLS_PRINTING_OPTIONS	Yes	The printing options for the shipment. Specifies options for the labels to be printed for the shipment.
returnOptions	Return options	GLS_RETURN_OPTIONS	No	The return options for the shipment. Specifies options for return shipments.
customContent	Custom content	GLS_CUSTOM_CONTENT	No	The custom content for the shipment. Specifies options for custom content to be printed on the labels.

Return Type: GLS_CREATE_PARCELS_RESPONSE

Creates a shipment that requires a recipient signature upon delivery.

Create signature shipment

Shipment

The shipment for which to create the parcels. Must include all necessary information and services for the shipment.

Printing options

The printing options for the shipment. Specifies options for the labels to be printed for the shipment.

Return options

The return options for the shipment. Specifies options for return shipments.

Custom content

The custom content for the shipment. Specifies options for custom content to be printed on the labels.

`createShopReturnShipment`

Parameter	Name	Type	Required	Description
numberOfLabels	The number of labels	number	Yes	The number of labels to be created for the return shipment.
shipment	Shipment	GLS_SHIPMENT	Yes	The shipment for which to create the parcels. Must include all necessary information and services for the shipment.
printingOptions	Printing options	GLS_PRINTING_OPTIONS	Yes	The printing options for the shipment. Specifies options for the labels to be printed for the shipment.
returnOptions	Return options	GLS_RETURN_OPTIONS	No	The return options for the shipment. Specifies options for return shipments.
customContent	Custom content	GLS_CUSTOM_CONTENT	No	The custom content for the shipment. Specifies options for custom content to be printed on the labels.
returnQR	Return QR	"PDF" \| "PNG" \| "ZPL"	Yes	The return QR of the shipment.

Return Type: GLS_CREATE_PARCELS_RESPONSE

Creates a return shipment from a GLS Parcel Shop (customer drops off parcel at a shop).

Create shop return shipment

The number of labels

The number of labels to be created for the return shipment.

Shipment

The shipment for which to create the parcels. Must include all necessary information and services for the shipment.

Printing options

The printing options for the shipment. Specifies options for the labels to be printed for the shipment.

Return options

The return options for the shipment. Specifies options for return shipments.

Custom content

The custom content for the shipment. Specifies options for custom content to be printed on the labels.

Return QR

The return QR of the shipment.

`createShopDeliveryShipment`

Parameter	Name	Type	Required	Description
parcelShopId	Parcel shop Id	string	Yes	The ID of the parcel shop where the shipment should be delivered.
shipment	Shipment	GLS_SHIPMENT	Yes	The shipment for which to create the parcels. Must include all necessary information and services for the shipment.
printingOptions	Printing options	GLS_PRINTING_OPTIONS	Yes	The printing options for the shipment. Specifies options for the labels to be printed for the shipment.
returnOptions	Return options	GLS_RETURN_OPTIONS	No	The return options for the shipment. Specifies options for return shipments.
customContent	Custom content	GLS_CUSTOM_CONTENT	No	The custom content for the shipment. Specifies options for custom content to be printed on the labels.

Return Type: GLS_CREATE_PARCELS_RESPONSE

Delivers a parcel to a GLS Parcel Shop where the recipient can collect it.

Create shop delivery shipment

Parcel shop Id

The ID of the parcel shop where the shipment should be delivered.

Shipment

The shipment for which to create the parcels. Must include all necessary information and services for the shipment.

Printing options

The printing options for the shipment. Specifies options for the labels to be printed for the shipment.

Return options

The return options for the shipment. Specifies options for return shipments.

Custom content

The custom content for the shipment. Specifies options for custom content to be printed on the labels.

`createPickAndShipShipment`

Parameter	Name	Type	Required	Description
pickupDate	Pickup date	string	Yes	The pickup date for the pick and ship shipment.
shipment	Shipment	GLS_SHIPMENT	Yes	The shipment for which to create the parcels. Must include all necessary information and services for the shipment.
printingOptions	Printing options	GLS_PRINTING_OPTIONS	Yes	The printing options for the shipment. Specifies options for the labels to be printed for the shipment.
returnOptions	Return options	GLS_RETURN_OPTIONS	No	The return options for the shipment. Specifies options for return shipments.
customContent	Custom content	GLS_CUSTOM_CONTENT	No	The custom content for the shipment. Specifies options for custom content to be printed on the labels.

Return Type: GLS_CREATE_PARCELS_RESPONSE

Schedules a pickup from the consignee's address on a given date.

Create pick and ship shipment

Pickup date

The pickup date for the pick and ship shipment.

Shipment

The shipment for which to create the parcels. Must include all necessary information and services for the shipment.

Printing options

The printing options for the shipment. Specifies options for the labels to be printed for the shipment.

Return options

The return options for the shipment. Specifies options for return shipments.

Custom content

The custom content for the shipment. Specifies options for custom content to be printed on the labels.

`createIdentShipment`

Parameter	Name	Type	Required	Description
birthDate	Birth date	string	Yes	The birth date for the ident shipment identification.
firstName	First name	string	Yes	The first name for the ident shipment identification.
lastName	Last name	string	Yes	The last name for the ident shipment identification.
nationality	Nationality	string	Yes	The nationality for the ident shipment identification.
shipment	Shipment	GLS_SHIPMENT	Yes	The shipment for which to create the parcels. Must include all necessary information and services for the shipment.
printingOptions	Printing options	GLS_PRINTING_OPTIONS	Yes	The printing options for the shipment. Specifies options for the labels to be printed for the shipment.
returnOptions	Return options	GLS_RETURN_OPTIONS	No	The return options for the shipment. Specifies options for return shipments.
customContent	Custom content	GLS_CUSTOM_CONTENT	No	The custom content for the shipment. Specifies options for custom content to be printed on the labels.

Return Type: GLS_CREATE_PARCELS_RESPONSE

Delivers a parcel with identity verification - the driver checks the recipient's ID document.

Create ident shipment

Birth date

The birth date for the ident shipment identification.

First name

The first name for the ident shipment identification.

Last name

The last name for the ident shipment identification.

Nationality

The nationality for the ident shipment identification.

Shipment

The shipment for which to create the parcels. Must include all necessary information and services for the shipment.

Printing options

The printing options for the shipment. Specifies options for the labels to be printed for the shipment.

Return options

The return options for the shipment. Specifies options for return shipments.

Custom content

The custom content for the shipment. Specifies options for custom content to be printed on the labels.

`createIdentPinShipment`

Parameter	Name	Type	Required	Description
pin	Pin	string	Yes	The pin for the ident pin shipment identification.
shipment	Shipment	GLS_SHIPMENT	Yes	The shipment for which to create the parcels. Must include all necessary information and services for the shipment.
printingOptions	Printing options	GLS_PRINTING_OPTIONS	Yes	The printing options for the shipment. Specifies options for the labels to be printed for the shipment.
returnOptions	Return options	GLS_RETURN_OPTIONS	No	The return options for the shipment. Specifies options for return shipments.
customContent	Custom content	GLS_CUSTOM_CONTENT	No	The custom content for the shipment. Specifies options for custom content to be printed on the labels.
birthDate	Birth date	string	Yes	The birth date for the ident pin shipment identification.

Return Type: GLS_CREATE_PARCELS_RESPONSE

Delivers a parcel with PIN and optional birthdate verification.

Create ident pin shipment

The pin for the ident pin shipment identification.

Shipment

The shipment for which to create the parcels. Must include all necessary information and services for the shipment.

Printing options

The printing options for the shipment. Specifies options for the labels to be printed for the shipment.

Return options

The return options for the shipment. Specifies options for return shipments.

Custom content

The custom content for the shipment. Specifies options for custom content to be printed on the labels.

Birth date

The birth date for the ident pin shipment identification.

`createGuaranteed24Shipment`

Parameter	Name	Type	Required	Description
shipment	Shipment	GLS_SHIPMENT	Yes	The shipment for which to create the parcels. Must include all necessary information and services for the shipment.
printingOptions	Printing options	GLS_PRINTING_OPTIONS	Yes	The printing options for the shipment. Specifies options for the labels to be printed for the shipment.
returnOptions	Return options	GLS_RETURN_OPTIONS	No	The return options for the shipment. Specifies options for return shipments.
customContent	Custom content	GLS_CUSTOM_CONTENT	No	The custom content for the shipment. Specifies options for custom content to be printed on the labels.

Return Type: GLS_CREATE_PARCELS_RESPONSE

Creates a shipment with guaranteed delivery within 24 hours.

Create guaranteed 24 shipment

Shipment

The shipment for which to create the parcels. Must include all necessary information and services for the shipment.

Printing options

The printing options for the shipment. Specifies options for the labels to be printed for the shipment.

Return options

The return options for the shipment. Specifies options for return shipments.

Custom content

The custom content for the shipment. Specifies options for custom content to be printed on the labels.

`createFlexDeliveryShipment`

Parameter	Name	Type	Required	Description
shipment	Shipment	GLS_SHIPMENT	Yes	The shipment for which to create the parcels. Must include all necessary information and services for the shipment.
printingOptions	Printing options	GLS_PRINTING_OPTIONS	Yes	The printing options for the shipment. Specifies options for the labels to be printed for the shipment.
returnOptions	Return options	GLS_RETURN_OPTIONS	No	The return options for the shipment. Specifies options for return shipments.
customContent	Custom content	GLS_CUSTOM_CONTENT	No	The custom content for the shipment. Specifies options for custom content to be printed on the labels.

Return Type: GLS_CREATE_PARCELS_RESPONSE

Creates a shipment with flexible delivery - the recipient can redirect or reschedule delivery.

Create flex delivery shipment

Shipment

The shipment for which to create the parcels. Must include all necessary information and services for the shipment.

Printing options

The printing options for the shipment. Specifies options for the labels to be printed for the shipment.

Return options

The return options for the shipment. Specifies options for return shipments.

Custom content

The custom content for the shipment. Specifies options for custom content to be printed on the labels.

`createExchangeShipment`

Parameter	Name	Type	Required	Description
address	Address	GLS_ADDRESS	Yes	The address of the exchange shipment.
shipment	Shipment	GLS_SHIPMENT	Yes	The shipment for which to create the parcels. Must include all necessary information and services for the shipment.
printingOptions	Printing options	GLS_PRINTING_OPTIONS	Yes	The printing options for the shipment. Specifies options for the labels to be printed for the shipment.
returnOptions	Return options	GLS_RETURN_OPTIONS	No	The return options for the shipment. Specifies options for return shipments.
customContent	Custom content	GLS_CUSTOM_CONTENT	No	The custom content for the shipment. Specifies options for custom content to be printed on the labels.
expectedWeight	Expected weight	number	No	The expected weight for the exchange shipment.

Return Type: GLS_CREATE_PARCELS_RESPONSE

Delivers a new parcel while simultaneously picking up an existing one (exchange).

Create exchange shipment

Address

The address of the exchange shipment.

Shipment

The shipment for which to create the parcels. Must include all necessary information and services for the shipment.

Printing options

The printing options for the shipment. Specifies options for the labels to be printed for the shipment.

Return options

The return options for the shipment. Specifies options for return shipments.

Custom content

The custom content for the shipment. Specifies options for custom content to be printed on the labels.

Expected weight

The expected weight for the exchange shipment.

`createDepositShipment`

Parameter	Name	Type	Required	Description
placeOfDeposit	Place of deposit	string	Yes	The place of deposit for the delivery.
shipment	Shipment	GLS_SHIPMENT	Yes	The shipment for which to create the parcels. Must include all necessary information and services for the shipment.
printingOptions	Printing options	GLS_PRINTING_OPTIONS	Yes	The printing options for the shipment. Specifies options for the labels to be printed for the shipment.
returnOptions	Return options	GLS_RETURN_OPTIONS	No	The return options for the shipment. Specifies options for return shipments.
customContent	Custom content	GLS_CUSTOM_CONTENT	No	The custom content for the shipment. Specifies options for custom content to be printed on the labels.

Return Type: GLS_CREATE_PARCELS_RESPONSE

Delivers a parcel to a designated deposit location (e.g. a garage or shed) without requiring a signature.

Create deposit shipment

Place of deposit

The place of deposit for the delivery.

Shipment

The shipment for which to create the parcels. Must include all necessary information and services for the shipment.

Printing options

The printing options for the shipment. Specifies options for the labels to be printed for the shipment.

Return options

The return options for the shipment. Specifies options for return shipments.

Custom content

The custom content for the shipment. Specifies options for custom content to be printed on the labels.

`createDeliverySaturdayShipment`

Parameter	Name	Type	Required	Description
shipment	Shipment	GLS_SHIPMENT	Yes	The shipment for which to create the parcels. Must include all necessary information and services for the shipment.
printingOptions	Printing options	GLS_PRINTING_OPTIONS	Yes	The printing options for the shipment. Specifies options for the labels to be printed for the shipment.
returnOptions	Return options	GLS_RETURN_OPTIONS	No	The return options for the shipment. Specifies options for return shipments.
customContent	Custom content	GLS_CUSTOM_CONTENT	No	The custom content for the shipment. Specifies options for custom content to be printed on the labels.

Return Type: GLS_CREATE_PARCELS_RESPONSE

Creates an EXPRESS shipment for Saturday delivery.

Create delivery Saturday shipment

Shipment

The shipment for which to create the parcels. Must include all necessary information and services for the shipment.

Printing options

The printing options for the shipment. Specifies options for the labels to be printed for the shipment.

Return options

The return options for the shipment. Specifies options for return shipments.

Custom content

The custom content for the shipment. Specifies options for custom content to be printed on the labels.

`createDeliveryNextWorkingDayShipment`

Parameter	Name	Type	Required	Description
shipment	Shipment	GLS_SHIPMENT	Yes	The shipment for which to create the parcels. Must include all necessary information and services for the shipment.
printingOptions	Printing options	GLS_PRINTING_OPTIONS	Yes	The printing options for the shipment. Specifies options for the labels to be printed for the shipment.
returnOptions	Return options	GLS_RETURN_OPTIONS	No	The return options for the shipment. Specifies options for return shipments.
customContent	Custom content	GLS_CUSTOM_CONTENT	No	The custom content for the shipment. Specifies options for custom content to be printed on the labels.

Return Type: GLS_CREATE_PARCELS_RESPONSE

Creates an EXPRESS shipment for delivery on the next working day (EOB service).

Create delivery next working day shipment

Shipment

The shipment for which to create the parcels. Must include all necessary information and services for the shipment.

Printing options

The printing options for the shipment. Specifies options for the labels to be printed for the shipment.

Return options

The return options for the shipment. Specifies options for return shipments.

Custom content

The custom content for the shipment. Specifies options for custom content to be printed on the labels.

`createDeliveryAtWorkShipment`

Parameter	Name	Type	Required	Description
recipientName	Recipient name	string	Yes	The recipient name for the delivery at work shipment.
building	Building	string	Yes	The building of the delivery at work shipment.
floor	Floor	number	Yes	The floor of the delivery at work shipment.
shipment	Shipment	GLS_SHIPMENT	Yes	The shipment for which to create the parcels. Must include all necessary information and services for the shipment.
printingOptions	Printing options	GLS_PRINTING_OPTIONS	Yes	The printing options for the shipment. Specifies options for the labels to be printed for the shipment.
returnOptions	Return options	GLS_RETURN_OPTIONS	No	The return options for the shipment. Specifies options for return shipments.
customContent	Custom content	GLS_CUSTOM_CONTENT	No	The custom content for the shipment. Specifies options for custom content to be printed on the labels.
alternateRecipientName	Alternate recipient name	string	No	The alternate recipient name for the delivery at work shipment.
room	Room	number	No	The room of the delivery at work shipment.
phonenumber	Phone number	string	No	The phone number for the delivery at work shipment.

Return Type: GLS_CREATE_PARCELS_RESPONSE

Delivers a parcel to a specific location within a workplace (building, floor, room).

Create delivery at work shipment

Recipient name

The recipient name for the delivery at work shipment.

Building

The building of the delivery at work shipment.

Floor

The floor of the delivery at work shipment.

Shipment

The shipment for which to create the parcels. Must include all necessary information and services for the shipment.

Printing options

The printing options for the shipment. Specifies options for the labels to be printed for the shipment.

Return options

The return options for the shipment. Specifies options for return shipments.

Custom content

The custom content for the shipment. Specifies options for custom content to be printed on the labels.

Alternate recipient name

The alternate recipient name for the delivery at work shipment.

Room

The room of the delivery at work shipment.

Phone number

The phone number for the delivery at work shipment.

`createAddresseeOnlyShipment`

Parameter	Name	Type	Required	Description
shipment	Shipment	GLS_SHIPMENT	Yes	The shipment for which to create the parcels. Must include all necessary information and services for the shipment.
printingOptions	Printing options	GLS_PRINTING_OPTIONS	Yes	The printing options for the shipment. Specifies options for the labels to be printed for the shipment.
returnOptions	Return options	GLS_RETURN_OPTIONS	No	The return options for the shipment. Specifies options for return shipments.
customContent	Custom content	GLS_CUSTOM_CONTENT	No	The custom content for the shipment. Specifies options for custom content to be printed on the labels.

Return Type: GLS_CREATE_PARCELS_RESPONSE

Creates a shipment that can only be delivered to the named addressee (no neighbor delivery).

Create addressee only shipment

Shipment

The shipment for which to create the parcels. Must include all necessary information and services for the shipment.

Printing options

The printing options for the shipment. Specifies options for the labels to be printed for the shipment.

Return options

The return options for the shipment. Specifies options for return shipments.

Custom content

The custom content for the shipment. Specifies options for custom content to be printed on the labels.

API functions

`validateShipment`

Parameter	Name	Type	Required	Description
data	Data	GLS_VALIDATE_SHIPMENT_REQUEST_DATA	Yes	The shipment data to validate.

Return Type: GLS_VALIDATE_SHIPMENT_RESPONSE_DATA

Validates a shipment against the GLS API without creating it. Use this before createShipment functions to catch errors early.

Validate shipment

Data

The shipment data to validate.

`updateParcelWeight`

Parameter	Name	Type	Required	Description
data	Data	GLS_UPDATE_PARCEL_WEIGHT_REQUEST_DATA	Yes	The update parcel weight request data.

Return Type: GLS_END_OF_DAY_RESPONSE_DATA

Updates the weight of an already-created parcel. Useful when the final weight is only known after packaging.

Update parcel weight

Data

The update parcel weight request data.

`reprintParcel`

Parameter	Name	Type	Required	Description
data	Data	GLS_REPRINT_PARCEL_REQUEST_DATA	Yes	The reprint parcel request data.

Return Type: GLS_REPRINT_PARCEL_RESPONSE_DATA

Reprints the label for an existing parcel. Use this if the original label is damaged, lost, or needs to be printed in a different format.

Reprint parcel

Data

The reprint parcel request data.

`getEndOfDayReport`

Parameter	Name	Type	Required	Description
data	Data	GLS_END_OF_DAY_REQUEST_DATA	Yes	The end of day report request data.

Return Type: GLS_END_OF_DAY_RESPONSE_DATA

Retrieves all shipments dispatched on a given date. Useful for reconciliation and end-of-day processing.

Get end of day report

Data

The end of day report request data.

`getAllowedServices`

Parameter	Name	Type	Required	Description
data	Data	GLS_ALLOWED_SERVICES_REQUEST_DATA	Yes	The allowed services request data.

Return Type: GLS_ALLOWED_SERVICES_RESPONSE_DATA

Returns the GLS services available for a given origin/destination country and ZIP code combination.

Get allowed services

Data

The allowed services request data.

`cancelShipment`

Parameter	Name	Type	Required	Description
data	Data	GLS_CANCEL_SHIPMENT_REQUEST_DATA	Yes	The cancel shipment request data.

Return Type: GLS_CANCEL_SHIPMENT_RESPONSE_DATA

Cancels an existing shipment by its Track ID. Only possible if the parcel has not yet been scanned.

Cancel shipment

Data

The cancel shipment request data.

Functions

On this page