GLS ShipIT  3.5.15
GLS ShipIT - SOAP services
Processing shipments

Table of Contents

Accessing the web service

The endpoints for the centrally hosted services can be obtained from your primary GLS contact and will be given with your credentials for the Service. You can retrieve the WSDL of the corresponding service by adding '?wsdl' to the URL.

If you are connecting to a locally installed GLS ShipIT, you have to adapt the URL to point to the host (and port) in your network where the GLS ShipIT backend is running. E.g. https://10.10.10.10:8443/backend/ShipmentProcessingService/ShipmentProcessingPortType?wsdl The web service request/response content is encoded using UTF-8.

All web services operations within this port are about creating or updating shipments. A shipment is a selection of one or more parcels that are collected at address A and delivered to address B. If several parcels should be sent from address A to address B and those parcels should share the same services, they can be combined to a shipment.

Available web service operations

Webservices Examples

The pages below contain examples of webservice calls and error responses:

createParcels

This operation creates a shipment that contains one or more shipment units. The operation takes an instance of eu.glsgroup.fpcs.datatypes.soap.v1.shipmentprocessing.ShipmentRequestData The input object is split into several sections allowing you to specify Shipper data, Consignee data, Return data, Shipment unit data, products and services, Printing options as well as some Custom content like an extra barcode or image that should be printed on the label.

Parameter Mandatory Description
shipmentRequest TRUE The eu.glsgroup.fpcs.datatypes.soap.v1.shipmentprocessing.ShipmentRequestData with the shipment parameters.

The parts of the request are explained in the following sections in more detail.
Please generally note that the following characters are not allowed as part of text fields and can cause issues at parcel operations: \"{},;()|

Shipment data

When you are creating a shipment, you can specify several attributes on the shipment level. These are:

<typ:Shipment>
<typ:ShipmentReference>1dd351a9-e0b5-4ead-ace4-d834a1233d27</typ:ShipmentReference>
<typ:ShipmentReference>d9652383-a95f-4cc4-b03a-6ee05f3b7aa5</typ:ShipmentReference>
<typ:ShippingDate>2019-01-01</typ:ShippingDate>
<typ:Identifier>userTestId</typ:Identifier>
<typ:Middleware>Primavera</typ:Middleware>
<typ:Product>Parcel</typ:Product>
...
</typ:Shipment>


Name Expression in webservices Field length Type Format Mandatory/Optional Restrictions Level Description
Customer reference number ShipmentReference 40 alphanumeric Optional - Reference for this consignment of parcels
Shipping date ShippingDate 10 alphanumeric YYYY-MM-DD Optional - Date for the shipment
Incoterm IncotermCode 2 alphanumeric 10, 20, 30, etc. Optional Incoterm for this shipment. Represented by 2 digits
Identifier Identifier 40 alphanumeric Optional - Person who started the parcel creation
Middleware Middleware 40 alphanumeric Mandatory - Partner ERP System
Product Group Product 7 alphanumeric Mandatory Parcel, Express Please select one
Alternative delivery activation ExpressAltDeliveryAllowed 5 boolean Optional true or false Please select one
Consignee Consignee Mandatory - see section Consignee data
Shipper Shipper Mandatory - see section Shipper data
Return Return Optional - see section Return data
Shipment unit ShipmentUnit Mandatory - see section Shipment unit data
Services Services Optional - see section Services

Consignee data

The consignee is the person to which the shipment shall be sent. The consignee ID will be printed on the label if specified. The consignee address has to be specified within the request. The consignee category can be "BUSINESS" or "PRIVATE". If the field consignee category is omitted, the consignee will have no (empty) category.

In case of shipments with return services (pick&return, pick&ship, shopreturn) assigned, the consignee and the shipper data sections will automatically be switched on the return label. That means the consignee address, that you provide within your Webrequest will be used as pickup address on the return label. According to Pick&Ship and Pick&Return Service the following fields are mandatory: ContactPerson and FixedLinePhonenumber.

The consignee address can be specified as follows:

<com:Address>
<com:Name1>Max Mustermann</com:Name1>
<com:Name2>Travel and Co</com:Name2>
<com:CountryCode>DE</com:CountryCode>
<com:ZIPCode>38106</com:ZIPCode>
<com:City>Braunschweig</com:City>
<com:Street>Falkenbergstrasse</com:Street>
<com:StreetNumber>47</com:StreetNumber>
<com:eMail>max.mustermann@email.test</com:eMail>
<com:FixedLinePhonenumber>004953112345</com:FixedLinePhonenumber>
<com:MobilePhoneNumber>00491791234567</com:MobilePhoneNumber>
</com:Address>

The consignee category can be specified as follows:

<typ:Consignee>
<com:Category>BUSINESS</com:Category>
<com:Address>....</com:Address>
</typ:Consignee>

To provide an example of a consignee ID that should be printed on the label:

<typ:Consignee>
<com:ConsigneeID>100</com:ConsigneeID>
<com:Address>....</com:Address>
</typ:Consignee>


Name Expression in webservices Field length Type Format Mandatory/Optional Restrictions Level Description
Consignee identifier ConsigneeID 80 alphanumeric Optional - Identifier for the recipient of the parcels
Cost Center CostCenter 80 alphanumeric Optional - Delivery location cost center for Inbound
Consignee Category Category 8 alphanumeric CAPS LOCK Optional Only PRIVATE or BUSINESS Classifies consignee as 2B (BUSINESS) or 2C (PRIVATE) recipient
Consignee Address Address Mandatory - see section Address data for field details

Address data

The following table applies to any kind of address that is possible within the request - only the purpose is different.
Consignee - generally the recipient of a parcel - only exception are return services: here it is the one where the parcel is handed in to GLS.
Shipper - shipper address information is automatically assigned / transmitted on the basis of the Contact ID. It must not be transmitted within the web service call, in case the GLS customer has a dedicated Contact ID! Please liaise with your GLS contact if you can use this address. The shipper address must only be transmitted in case ShipIT is used in a GLS country (Netherlands, Hungary), which does not assign dedicated Contact IDs to a GLS Customer. In this scenario a general “dummy” Contact ID will be used for all customers, which makes it necessary to transmit the real shipper address. The shipper address has an operational impact and can only be used within the same country.
Alternative Shipper - used for masking the original shipper address. This has only impact on the label where the actual address is overwritten. No operational impact.
Return Address - identifies the return address a parcel should be returned to, different from the shipper address. This might be the case for example if the recipient rejects the parcel.

In addition to these there is the expression of a requester in ShipIT who is always identified by the contactID and therefore part of the shipper. Other address types might apply for certain services. Please refer to the service section here.

Name Expression in webservices Field length Type Format Mandatory/Optional Restrictions Level Description
Name1 Name1 40 alphanumeric Mandatory - Name of the consignee
Name2 Name2 40 alphanumeric Optional - Additional consignee name information
Name3 Name3 40 alphanumeric Optional - Additional consignee name information
Country code CountryCode 2 alphanumeric DE, AT, BE, FR, etc. Mandatory - Destination country of the shipment
Province Province 40 alphanumeric Optional - Province where the consignee's city is located in
ZIPCode ZIPCode 10 alphanumeric Mandatory - ZIP code of the consignee's city
City City 40 alphanumeric Mandatory - City of the consignee
Street Street 40 alphanumeric Mandatory > 3 Street name
Street number StreetNumber 40 alphanumeric Optional - Street number (if not part of the street)
eMail eMail 80 alphanumeric Optional - Email address of the consignee
Contact person ContactPerson 40 alphanumeric Optional > 5 Contact person to print on the label
Fixed phonenumber FixedLinePhonenumber 35 alphanumeric Optional > 3 Fixed line phone number of the consignee
Mobile MobilePhoneNumber 35 alphanumeric Optional > 3 Mobile phone number of the consignee

Shipper data

The shipper address information is automatically assigned / transmitted on the basis of the Contact ID. It must not be transmitted within the web service call, in case the GLS customer has a dedicated Contact ID! Please liaise with your GLS contact if you can use this address. The shipper address must only be transmitted in case ShipIT is used in a GLS country (Netherlands, Hungary), which does not assign dedicated Contact IDs to a GLS Customer. In this scenario a general “dummy” Contact ID will be used for all customers, which makes it necessary to transmit the real shipper address. The shipper address has an operational impact and can only be used within the same country.

<typ:Shipper>
<com:ContactID>2761234567</com:ContactID>
<com:AlternativeShipperAddress>
<com:Name1>GLS IT Services GmbH</com:Name1>
<com:CountryCode>DE</com:CountryCode>
<com:ZIPCode>36286</com:ZIPCode>
<com:City>Neuenstein</com:City>
<com:Street>GLS Germany-Straße</com:Street>
<com:StreetNumber>1-7</com:StreetNumber>
<com:eMail>test_logistics@gls-group.com</com:eMail>
<com:FixedLinePhonenumber>004961961234567</com:FixedLinePhonenumber>
</com:AlternativeShipperAddress>
<com:Address>
<com:Name1>GLS IT Services GmbH</com:Name1>
<com:CountryCode>DE</com:CountryCode>
<com:ZIPCode>65760</com:ZIPCode>
<com:City>Eschborn</com:City>
<com:Street>Kölner Straße</com:Street>
<com:StreetNumber>3</com:StreetNumber>
</com:Address>
</typ:Shipper>


Name Expression in webservices Field length Type Format Mandatory/Optional Restrictions Level Description
Shipper identifier ContactID 20 alphanumeric Mandatory - Shipper identifier as given by GLS
Name1 Name1 40 alphanumeric Conditional - Name of the shipper
Name2 Name2 40 alphanumeric Optional - Additional shipper name information
Name3 Name3 40 alphanumeric Optional - Additional shipper name information
Country code CountryCode 2 alphanumeric DE, AT, BE, FR, etc. Conditional - Origin country of the shipment
Province Province 40 alphanumeric Optional - Province where the shipper's city is located in
ZIPCode* ZIPCode 10 alphanumeric Conditional - ZIP code of the shipper's city
City City 40 alphanumeric Conditional - City of the shipper
Street Street 40 alphanumeric Conditional > 3 Street name
Street number StreetNumber 40 alphanumeric Optional - Street number (if not part of the street)
Alternative address AlternativeShipperAddress - Address Optional - see section Address data

Conditional = if the address is given all conditional fields get mandatory.

Return data

This section identifies the return address a parcel should be returned to, different from the shipper address. This might be the case for example if the recipient rejects the parcel. This address is not printed and is only relevant for data transmission to GLS.

<typ:Return>
<com:Address>
<com:Name1>Mustermann AG</com:Name1>
<com:Name2>Return Center</com:Name2>
<com:Name3>Mrs. Return</com:Name3>
<com:Street>GLS Germany Str.</com:Street>
<com:StreetNumber>1-7</com:StreetNumber>
<com:ZIPCode>36286</com:ZIPCode>
<com:City>Neuenstein</com:City>
<com:CountryCode>DE</com:CountryCode>
</com:Address>
</typ:Return>


Name Expression in webservices Field length Type Format Mandatory/Optional Restrictions Level Description
Name1 Name1 40 alphanumeric Mandatory - Name of the return contact
Name2 Name2 40 alphanumeric Optional - Additional return name information
Name3 Name3 40 alphanumeric Optional - Additional return name information
Country code CountryCode 2 alphanumeric DE, AT, BE, FR, etc. Mandatory - Country of the return address
Province Province 40 alphanumeric Optional - Province where the return city is located in
ZIPCode* ZIPCode 10 alphanumeric Mandatory - ZIP code of the return city
City City 40 alphanumeric Mandatory - City of the return address
Street Street 40 alphanumeric Mandatory > 3 Street name
Street number StreetNumber 40 alphanumeric Optional - Street number (if not part of the street)

Shipment unit data

Within this section of the request you specify each shipment unit of your shipment.

A shipment unit can contain the following elements:

To create multiple units within a shipment, repeat the unit section as often as needed. Please limit this to 150 units per shipment.

Name Expression in webservices Field length Type Format Mandatory/Optional Restrictions Level Description
Parcel reference ShipmentUnitReference 40 alphanumeric Optional - Reference to be given to the parcel
Parcel Weight Weight 10 decimal Mandatory >0.10 Updated weight with at least 200g difference to original weight, max. 2 decimal digits.
Parcel note1 Note1 50 alphanumeric Optional - Notes added to the parcel (line 1)
Parcel note2 Note2 50 alphanumeric Optional - Notes added to the parcel (line 2)
Parcel services Service - Optional - see section Services for detailed fields
Partner's parcel number PartnerParcelNumber 50 alphanumeric Optional - Option for network partners to hand over their own reference

Services

You can define services that should apply to your shipment. For further information on the services currently available in your country please go to https://gls-group.eu and check the page of the desired country.

The following services can be assigned on the shipment unit level:

Those services may have different attributes for each shipment unit.

Services inside shipment unit can be combined like this:

Name Expression in webservices Field length Type Format Mandatory/Optional Restrictions Level Description
Cash service Cash
Name of the service ServiceName 80 alphanumeric service_cash Mandatory Parcel Shipment unit Must use this fixed value for service name
Cash reason Reason 160 alphanumeric Mandatory - Reason why the cash service was added to the parcel
Cash amount Amount - decimal Mandatory >0 Cash amount (numeric value), limitations apply per country
Cash currency Currency 3 alphanumeric EUR Mandatory - Cash currency code (ISO4217 -> 3 digits)
AddonLiability service AddonLiability
Name of the service ServiceName 80 alphanumeric service_addonliability Mandatory Parcel Shipment unit Must use this fixed value for service name
AddonLiability amount Amount - decimal Mandatory - Liability amount might differ per country, please liaise with your sales contact
AddonLiability currency Currency 3 alphanumeric EUR Mandatory - AddonLiability currency code (ISO4217 -> 3 digits)
Parcel description ParcelContent 255 alphanumeric Optional - Specify the parcel content
HazardousGoods service HazardousGoods
Name of the service ServiceName 80 alphanumeric service_hazardousgoods Mandatory Parcel Shipment unit Must use this fixed value for service name
HazardousGoods HazardousGoods - Hazardous good item attributes
Hazardous goods number GLSHazNo 8 alphanumeric Mandatory - Identifier for the hazardous goods type
HazardousGoods Weight Weight - decimal Mandatory > 0 Weight for the hazardous good shipped (numeric)
ExWorks service ExWorks
Name of the service ServiceName 80 alphanumeric service_exworks Mandatory Parcel Shipment unit Must use this fixed value for service name

The following services can be assigned on the shipment level:

All other services do not require specific attributes and can be assigned on the shipment level. If you e.g. want to have more possibilities to customise parcel delivery, you can book the FlexDeliveryService as follows:

<typ:Shipment>
...
<typ:Service>
<com:Service>
<com:ServiceName>service_flexdelivery</com:ServiceName>
</com:Service>
</typ:Service>
</typ:Shipment>

The same applies to Express shipments - these services do not require further information and can be added like stated underneath. Please note that parcels targeted to be delivered by the end of the business day do not need a dedicated service attached.

<typ:Shipment>
...
<typ:Product>EXPRESS</typ:Product>
...
<typ:Service>
<com:Service>
<com:ServiceName>service_1000</com:ServiceName>
</com:Service>
</typ:Service>
</typ:Shipment>


Name Expression in webservices Field length Type Format Mandatory/Optional Restrictions Level Description
Other service Service
Name of the service ServiceName - alphanumeric service_name Must use the service name defined in DB
ShopDelivery service ShopDelivery
Name of the service ServiceName 80 alphanumeric service_shopdelivery Mandatory Parcel Shipment Must use this fixed value for service name
Parcel shop identifier ParcelShopID 50 alphanumeric {partnerID}-{local id} Mandatory - Specify parcel shop
ShopReturn service ShopReturn
Name of the service ServiceName 80 alphanumeric service_shopreturn Mandatory Parcel Shipment Must use this fixed value for service name
Amount of labels NumberOfLabels numeric Mandatory > 0 Specify amount of labels to print
Intercompany service Intercompany
Name of the service ServiceName 80 alphanumeric service_intercompany Mandatory Parcel Shipment Must use this fixed value for service name
Intercompany address Address Mandatory see section Address data
Amount of labels NumberOfLabels numeric Mandatory > 0 Specify amount of labels to print
Expected Weight ExpectedWeight - decimal Optional > 0 Expected weight of the returned shipment
Exchange service Exchange
Name of the service ServiceName 80 alphanumeric service_exchange Mandatory Parcel Shipment Must use this fixed value for service name
Exchange address Address Mandatory - see section Address data
Expected Weight ExpectedWeight - decimal Optional > 0 Expected weight of the returned shipment
DeliveryAtWork service DeliveryAtWork Add an expected weight of the returned shipment
Name of the service ServiceName 80 alphanumeric service_deliveryatwork Mandatory Parcel Shipment Must use this fixed value for service name
Name of the Recipient RecipientName 40 alphanumeric Mandatory - Person who is allowed to receive the parcel
AlternateRecipientName AlternateRecipientName 40 alphanumeric Optional - Alternative person who is allowed to receive the parcel
Building Building 40 decimal Mandatory - Building number
Floor Floor 40 decimal Mandatory - Floor number
Room Room 40 decimal Optional - Room number
Phonenumber Phonenumber 35 decimal Optional - Phone number of the contact person
Deposit service Deposit
Name of the service ServiceName 80 alphanumeric service_deposit Mandatory Parcel Shipment Must use this fixed value for service name
Place of deposit PlaceOfDeposit 121 Mandatory - Place where the driver can drop the parcel
Letterbox service Deposit
Name of the service ServiceName 80 alphanumeric service_deposit Mandatory Parcel Shipment Must use this fixed value for service name
Place of deposit PlaceOfDeposit 121 Letterbox/ Briefkasten/ etc. Mandatory - Expression for letterbox in the destination's language
IdentPin service IdentPin
Name of the service ServiceName 80 alphanumeric service_identpin Mandatory Parcel Shipment Must use this fixed value for service name
PIN PIN 4 alphanumeric Mandatory 4-digit PIN code that the consignee needs to enter
Birthdate Birthdate 10 date YYYY-MM-DD Mandatory < today Birthdate of the consignee
Ident service Ident
Name of the service ServiceName 80 alphanumeric service_ident Mandatory Parcel Shipment Must use this fixed value for service name
Birthdate Birthdate 10 date YYYY-MM-DD Mandatory < today Birthdate of the consignee
Firstname Firstname 40 alphanumeric Mandatory - First name of the consignee
Lastname Lastname 40 alphanumeric Mandatory - Last name of the consignee
Nationality Nationality 2 alphanumeric Mandatory CountryCode Nationality of the consignee
PickAndShip service PickAndShip
Name of the service ServiceName 80 alphanumeric service_pickandship Mandatory Parcel Shipment Must use this fixed value
PickupDate PickupDate 10 date YYYY-MM-DD Mandatory > today Date when parcel should be picked up at shipper
PickAndReturn service PickAndReturn
Name of the service ServiceName 80 alphanumeric service_pickandreturn Mandatory Parcel Shipment Must use this fixed value
PickupDate PickupDate 10 date YYYY-MM-DD Mandatory > today Date when parcel should be picked up at shipper
Inbound Logistics InboundLogistics
Name of the service ServiceName 80 alphanumeric service_inbound Mandatory Parcel Shipment Must use this fixed value for service name
Document Return Service DocumentReturnService
Name of the service ServiceName 80 alphanumeric service_documentreturn Mandatory Parcel Shipment (w/o attributes) Must use this fixed value for service name
ConsignmentService CompleteDeliveryConsignmentService
Name of the service ServiceName 80 alphanumeric service_completedeliveryconsignment Mandatory Parcel Shipment (w/o attributes) Must use this fixed value for service name
Flex Delivery Service FlexDeliveryService
Name of the service ServiceName 80 alphanumeric service_flexdelivery Mandatory Parcel Shipment (w/o attributes) Must use this fixed value for service name
Guaranteed24 Service Guaranteed24Service
Name of the service ServiceName 80 alphanumeric service_guaranteed24 Mandatory Parcel Shipment (w/o attributes) Must use this fixed value for service name
AddresseeOnly Service AddresseeOnlyService
Name of the service ServiceName 80 alphanumeric service_addresseeonly Mandatory Parcel Shipment (w/o attributes) Must use this fixed value for service name
Tyre service TyreService
Name of the service ServiceName 80 alphanumeric service_tyre Mandatory Parcel/Express Shipment (w/o attributes) Must use this fixed value for service name and a weight >3 kg.
0800 Service 0800Service
Name of the service ServiceName 80 alphanumeric service_0800 Mandatory Express Shipment Must use this fixed value for service name
0900 Service 0900Service
Name of the service ServiceName 80 alphanumeric service_0900 Mandatory Express Shipment Must use this fixed value for service name
1000 Service 1000Service
Name of the service ServiceName 80 alphanumeric service_1000 Mandatory Express Shipment Must use this fixed value for service name
1200 Service 1200Service
Name of the service ServiceName 80 alphanumeric service_1200 Mandatory Express Shipment Must use this fixed value for service name
Saturday 1000 Service Saturday1000Service
Name of the service ServiceName 80 alphanumeric service_saturday_1000 Mandatory Express Shipment Must use this fixed value for service name
Saturday 1200 Service Saturday1200Service
Name of the service ServiceName 80 alphanumeric service_saturday_1200 Mandatory Express Shipment Must use this fixed value for service name
Saturday Service SaturdayService
Name of the service ServiceName 80 alphanumeric service_Saturday Mandatory Express (Euro) Shipment Must use this fixed value for service name
Delivery next working day (EOB)
Name of the service ServiceName Express No service needs to be added

Service combinations: If you want to send a shipment containing two shipment units (parcels) with FlexDeliveryService and CashService, you could use something like the following:

<typ:Shipment>
...
<typ:ShipmentUnit>
<typ:ShipmentUnitReference>Ref-Unit-0815</typ:ShipmentUnitReference>
<typ:Weight>5.00</typ:Weight>
<typ:Service>
<com:Cash>
<com:ServiceName>service_cash</com:ServiceName>
<com:Reason>Your order 4711</com:Reason>
<com:Amount>230.81</com:Amount>
<com:Currency>EUR</com:Currency>
</com:Cash>
</typ:Service>
</typ:ShipmentUnit>
<typ:ShipmentUnit>
<typ:ShipmentUnitReference>Ref-Unit-0816</typ:ShipmentUnitReference>
<typ:Weight>1.00</typ:Weight>
<typ:Service>
<com:Cash>
<com:ServiceName>service_cash</com:ServiceName>
<com:Reason>Your order 4711</com:Reason>
<com:Amount>12.09</com:Amount>
<com:Currency>EUR</com:Currency>
</com:Cash>
</typ:Service>
</typ:ShipmentUnit>
<typ:Service>
<com:Service>
<com:ServiceName>service_flexdelivery</com:ServiceName>
</com:Service>
</typ:Service>
</typ:Shipment>

Not all of these services are available in all countries and not all of those services may be combined with each other. For further information on products and services please refer to your key account or to the local homepage of each GLS country: https://gls-group.com/

Products

Finding the right product for your shipment will be determined by GLS ShipIT. The only information you have to give: if you want to send a standard parcel or wish to speed up by using express. Depending on the country-relation (where to send your parcel) and the weight the respective shipment product will be calculated.

1) Parcels sent within a country are considered as BusinessParcel or ExpressParcel - dependent on the product type chosen.
Small, light products with a given size and weight will become a "Small" - BusinessSmallParcel

You can create a Request BusinessParcel like the following example:

<typ:ShipmentRequestData>
<typ:Shipment>
<typ:Product>Parcel</typ:Product>
<typ:Consignee>
<com:Address>
<com:Name1>Mister Mal</com:Name1>
<com:CountryCode>DE</com:CountryCode>
<com:ZIPCode>65760</com:ZIPCode>
<com:City>Eschborn</com:City>
<com:Street>Mergenthalerallee</com:Street>
<com:StreetNumber>77</com:StreetNumber>
</com:Address>
</typ:Consignee>
<typ:Shipper>
<com:ContactID>276bu5y6En</com:ContactID>
</typ:Shipper>
<typ:ShipmentUnit>
<typ:Weight>3.1</typ:Weight>
</typ:ShipmentUnit>
</typ:Shipment>
<typ:PrintingOptions>
<typ:UseDefault>Default</typ:UseDefault>
</typ:PrintingOptions>
</typ:ShipmentRequestData>

You can create a Request ExpressParcel like the following example:

<typ:ShipmentRequestData>
<typ:Shipment>
<typ:Product>Express</typ:Product>
<typ:Consignee>
<com:Address>
<com:Name1>Mister Mal</com:Name1>
<com:CountryCode>DE</com:CountryCode>
<com:ZIPCode>65760</com:ZIPCode>
<com:City>Eschborn</com:City>
<com:Street>Mergenthalerallee</com:Street>
<com:StreetNumber>77</com:StreetNumber>
</com:Address>
</typ:Consignee>
<typ:Shipper>
<com:ContactID>2769995N0E</com:ContactID>
</typ:Shipper>
<typ:ShipmentUnit>
<typ:ShipmentUnitReference>Ref-Unit-0816</typ:ShipmentUnitReference>
<typ:Weight>4.30</typ:Weight>
</typ:ShipmentUnit>
<typ:Service>
<com:Service>
<com:ServiceName>service_1200</com:ServiceName>
</com:Service>
</typ:Service>
</typ:Shipment>
<typ:PrintingOptions>
<typ:UseDefault>Default</typ:UseDefault>
</typ:PrintingOptions>
</typ:ShipmentRequestData>

2) Parcels that are sent cross-border to other European countries will be either EuroBusinessParcels or EuroExpressParcels.
For EuroBusinessParcel there is as well the option to send them as EuroBusinessSmallParcel.
Don't forget to add incoterm information to your request, sending to customs areas like Switzerland.

Request EuroBusinessParcel

<typ:ShipmentRequestData>
<typ:Shipment>
<typ:ShipmentReference>05846-43873264</typ:ShipmentReference>
<typ:IncotermCode>10</typ:IncotermCode>
<typ:Product>Parcel</typ:Product>
<typ:Consignee>
<com:Address>
<com:Name1>Matteo Huber</com:Name1>
<com:CountryCode>CH</com:CountryCode>
<com:ZIPCode>3963</com:ZIPCode>
<com:City>Crans-Montana</com:City>
<com:Street>Route du Petit Signal</com:Street>
<com:StreetNumber>6</com:StreetNumber>
</com:Address>
</typ:Consignee>
<typ:Shipper>
<com:ContactID>276hjnkN0E</com:ContactID>
</typ:Shipper>
<typ:ShipmentUnit>
<typ:ShipmentUnitReference>REF_1</typ:ShipmentUnitReference>
<typ:Weight>12.2</typ:Weight>
</typ:ShipmentUnit>
</typ:Shipment>
<typ:PrintingOptions>
<typ:UseDefault>Default</typ:UseDefault>
</typ:PrintingOptions>
</typ:ShipmentRequestData>

Request EuroExpressParcel

<typ:ShipmentRequestData>
<typ:Shipment>
<typ:Product>Express</typ:Product>
<typ:Consignee>
<com:Address>
<com:Name1>Franz Huber</com:Name1>
<com:CountryCode>AT</com:CountryCode>
<com:ZIPCode>8970</com:ZIPCode>
<com:City>Wien</com:City>
<com:Street>Schiliftgasse</com:Street>
<com:StreetNumber>66</com:StreetNumber>
</com:Address>
</typ:Consignee>
<typ:Shipper>
<com:ContactID>2769995N0E</com:ContactID>
</typ:Shipper>
<typ:ShipmentUnit>
<typ:ShipmentUnitReference>Ref-Unit-0816</typ:ShipmentUnitReference>
<typ:Weight>11.00</typ:Weight>
</typ:ShipmentUnit>
<typ:Service>
<com:Service>
<com:ServiceName>service_1200</com:ServiceName>
</com:Service>
</typ:Service>
</typ:Shipment>
<typ:PrintingOptions>
<typ:UseDefault>Default</typ:UseDefault>
</typ:PrintingOptions>
</typ:ShipmentRequestData>

3) International parcels are marked with a leading "Global" - so either GlobalBusinessParcel or GlobalExpressParcel.

Request GlobalBusinessParcel

<typ:ShipmentRequestData>
<typ:Shipment>
<typ:IncotermCode>10</typ:IncotermCode>
<typ:Product>Parcel</typ:Product>
<typ:Consignee>
<com:Address>
<com:Name1>Caradas Burrowes</com:Name1>
<com:CountryCode>UY</com:CountryCode>
<com:ZIPCode>37006</com:ZIPCode>
<com:City>Tupambaé</com:City>
<com:Street>Treinta y Tres</com:Street>
<com:StreetNumber>7106</com:StreetNumber>
</com:Address>
</typ:Consignee>
<typ:Shipper>
<com:ContactID>2769111N0E</com:ContactID>
</typ:Shipper>
<typ:ShipmentUnit>
<typ:ShipmentUnitReference>Ref-Unit-0816</typ:ShipmentUnitReference>
<typ:Weight>23.2</typ:Weight>
</typ:ShipmentUnit>
</typ:Shipment>
<typ:PrintingOptions>
<typ:UseDefault>Default</typ:UseDefault>
</typ:PrintingOptions>
</typ:ShipmentRequestData>

Request GlobalExpressParcel

<typ:ShipmentRequestData>
<typ:Shipment>
<typ:IncotermCode>10</typ:IncotermCode>
<typ:Product>Express</typ:Product>
<typ:Consignee>
<com:Address>
<com:Name1>Caradas Burrowes</com:Name1>
<com:CountryCode>UY</com:CountryCode>
<com:ZIPCode>37006</com:ZIPCode>
<com:City>Tupambaé</com:City>
<com:Street>Treinta y Tres</com:Street>
<com:StreetNumber>7106</com:StreetNumber>
</com:Address>
</typ:Consignee>
<typ:Shipper>
<com:ContactID>2769995N0E</com:ContactID>
</typ:Shipper>
<typ:ShipmentUnit>
<typ:ShipmentUnitReference>Ref-Unit-016</typ:ShipmentUnitReference>
<typ:Weight>23.2</typ:Weight>
</typ:ShipmentUnit>
</typ:Shipment>
<typ:PrintingOptions>
<typ:UseDefault>Default</typ:UseDefault>
</typ:PrintingOptions>
</typ:ShipmentRequestData>

Printing options

The printing options give you several ways of dealing with the labels that you need to place on your parcels. In general you can choose between GLS ShipIT handling the printing (this option is not available if you are using GLS ShipIT hosted at GLS premises) or for GLS ShipIT to return the created labels. If you choose to retrieve the labels from GLS ShipIT, you can choose the format of the labels to match your printers. Thus when issuing the request, you have to define one of the following printing options:

  1. UseDefault
  2. DefinePrinter
  3. ReturnLabels

The PrintingOptions section is mandatory for all types of shipment creation webservice requests. This also includes services like Pick&Ship and Pick&Return, where no label data is returned.

If your are connecting to a centrally hosted GLS ShipIT, you can only use the option "ReturnLabels" as there will not be any printer installed within the centrally hosted GLS ShipIT (and you won't be able to retrieve the labels).

If you plan to use GLS ShipIT for printing your labels, please check the chapter "Druckerverwaltung" of the manual for information on how to configure printers in GLS ShipIT.

The option "UseDefault" should be considered when you are using GLS ShipIT with the Client or when you already configured your printers within your GLS ShipIT installation. By choosing that option, all documents are sent to the printers that are configured within GLS ShipIT. As the SOAP requests are being executed on the GLS ShipIT backend, only the configured backend printers are valid printers for this printing option.

The option "DefinePrinter" should be considered when you have printers configured within GLS ShipIT, but you want to print to different printers then the configured default printers of GLS ShipIT (e.g. you want to use a different printer when using the SOAP interface as when a user is creating parcels using the GLS ShipIT client application). With this option you have to provide the name of the printers that should be used for printing the labels and the accompanying documents. As the SOAP requests are being executed on the GLS ShipIT backend, only the configured backend printers are valid printers for this printing option.

The option "ReturnLabels" should be used when you cannot configure your printers in GLS ShipIT (e.g. the printer cannot be reached from the host which runs the GLS ShipIT backend). For this option you have to specify which type of printer you have. GLS ShipIT will return the labels for the desired type of printer. All other documents (e.g. additional documents for addon liability or ident service) will be returned as PDF document. If you do not have any of the supported label printers (or if your label printer is capable of printing PDF), you can specify PDF as the desired label format.

Here are some samples of the printing options you can use in your requests:

If you want to use GLS ShipIT for printing labels and documents:

<typ:PrintingOptions>
<typ:UseDefault>Default</typ:UseDefault>
</typ:PrintingOptions>

If you want to use dedicated printers configured in GLS ShipIT (but not the default printers):

<typ:PrintingOptions>
<typ:DefinePrinter>
<typ:LabelPrinter>ThermoI34</typ:LabelPrinter>
<typ:DocumentPrinter>\\Logistics\Laser</typ:DocumentPrinter>
</typ:DefinePrinter>
</typ:PrintingOptions>

If you want to print the labels on your thermal printer (in this case a Zebra with ZPL200):

<typ:PrintingOptions>
<typ:ReturnLabels>
<typ:TemplateSet>ZPL200</typ:TemplateSet>
<typ:LabelFormat>Zebra</typ:LabelFormat>
</typ:ReturnLabels>
</typ:PrintingOptions>

If you want to retrieve the labels as PDF documents:

<typ:PrintingOptions>
<typ:ReturnLabels>
<typ:TemplateSet>NONE</typ:TemplateSet>
<typ:LabelFormat>PDF</typ:LabelFormat>
</typ:ReturnLabels>
</typ:PrintingOptions>

If you want to retrieve the labels as PNG documents:

<typ:PrintingOptions>
<typ:ReturnLabels>
<typ:TemplateSet>NONE</typ:TemplateSet>
<typ:LabelFormat>PNG</typ:LabelFormat>
</typ:ReturnLabels>
</typ:PrintingOptions>

To reduce the amount of data in the response you can use the two options:

<typ:ReturnOptions>
<typ:ReturnPrintData>false</typ:ReturnPrintData>
<typ:ReturnRoutingInfo>true</typ:ReturnRoutingInfo>
</typ:ReturnOptions>

If you are working on our GLS-provided central webbackends, the options "UseDefault" and "DefinePrinter" are obsolete - please use "ReturnLabels" instead.


Name Expression in webservices Field length Type Format Mandatory/Optional Restrictions Level Description
Use default printer UseDefault 7 alphanumeric Default Optional Default fixed value Uses the preset standard printer
Define printer DefinePrinter Define configured printers for printing labels and shipment documents
Label printer LabelPrinter 255 alphanumeric Optional - Please define name of the label printer
Document printer DocumentPrinter 255 alphanumeric Optional - Please define name of the document printer
Define printer for return labels ReturnLabels Defines the data output formats.
Template name (basic) TemplateSet 7 alphanumeric Optional Must use one of the defined set NONE, ZPL200, ZPL300
Template name (barcoded ID) TemplateSet 7 alphanumeric Optional Must use one of the defined sets for ZEBRA only [Template name (basic)][Identifier: TRACKID or REFNO]_[Barcodetype: CODE39 or EAN_128] e.g. ZPL200TRACKID_CODE39
Printer label format LabelFormat 8 alphanumeric Optional Must use one of the defined set PDF, PNG, Zebra
Define returned data ReturnOptions Reduce the amount of data in response
Print Data ReturnPrintData 5 boolean Optional true or false Returns the printing information and data from response. Default:true
Routing Data ReturnRoutingInfo 5 boolean Optional true or false Returns all routing information. Default:true

Custom content

This section of the request contains several optional attributes when printing as PDF or PNG that can be found in the vertical area of the label. You do not need to fill any of them. If you however have the need of adding your own barcode or logo to the labels or if you want to suppress the shipper address on the labels, you can use this request section to steer this behaviour.

If you want to have a custom logo / image on the labels, fill the content of the element "CustomerLogo" with the binary data of the logo. The data must be Base64 encoded. The image formats jpg, gif and png are supported. Hint: The available character set of selected barcode type needs to be observed.

To print your logo on the label, use something like this:

<typ:CustomContent>
<typ:CustomerLogo>iVBORw0KGgoAAAANSUhEUgAAAGQAAAAbCAYAAACKlipAAAAKNklEQVRoge2abYicVxXHf/9lJiwhhCWEnRhC3AkhxhLSTSKp7zprX7Vq7Y5V8aWlIvhW8YV+aGvth6KlRangG4qlWKVonbW0VNC27hRfgmjdxhjbUENmDaF0hhhCCSFkhv374Xm7zzPPbJI21Q/tgWfnPveec8+5955z/+feZ8U50qDNGmCnYbHa4OC5yr9Ky5POlnHQZh3mOuAI4ueVBoOXz6xXLp1xQQbzrAK+jHit4ZZqg+f/B3a9SmU0aHN5f56n+vN84v9tyyuFSiNk0GYccydwMeKDlQZPnw9l/TafBWqJUhuUvgTWBOWkWNZsgopsNP+sNnjgTLbU6s2NmHeD32LYKmm9zQrwEui48HOGQ4J/IP0ZeLLbaQ0mp2YvFlyWqRTGCN3bXWwtO0+T9dktMk3D2wSbQROOjD+J6GEWKiWTtg6YMywh3lFtcPRMgzsb6rcZF9xps8rBbLrIaIYaDKBoASkphyT4BoxekFq9+UbDLbYvB7LxO7TEk4YtwDsdtZ1GvAY4Jula2x/LbHOi+J6ROqeaaxF32/6wY50eHuRGxIncggzabMA8BhyVeE+lwQujlJwryWxBrEojInTxcC5GhUPYTkld1sdTZfpr9dnVWN8CrheMZaE53HWRbA73Oq1j8eu0hmWPGx8q1TvV3GR4TLCpRK6gx/vSBRnMswbz23hw7z+fiwFgmE6dKfDwcP4N+UVSnidX7/gnvxhLwN6i7sn67AbQrxHbz2Bj6aJIUZ+T9eYqosgp8u7vdeZOD+ttjgMPCjaVbb0l9FQFYNBmDPMTxCbgTZUZjo2WeXEk2DFywIXfYsAQY024S43YsY5jFsOK2lRz0nbbsFlJZ9m+XwAycjMWNRnHUSe4ALPCyo/E9pATxPyfNmyPvE+5fon1m0y9pL1JhFyHuNLwzWpj2MPOB1nsTIxRbC0OJl9BfWRvjo+gLcUU8vXA/upMdj6q1ZsV7F8CmxUrT5YjkDuOvQfpkGAJeS1oC/Y2YDyaPC3EmqdByMK5ENbfiuOt1Ztj2J/KhuBsTLAP6TbgoKBivEnoIvCByqDNSpvbgdPA3Wea2BdD/TYVYFvO9Yto7nj7CdqGtrCYwi0vRxpyps8Db1fQgeK/kl8w3Crpx91O62Sxq1q9uVpwqe1rEfuiHrRLQ4YD5RGy1nBBGeQhfarbaf0lqNkL/AqggrlaYr1hT7XBcyUdv2SSmUJMhFbl8K24jy3XViIf+GrqqbV6c43NbcPKANOTuaS32No3yuZup/UC0IqfWM7Txb4MJ4UOFOWNNyQgXtxqBetH6a0gZmPml+1eyuII8LrQqKRM9D6G+QFiJqkIeZM5cMnIAOSUL/VUw/USE3HaihTjhhlYfKjbmRu5GGVUqzfHbS4o1gue7nZap0rHHWNHiH8x3VOrNwfdTuuRokwFszvGtqEzyfmiaoNTLLPg/TY3i3gxKAf1EPkTbEnxWCBzItExWZ8dw742YosanaV1D/Q6c0+c8yDszUKromKWLpoRgG4dRl6yGYvec7nkGsNDk1Oz90n6UrfTOp7IVQzrYrDZes5Gngfqt/kC5vYcXsRUBhO5RIBc+nyg0uBkVNZGYFsEpUUBvlfW7eTU7KWSGhlb7N1wT7fTOmhpGhs5mNYo8oYAHaC72Dpaq88+ITyT2Zgb0RhwHbC7Vm9e0e20DgNUpGgFgen+PFuqMzxbpuB8U7/NmOA24KtkNixPy52rzEJatHcrDp38McU90JOlXUufBK7JVAmic80PY9W7QvwITFlgJOlGiz8JxkcNx1Eq/WCt3nxTt9M6PYY5aoPNmOCOQfssJ+clUH+etYI5m68BYzap58e2RA/Ll3MywQld0lYYjjChA91Oa+gAF9P2ksTvKHAkfp0utEGUmY68v+p2WgvYHwCOl0Z7ai87MU2IwubJFDTF1Yabl5F9yTRoc43E322uSg0KfssSrmJ9sRy/ZxGCX5PyJXthtHKlB97aVHMlsJmUP+17f7fTGtTqzRXgbUm7M6Znu53WieXG21uc+w2wA/xoal/gRUGGcxnAGGIuzGSA2/vz3DOYZ/Vyis6V+m1m+m3+YPMLYH14yDPBGSSYYWXve4GFpC09GCqVPSWRpp4yK7LBZgcyw5pS48Q225Us7Bz/RIBtswFrbZr9WUm4ntUhuttpLfY6c5dhbhBeEiZLiCN9ttdDFCH3yxxJbFGk9HrDM4M2Xxy0mTgbpWU0aLO23+bTgzZ/w/wO89a0sexgSDaHqbnmceBdSfKRnnadew7l7t7EqdD9ksEL3jA51VxXYup2ScPRGQO2xE4nCULo1iMAfRR1F1vfBR4tG76kkwCVSoOTgzafEzwIcYoW8awH7jZ8vT/Po4LfGvYgDlbjbCakGHvWEoHUmy0uAd4sWBEPqmBA+FK0DoAlm29L3ASsVRBVRXk7D6w2/04PZfm7qpXYP63VZz/S7cwdDfh3RNE3BNp7Y4YdZbfDwPHJenNrtNjCMOh1Wgdr9WbFZqm32FoKmaN6ryve+kb3auyH+G6+0uDhQZubbO6QYpCN7ZNZabiK6EHm1KDN80CPKPdfgZjArDNMSFRSLw/uq1QoJzzF+tjCI4bPVGd4BGDQjgA1tCu8E1Pxyl36c+qBGZAkshcD/6rVm78HesC48eV5YwF4weYQgKXpcLNPMMTo3jjy4knVArALuFzydybrzT1E91X/AVYavxcxnZxjnA1kCXgoXZB4Ue7qtzkB3C2xIlFvZQ6saFLGBVPAlJVucbkJTSa5KF/IQVNKMIEoa/kR4rZqI7txNkwP+aeCuSvcYQn22BwWbEw2rWTS4tPFBOJ9tslvVBGXIqMP9BZbp2r15hgw7QTk4jGkchKObwJSTLF3gqaEp0K0CHU5XUgheDy528qluNUG37d5G7CQYFuKcck7QTlMQcnz5VLTEnnCMpzG3G+4sNLghkojf/0vsyu8TEzloz4HQO4apNtpDYRvDSTSCUinJ/HSAGdy7VnWtg6zLpOD5LNtxhptjYa/R51pR9CUwx5nkvGtvHvAZxJLh84c1Rn+AlyE+LjEXineul6OB54D7pJ4fXWGj1YbDF3Sxdg0PaoPxGE8/P2muzh3H+L7CphdKCt4nGRtSbvTbXAaMYaIoiDmS8pZvZC0L46o7SF/ooOUL6njOaErup1W+rWx9P4q/p+rn/XnuR+xG/MhiSttNiWLmPvqF5TDbalYrwioDwgeRTwE/DH8flFKZo1hY1zO6YjnY29lhqUR0jcYnhHcbpg4Ux4ROaxB2i/5ibhpmlG8+boB9tNIa4jtTT+CFfgNA+EHjL7S67Ry/1ZVmjqMokGbjcBuzIUWWxV9mJ8EVmPGYxwZGE4IjgHPA4cxzyD22yxUZ+i9CJ03BjlCuhgxPj1WafDwcn3U6s0JoGm4RLDNsF6wwrAk+7jRkfgc81dgvttpHQhkPwZclHYWZ235BTGgE8AtRPj6vciJvEZodexHxwTPAm3DA71Oq/SK6r/xTMgQxm7WOgAAAABJRU5ErkJggg==</typ:CustomerLogo>
</typ:CustomContent>

If you need an own barcode on the label there are two elements to support this. In the element "Barcode" you specify the data that should be printed as a barcode. In the element "BarcodeType" you can specify the barcode format that should be used. You can choose between the following barcode formats:

If you want to print a Code39 barcode on the label, you can define the elements like this:

<typ:CustomContent>
<typ:Barcode>0123456789</typ:Barcode>
<typ:BarcodeType>CODE_39</typ:BarcodeType>
</typ:CustomContent>

If you want to print the TrackID or ShipmentReference as barcode on the vertical area (in this case the TrackID as Code 39 printed on Zebra with ZPL200):

<typ:PrintingOptions>
<typ:ReturnLabels>
<typ:TemplateSet>ZPL200TRACKID_CODE39</typ:TemplateSet>
<typ:LabelFormat>Zebra</typ:LabelFormat>
</typ:ReturnLabels>
</typ:PrintingOptions>
<typ:CustomContent>
<typ:BarcodeContentType>TRACK_ID</typ:BarcodeContentType>
<typ:BarcodeType>CODE_39</typ:BarcodeType>
</typ:CustomContent>

If you want to hide the shipper address on the label you can define the elements like this:

<typ:CustomContent>
<typ:HideShipperAddress>true</typ:HideShipperAddress>
</typ:CustomContent>
Name Expression in webservices Field length Type Format Mandatory/Optional Restrictions Level Description
Customer logo CustomerLogo 255 base64Binary Optional - Custom content provided for label generation (f.e. customer logo)
Barcode Barcode 255 alphanumeric Optional - Barcode to create in the label
Barcode Content BarcodeContentType 7 alphanumeric Optional TRACK_ID or SHIPMENT_REFERENCE Creates the barcodes out of the TrackID or ShipmentReference
Barcode type BarcodeType 7 alphanumeric Optional EAN_128 or CODE_39 The type of barcode to create in the label
Hide shipper address HideShipperAddress 5 boolean Optional true or false Specify if the shipper address must be removed from the label

Input validation

Response

The SOAP response is an instance of eu.glsgroup.fpcs.datatypes.soap.v1.shipmentprocessing.CreatedShipment or one of the following faults:

Depending of multiple conditions the response can have different content/information:

ParcelData

Barcodes

The Barcodes section varies. The informations (as the NDI numbers or UniShip for example) are filled depending of origin, destination and used services:

<Barcodes>
<Primary2D>ADE 777DE 777abcdefghij2761234567YZ8YO14ZAA 3esa081538106 00560001001</Primary2D>
<Secondary2D>A|Max Mustermann|Falkenbergstrasse 47|Braunschweig|| Ref-Unit-0815| Ref-Ship-4711|</Secondary2D>
<Primary1D>200010111393</Primary1D>
<Primary1DPrint>true</Primary1DPrint>
</Barcodes>

RoutingInfo

The routing informations are returned in section RoutingInfo:

<RoutingInfo>
<Tour>0815</Tour>
<InboundSortingFlag>003</InboundSortingFlag>
<FinalLocationCode>DE 777</FinalLocationCode>
<HubLocation>esa</HubLocation>
<LastRoutingDate>2017-07-03</LastRoutingDate>
</RoutingInfo>

In some countries, different routings may apply as you can see for the German example below:

<RoutingInfo>
<GeoTour>0815</GeoTour>
<LoadingArea>7</LoadingArea>
<DispositionFlag>c</DispositionFlag>
<InboundSortingFlag>003</InboundSortingFlag>
<FinalLocationCode>DE 777</FinalLocationCode>
<HubLocation>esa</HubLocation>
<LastRoutingDate>2017-07-03</LastRoutingDate>
</RoutingInfo>

ServiceArea

When using a service, the SOAP response will list all used services with their service attributes:

<ServiceArea>
<Service>
<Header>DepositService</Header>
<Information>
<Name>Deposit Place</Name>
<Value>Under the doormat</Value>
</Information>
</Service>
</ServiceArea>

For product EXPRESS there is also a serviceArea entry:

<ServiceArea>
<Service>
<Header>ExpressParcel</Header>
</Service>
</ServiceArea>

ExpressData

In case of Express product the response contains additional express delivery/routing informations:

<ExpressData>
<AlternateDelivery>true</AlternateDelivery>
<ImportStation>1118</ImportStation>
<TourNumber>2228</TourNumber>
<CourierParcelNumber>820510120292</CourierParcelNumber>
</ExpressData>

ExpressArea

If the parcel is a Der Kurier parcel the Kurier1D, KurierTourNumber and KurierImportStation are given in the ExpressArea:

<ExpressArea>
<Kurier1D>820510120292</Kurier1D>
<KurierTourNumber>2228</KurierTourNumber>
<KurierImportStation>1118</KurierImportStation>
</ExpressArea>

NDIArea

For some destination countries there are NDI informations (NDI1D) returned. Parcels to Great Britain (GB) and to Switzerland (CH) have additional informations.

For parcels to Great Britain (GB) the GBProductIdentifier is filled with fixed value 24. The GB information GBPostOffice1D contains the zipcode (if longer than 4, the first 4 chars/digits only) surrounded by two asterisk (*):

<NDIArea>
<NDI1D>EH936454405GB</NDI1D>
<GBProductIdentifier>24</GBProductIdentifier>
<GBPostOffice1D>*NN15*</GBPostOffice1D>
</NDIArea>

For parcels to Switzerland (CH) the CHParcelNumber is filled with readable NDI number. The CH information CHPRI1D contains the fixed value 0509.

<NDIArea>
<NDI1D>994010486057566096</NDI1D>
<CHParcelNumber>99.40.104860.57566096</CHParcelNumber>
<CHPRI1D>0509</CHPRI1D>
</NDIArea>

HandlingInformation

There are some pre-defined shorthand symbols which are returned in HandlingInformation:

There are more shorthand symbols for various services which are returned if such a service is used. If there are more than one symbol for a parcel, those symbols are concatenated (separated by spaces).

Sample request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://fpcs.gls-group.eu/v1/ShipmentProcessing/types" xmlns:com="http://fpcs.gls-group.eu/v1/Common">
<soapenv:Header/>
<soapenv:Body>
<typ:ShipmentRequestData>
<typ:Shipment>
<typ:ShippingDate>2016-04-01</typ:ShippingDate>
<typ:Product>Parcel</typ:Product>
<typ:Consignee>
<com:ConsigneeID>DE00</com:ConsigneeID>
<com:Address>
<com:Name1>Max</com:Name1>
<com:CountryCode>DE</com:CountryCode>
<com:ZIPCode>38106</com:ZIPCode>
<com:City>Braunschweig</com:City>
<com:Street>Ringstrasse</com:Street>
</com:Address>
</typ:Consignee>
<typ:Shipper>
<com:ContactID>2761234567</com:ContactID>
</typ:Shipper>
<typ:ShipmentUnit>
<typ:Weight>23.2</typ:Weight>
</typ:ShipmentUnit>
<typ:Service>
<com:Service>
<com:ServiceName>service_flexdelivery</com:ServiceName>
</com:Service>
</typ:Service>
</typ:Shipment>
<typ:PrintingOptions>
<typ:UseDefault>Default</typ:UseDefault>
</typ:PrintingOptions>
</typ:ShipmentRequestData>
</soapenv:Body>
</soapenv:Envelope>

Sample response

If the request was successful:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
<soap:Body>
<CreateParcelsResponse xmlns="http://fpcs.gls-group.eu/v1/ShipmentProcessing/types" xmlns:ns2="http://fpcs.gls-group.eu/v1/Common">
<CreatedShipment>
<ParcelData>
<TrackID>YZ8YO12F</TrackID>
<Barcodes>
<Primary2D>ADE 777DE 777abcdefghij2761234567YZ8YO12FAAz 3esa081538106 02320001001</Primary2D>
<Secondary2D>A|Max|Ringstrasse|Braunschweig|| | |</Secondary2D>
<Primary1D>200010110471</Primary1D>
<Primary1DPrint>true</Primary1DPrint>
</Barcodes>
<RoutingInfo>
<Tour>0815</Tour>
<InboundSortingFlag>003</InboundSortingFlag>
<FinalLocationCode>DE 777</FinalLocationCode>
<HubLocation>esa</HubLocation>
<LastRoutingDate>2017-06-27</LastRoutingDate>
</RoutingInfo>
<ServiceArea>
<Service>
<Header>FlexDeliveryService</Header>
</Service>
</ServiceArea>
</ParcelData>
<CustomerID>abcdefghij</CustomerID>
<PickupLocation>DE 777</PickupLocation>
<GDPR>Informationen zum Datenschutz in der GLS-Gruppe finden Sie unter</GDPR>
<GDPR>gls-group.eu/dataprotection</GDPR>
</CreatedShipment>
</CreateParcelsResponse>
</soap:Body>
</soap:Envelope>

If the request was syntactically correct, but there where validation issues:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>Shipment validation failed</faultstring>
<detail>
<ns2:InvalidFieldValueFault xmlns="http://fpcs.gls-group.eu/v1/ShipmentProcessing/types" xmlns:ns2="http://fpcs.gls-group.eu/v1/Common">
<ns2:field>
<ns2:name>shipper.email</ns2:name>
<ns2:value>ADDRESS_VALID_EMAIL</ns2:value>
</ns2:field>
</ns2:InvalidFieldValueFault>
</detail>
</soap:Fault>
</soap:Body>
</soap:Envelope>

If you specified an invalid service (or a service that is not available to the shipper used in the request):

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>Article does not exist or is not available for shipper</faultstring>
<detail>
<ns2:InvalidFieldValueFault xmlns="http://fpcs.gls-group.eu/v1/ShipmentProcessing/types" xmlns:ns2="http://fpcs.gls-group.eu/v1/Common">
<ns2:field>
<ns2:name>Shipment.Service.ServiceName</ns2:name>
<ns2:value>service_iamnotvalid</ns2:value>
</ns2:field>
</ns2:InvalidFieldValueFault>
</detail>
</soap:Fault>
</soap:Body>
</soap:Envelope>

If a mandatory attribute was not set:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>PrintingOptions not defined</faultstring>
<detail>
<ns2:MandatoryFieldMissingFault xmlns="http://fpcs.gls-group.eu/v1/ShipmentProcessing/types" xmlns:ns2="http://fpcs.gls-group.eu/v1/Common">
<ns2:fieldname>
<ns2:name>ShipmentRequestData.PrintingOptions</ns2:name>
</ns2:fieldname>
</ns2:MandatoryFieldMissingFault>
</detail>
</soap:Fault>
</soap:Body>
</soap:Envelope>

cancelParcelById

This operation tries to cancel a previously created parcel. This operation is not guaranteed to succeed. If the parcel is already being processed, it cannot be cancelled anymore. The cancel operation itself is handled asynchronously in most cases. If the system is not connected to the central systems of GLS at the time of the issuing of the request, it will be retried at a later time. The SOAP service will not wait for the request to be executed, it will return after the request has been scheduled successfully. Return parcels can only be cancelled through your responsible depot. A webservice can be called but this does not have any operational impact.

Parameter Mandatory Description
trackID TRUE The track ID of the parcel that should be canceled.

Input validation

The soap request must contain the shipment unit's trackID as a java.lang.String

The soap response is an instance of eu.glsgroup.fpcs.datatypes.soap.v1.shipmentprocessing.CancelParcelResponse or one of the following soap faults:

Sample request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://fpcs.gls-group.eu/v1/ShipmentProcessing/types">
<soapenv:Header/>
<soapenv:Body>
<typ:TrackID>YZ8YPH2Q</typ:TrackID>
</soapenv:Body>
</soapenv:Envelope>

If the cancellation was successful:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
<soap:Body>
<CancelParcelResponse xmlns="http://fpcs.gls-group.eu/v1/ShipmentProcessing/types" xmlns:ns2="http://fpcs.gls-group.eu/v1/Common">
<TrackID>YZ8YPH2Q</TrackID>
<result>CANCELLED</result>
</CancelParcelResponse>
</soap:Body>
</soap:Envelope>

If the cancellation was successfully scheduled:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
<soap:Body>
<CancelParcelResponse xmlns="http://fpcs.gls-group.eu/v1/ShipmentProcessing/types" xmlns:ns2="http://fpcs.gls-group.eu/v1/Common">
<TrackID>YZ8YPH2Q</TrackID>
<result>CANCELLATION_PENDING</result>
</CancelParcelResponse>
</soap:Body>
</soap:Envelope>

Sample response

If the request was successful, but the parcel cannot be cancelled:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
<soap:Body>
<CancelParcelResponse xmlns="http://fpcs.gls-group.eu/v1/ShipmentProcessing/types" xmlns:ns2="http://fpcs.gls-group.eu/v1/Common">
<TrackID>YZ8YPH2Q</TrackID>
<result>SCANNED</result>
</CancelParcelResponse>
</soap:Body>
</soap:Envelope>

If a wrong TrackID has been transmitted:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>A parcel with the given ID does not exist</faultstring>
<detail>
<ns2:InvalidFieldValueFault xmlns="http://fpcs.gls-group.eu/v1/ShipmentProcessing/types" xmlns:ns2="http://fpcs.gls-group.eu/v1/Common">
<ns2:field>
<ns2:name>TrackID</ns2:name>
<ns2:value>zzZZzzZZ</ns2:value>
</ns2:field>
</ns2:InvalidFieldValueFault>
</detail>
</soap:Fault>
</soap:Body>
</soap:Envelope>

If a mandatory attribute was not provided (e.g. the TrackID):

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>Mandatory field is not set</faultstring>
<detail>
<ns2:MandatoryFieldMissingFault xmlns="http://fpcs.gls-group.eu/v1/ShipmentProcessing/types" xmlns:ns2="http://fpcs.gls-group.eu/v1/Common">
<ns2:fieldname>
<ns2:name>TrackID</ns2:name>
</ns2:fieldname>
</ns2:MandatoryFieldMissingFault>
</detail>
</soap:Fault>
</soap:Body>
</soap:Envelope>

If a shipper shall be used to which the user does not have access:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>access to shipper denied</faultstring>
<detail>
<ns2:InsufficientPermissionFault xmlns="http://fpcs.gls-group.eu/v1/ShipmentProcessing/types" xmlns:ns2="http://fpcs.gls-group.eu/v1/Common">
<ns2:customer>012345678912</ns2:customer>
<ns2:user>testuser</ns2:user>
</ns2:InsufficientPermissionFault>
</detail>
</soap:Fault>
</soap:Body>
</soap:Envelope>

getAllowedServices

This SOAP web service operation returns a list of services (product/articles) that can be used for a shipment from a specific source address to a specific destination address.

Parameter Mandatory Description
allowedServicesRequestParameter TRUE The eu.glsgroup.fpcs.datatypes.soap.v1.shipmentprocessing.AllowedServicesRequestParameter with the request parameters.

Input validation

In case that more than 1 ContactID is provided:

Response headers:
HTTP/1.1 400 Bad Request
message: Unmarshalling Error: cvc-complex-type.2.4.d: Invalid content was found starting with element 'typ:ContactID'. No child element is expected at this point.

The zip code must comply with zip code rules of the respective country.

The soap response is an instance of eu.glsgroup.fpcs.datatypes.soap.v1.shipmentprocessing.AllowedServicesResponse or one of the following soap faults:

Sample request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://fpcs.gls-group.eu/v1/ShipmentProcessing/types">
<soapenv:Header/>
<soapenv:Body>
<typ:AllowedServicesRequestParameter>
<typ:Source>
<typ:CountryCode>DE</typ:CountryCode>
<typ:ZIPCode>38106</typ:ZIPCode>
</typ:Source>
<typ:Destination>
<typ:CountryCode>DE</typ:CountryCode>
<typ:ZIPCode>65779</typ:ZIPCode>
</typ:Destination>
</typ:AllowedServicesRequestParameter>
</soapenv:Body>
</soapenv:Envelope>

It is possible to add a specific shipper as an optional parameter to the request above, in order to get the allowed services for that shipper only:

<typ:AllowedServicesRequestParameter>
<typ:Source>
...
</typ:Source>
<typ:Destination>
...
</typ:Destination>
<typ:ContactID>1234567890</typ:ContactID>
</typ:AllowedServicesRequestParameter>

Sample response

If the request was successful:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
<soap:Body>
<AllowedServicesResponse xmlns="http://fpcs.gls-group.eu/v1/ShipmentProcessing/types" xmlns:ns2="http://fpcs.gls-group.eu/v1/Common">
<AllowedServices>
<ProductName>Parcel</ProductName>
</AllowedServices>
<AllowedServices>
<ProductName>Express</ProductName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_cash</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_pickandship</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_pickandreturn</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_addonliability</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_deliveryatwork</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_deposit</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_hazardousgoods</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_exchange</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_saturday_1000</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_guaranteed24</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_shopreturn</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_0800</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_0900</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_1000</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_1200</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_intercompany</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_directshop</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_smsservice</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_ident</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_identpin</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_shopdelivery</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_preadvice</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_saturday_1200</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_Saturday</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_exworks</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_tyre</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_flexdelivery</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_pickpack</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_documentreturn</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_1300</ServiceName>
</AllowedServices>
<AllowedServices>
<ServiceName>service_addresseeonly</ServiceName>
</AllowedServices>
</AllowedServicesResponse>
</soap:Body>
</soap:Envelope>

If the request was syntactically incorrect:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>Mandatory field is not set</faultstring>
<detail>
<ns2:MandatoryFieldMissingFault xmlns="http://fpcs.gls-group.eu/v1/ShipmentProcessing/types" xmlns:ns2="http://fpcs.gls-group.eu/v1/Common">
<ns2:fieldname>
<ns2:name>source.ZIPCode</ns2:name>
</ns2:fieldname>
</ns2:MandatoryFieldMissingFault>
</detail>
</soap:Fault>
</soap:Body>
</soap:Envelope>

If an attribute had a wrong value (e.g. a invalid country code):

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>Mandatory field is not set or invalid</faultstring>
<detail>
<ns2:InvalidFieldValueFault xmlns="http://fpcs.gls-group.eu/v1/ShipmentProcessing/types" xmlns:ns2="http://fpcs.gls-group.eu/v1/Common">
<ns2:field>
<ns2:name>source.countryCode</ns2:name>
<ns2:value>XY</ns2:value>
</ns2:field>
</ns2:InvalidFieldValueFault>
</detail>
</soap:Fault>
</soap:Body>
</soap:Envelope>

getEndOfDayReport

Executes the end of day procedure for the given day and returns all shipments that where affected by the end of day procedure.

Parameter Mandatory Description
date TRUE Shipping or pick up day for which the end of day procedure should be executed

The end of day procedure does the following things:

The shipment units for which end of day will be performed is limited by the shipments to which the user issuing the request has access to. This means, it affects all shippers to which the user has access based on the roles assigned to him.

If you are connecting to a local installation of GLS ShipIT on your premises, you can configure the following actions to be done during end of day:

The operation takes a date as an input parameter.

Input validation

No input validation is to be done.

The soap response is an instance of eu.glsgroup.fpcs.datatypes.soap.v1.shipmentprocessing.EndOfDayResponse or one of the following soap faults:

Sample request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://fpcs.gls-group.eu/v1/ShipmentProcessing/types">
<soapenv:Header/>
<soapenv:Body>
<typ:EndOfDayDate>2017-06-28</typ:EndOfDayDate>
</soapenv:Body>
</soapenv:Envelope>

Sample response

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
<soap:Body>
<EndOfDayResponse xmlns="http://fpcs.gls-group.eu/v1/ShipmentProcessing/types" xmlns:ns2="http://fpcs.gls-group.eu/v1/Common">
<Shipments>
<ShippingDate>2017-06-28</ShippingDate>
<Product>Parcel</Product>
<Consignee>
<ns2:Address>
<ns2:Name1>Max</ns2:Name1>
<ns2:CountryCode>DE</ns2:CountryCode>
<ns2:ZIPCode>38106</ns2:ZIPCode>
<ns2:City>Braunschweig</ns2:City>
<ns2:Street>Ringstrasse</ns2:Street>
</ns2:Address>
</Consignee>
<Shipper>
<ns2:ContactID>2761234567</ns2:ContactID>
<ns2:AlternativeShipperAddress>
<ns2:Name1>Logistics and More</ns2:Name1>
<ns2:CountryCode>DE</ns2:CountryCode>
<ns2:ZIPCode>65760</ns2:ZIPCode>
<ns2:City>Eschborn</ns2:City>
<ns2:Street>Elly-Beinhorn-Strasse</ns2:Street>
<ns2:StreetNumber>1a</ns2:StreetNumber>
<ns2:eMail>logistics@more.test</ns2:eMail>
<ns2:FixedLinePhonenumber>004961961234567</ns2:FixedLinePhonenumber>
</ns2:AlternativeShipperAddress>
</Shipper>
<ShipmentUnit>
<Weight>23.2</Weight>
<TrackID>YZDLDM5J</TrackID>
<ParcelNumber>20281021031</ParcelNumber>
</ShipmentUnit>
</Shipments>
</EndOfDayResponse>
</soap:Body>
</soap:Envelope>

If shipments still need to be transmitted, but could not be transmitted:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>Transmission of one or more of the following shipment units not successful</faultstring>
<detail>
<ns2:CouldNotTransmitShipmentsFault xmlns="http://fpcs.gls-group.eu/v1/ShipmentProcessing/types" xmlns:ns2="http://fpcs.gls-group.eu/v1/Common">
<ns2:shipmentUnitId>XYZ00012</ns2:shipmentUnitId>
</ns2:CouldNotTransmitShipmentsFault>
</detail>
</soap:Fault>
</soap:Body>
</soap:Envelope>

updateParcelWeight

Updates the weight of a shipment unit. The shipment unit will be searched by its identifiers: TrackID, ParcelNumber, PartnerParcelNumber, ShipmentReference or ShipmentUnitReference.

Changes are only applied if the weight change is >0.2 kg.

Parameter Mandatory Description
updateParcelWeightRequestParameter TRUE The eu.glsgroup.fpcs.datatypes.soap.v1.shipmentprocessing.UpdateParcelWeightRequestParameter with the request parameters.

The search is restricted to the shippers to which the user issuing the request has access to.

Input validation

Name Expression in webservices Field length Type Format Mandatory/Optional Restrictions Level Description
Parcel identifier (alphanumeric) TrackID 40 alphanumeric Conditional - Main identifier of a parcel within GLS.
Parcel identifier (numeric) ParcelNumber - numeric Conditional - Either use 11 or 12 digit parcel no given at parcel creation.
Shipment reference number ShipmentReference 40 alphanumeric Conditional - Reference for this consignment of parcels.
Parcel reference ShipmentUnitReference 40 alphanumeric Conditional - Reference given to a single parcel.
Partner's parcel number PartnerParcelNumber 50 alphanumeric Conditional - Option for logistic partners to hand over their own reference.
Parcel Weight Weight 10 decimal Mandatory >0.10 Updated weight with at least 200g difference to original weight, max. 2 decimal digits.

The soap response is an instance of eu.glsgroup.fpcs.datatypes.soap.v1.shipmentprocessing.UpdateParcelWeightResponse or one of the following soap faults:

Sample request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://fpcs.gls-group.eu/v1/ShipmentProcessing/types">
<soapenv:Header/>
<soapenv:Body>
<typ:UpdateParcelWeightRequestParameter>
<typ:TrackID>ZDF8DOSZ</typ:TrackID>
<typ:ShipmentReference>567f2fb4-dd61-4aeb-9515-82f71b12c434</typ:ShipmentReference>
<typ:ShipmentUnitReference>0d5145f1-7ec5-4894-ae73-c590201c6c5d</typ:ShipmentUnitReference>
<typ:ParcelNumber>P3L11004PN0001</typ:ParcelNumber>
<typ:PartnerParcelNumber>P3L11004PPN0001</typ:PartnerParcelNumber>
<typ:Weight>17</typ:Weight>
</typ:UpdateParcelWeightRequestParameter>
</soapenv:Body>
</soapenv:Envelope>

Sample response

If the request was successful:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
<soap:Body>
<UpdateParcelWeightResponse xmlns="http://fpcs.gls-group.eu/v1/ShipmentProcessing/types" xmlns:ns2="http://fpcs.gls-group.eu/v1/Common">
<UpdatedWeight>17.0</UpdatedWeight>
</UpdateParcelWeightResponse>
</soap:Body>
</soap:Envelope>

If the request points to more than one shipment unit:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>More than one parcel was identified matching the input criteria. Please redefine criteria to narrow down to one parcel.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope>

If the shipment unit cannot be found by the provided reference numbers:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>No shipment unit found for parcel identifier(s) b1119328-584f-4745-9571-d716bbd37656</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope>

If the shipment unit cannot be found by the provided reference number on shipment unit level (no shipment reference number passed to the service):

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>No shipment unit found for parcel identifier(s) b1119328-584f-4745-9571-d716bbd37656</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope>

If a mandatory parameter is not provided:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>At least one parcel identifier is required.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope>

If an invalid value is provided (e.g. a too high weight):

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>Invalid field Weight. Value 40.0 is not a valid value. Max value is 25.0</faultstring>
<detail>
<ns2:InvalidFieldValueFault xmlns="http://fpcs.gls-group.eu/v1/ShipmentProcessing/types" xmlns:ns2="http://fpcs.gls-group.eu/v1/Common">
<ns2:field>
<ns2:name>Weight</ns2:name>
<ns2:value>40.0</ns2:value>
</ns2:field>
</ns2:InvalidFieldValueFault>
</detail>
</soap:Fault>
</soap:Body>
</soap:Envelope>

reprintParcel

This endpoint is reprinting the original label, cancelling the old one.

Parameter Mandatory Description
ReprintParcelRequestParameter TRUE The eu.glsgroup.fpcs.datatypes.soap.v1.shipmentprocessing.ReprintParcelRequestParameter with the request parameters.

The parts of the request are explained in the following sections in more detail:

Input validation

Name Expression in webservices Field length Type Format Mandatory/Optional Restrictions Level Description
Track identifier TrackID 40 alphanumeric Optional - Identifier for the parcel. Used for a reprintParcel request
1D barcode number ParcelNumber - alphanumeric Optional - 1D barcode printed in the label
Customer reference number ShipmentReference 40 alphanumeric Optional - Reference for this consignment of parcels
Parcel reference ShipmentUnitReference 40 alphanumeric Optional - Reference given to the parcel
Network partner's reference PartnerParcelNumber 50 alphanumeric Optional - Option for network partners to hand over their own reference
Creation date CreationDate 10 alphanumeric YYYY-MM-DD Optional - Date when the parcel was created

The soap response is an instance of eu.glsgroup.fpcs.datatypes.soap.v1.shipmentprocessing.ReprintParcelResponse or one of the following soap faults:

Sample request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://fpcs.gls-group.eu/v1/ShipmentProcessing/types" xmlns:com="http://fpcs.gls-group.eu/v1/Common">
<soapenv:Header/>
<soapenv:Body>
<typ:ReprintParcelRequestParameter>
<typ:ParcelNumber>200010482493</typ:ParcelNumber>
<typ:CreationDate>2023-06-05</typ:CreationDate>
<typ:PrintingOptions>
<typ:ReturnLabels>
<typ:TemplateSet>NONE</typ:TemplateSet>
<typ:LabelFormat>PDF</typ:LabelFormat>
</typ:ReturnLabels>
</typ:PrintingOptions>
</typ:ReprintParcelRequestParameter>
</soapenv:Body>
</soapenv:Envelope>

Sample response

If the request was successful:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ReprintParcelResponse xmlns="http://fpcs.gls-group.eu/v1/ShipmentProcessing/types" xmlns:ns2="http://fpcs.gls-group.eu/v1/Common">
<CreatedShipment>
<ParcelData>
<TrackID>YZ8YOTRT</TrackID>
<ParcelNumber>311101593504</ParcelNumber>
<Barcodes>
<Primary2D>ADE 414 abcdefghij276TEST YZ8YOTRTAA 1 082110243 01640003001</Primary2D>
<Secondary2D>A|Fine|Langestr.|Berlin|86||ShipRefNo Of -62|</Secondary2D>
<Primary1D>311101593504</Primary1D>
<Primary1DPrint>true</Primary1DPrint>
</Barcodes>
<RoutingInfo>
<Tour>0821</Tour>
<InboundSortingFlag>10</InboundSortingFlag>
<FinalLocationCode>DE 101</FinalLocationCode>
<HubLocation>R53</HubLocation>
<LastRoutingDate>1970-01-01</LastRoutingDate>
</RoutingInfo>
</ParcelData>
<PrintData>
<Data>JVBERi0xLjUKJeLjz9MKNSAwIG9iago8PC9TdWJ0eXBlL0Zvcm0vRmlsdGVyL0Rgo=</Data>
<LabelFormat>PDF</LabelFormat>
</PrintData>
<CustomerID>abcdefghij</CustomerID>
<PickupLocation>DE 414</PickupLocation>
<GDPR>Informationen zum Datenschutz in der GLS-Gruppe finden Sie unter</GDPR>
<GDPR>gls-group.eu/dataprotection</GDPR>
</CreatedShipment>
</ReprintParcelResponse>
</soap:Body>
</soap:Envelope>

If the request points to more than one shipment unit (specifying a date may narrow the search):

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>More than one parcel was identified matching the input criteria. Please redefine criteria to narrow down to one parcel.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope>

If the shipment unit cannot be found by the provided parcel identifier:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>No shipment unit found for TrackID YZ8YOZEH1</faultstring>
<detail>
<InvalidShipmentIDFault xmlns="http://fpcs.gls-group.eu/v1/ShipmentProcessing/types" xmlns:ns2="http://fpcs.gls-group.eu/v1/Common">
<ShipmentID>YZ8YOZEH1</ShipmentID>
</InvalidShipmentIDFault>
</detail>
</soap:Fault>
</soap:Body>
</soap:Envelope>

If no parcel identifier parameter is provided:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>The Mandatory parameter to identify the parcel is not set</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope>
Generated on Wed Sep 25 2024 14:56:51 for GLS ShipIT by   doxygen 1.8.13