Track&Trace SOAP¶

Basics¶

Track&Trace¶

The shipment tracking is possible with the GLS parcel number or the consignor's own reference number.

The different methods are described in this documentation.

Web Service¶

GLS follows the SOAP protocol version 1.1. The basic communication is done over HTTP or HTTPS. The different methods of querying the status of a shipment are provided as WSDL (Web Services Description Language) file.

Methods¶

Overall there are three methods for determining the status of a shipment.

The two parameters username and password are mandatory. In the returned string the elements ErrorCode and ErrorDscr are indicators for the successful transmission of the web service stream or giving back information about a possible error.

This is how a positive response stream looks like:

[...]
  <ErrorCode>0</ErrorCode>
  <ErrorDscr>OK</ErrorDscr>
[...]

An error message, e.g. wrong login, might look like this:

[...]
  <ErrorCode>502</ErrorCode>
  <ErrorDscr>Authentication Error</ErrorDscr>
[...]

A complete list of all (error) codes can be found further down in this documentation.

GetTuDetail¶

This method delivers detailed information of a shipment based on the GLS parcel number RefValue without the check digit.

With the parameters ParamCode (LangCode) and ParamValue the language of the search results can be switched (DE = german, EN = english).

GetTuDetail Request Structure¶

A typical web service string is structured as follows, ? is the placeholder of the committed value:

GetTuDetail Request Example¶

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:trac="http://gls-group.eu/Tracking/">
  <soapenv:Header/>
  <soapenv:Body>
    <trac:TuDetailsRequest>
      <trac:RefValue>55123456789</trac:RefValue>
      <trac:Credentials>
        <trac:UserName>2760123456</trac:UserName>
        <trac:Password>Rght355Xh</trac:Password>
      </trac:Credentials>
      <!--Zero or more repetitions:-->
      <trac:Parameters>
        <trac:ParamCode>LangCode</trac:ParamCode>
        <trac:ParamValue>EN</trac:ParamValue>
      </trac:Parameters>
    </trac:TuDetailsRequest>
  </soapenv:Body>
</soapenv:Envelope>

GetTuDetail Response Parameters¶

For reasons of clarity the most important parameters of the answering stream are described only. Generally speaking the rest of the parameters are self-explanatory.

Summary:

• Search on the basis of the GLS parcel number without check digit (eleven-digit)
• The full details of a shipment are shown

GetTuList¶

This method delivers back information about parcels of a defined period DateFrom – DateTo. It includes the latest status of the parcels in the GLS network.

The parameter RefValue makes it possible to search also based on the GLS parcel number (without check digit). With the parameter CustomRef a search on the basis of the customer's own reference number is possible.

GetTuList Request Structure¶

A typical web service string is structured as follows, ? is the placeholder of the committed value:

GetTuList Request Example¶

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:trac="http://gls-group.eu/Tracking/">
  <soapenv:Header/>
  <soapenv:Body>
    <trac:TuListRequest>
      <trac:DateFrom>
        <trac:Year>2012</trac:Year>
        <trac:Month>2</trac:Month>
        <trac:Day>22</trac:Day>
        <trac:Hour>0</trac:Hour>
        <trac:Minut>0</trac:Minut>
      </trac:DateFrom>
      <trac:DateTo>
        <trac:Year>2012</trac:Year>
        <trac:Month>2</trac:Month>
        <trac:Day>22</trac:Day>
        <trac:Hour>23</trac:Hour>
        <trac:Minut>30</trac:Minut>
      </trac:DateTo>
      <trac:Credentials>
        <trac:UserName>2760123456</trac:UserName>
        <trac:Password>Rght355Xh</trac:Password>
      </trac:Credentials>
      <trac:Parameters>
        <trac:ParamCode>LangCode</trac:ParamCode>
        <trac:ParamValue>EN</trac:ParamValue>
      </trac:Parameters>
    </trac:TuListRequest>
  </soapenv:Body>
</soapenv:Envelope>

GetTuList Response Parameters¶

For reasons of clarity the most important parameters of the answering stream are described only. Generally speaking the rest of the parameters are self-explanatory.

Summary:

• Search for parcel(s) in a defined time period
• Search based on the GLS parcel number without check digit (eleven-digit)
• Search based on the customer's own reference number

GetTuPOD*¶

This method returns an encoded picture of the "proof of delivery", i.e. the signature of the consignee.

*Please note: due to legal restrictions this method is not available in all GLS countries (e.g. France).

GetTuPOD Request Structure¶

A typical web service string is structured as follows, ? is the placeholder of the committed value:

GetTuPOD Response Parameters¶

For reasons of clarity the most important parameters of the answering stream are described only. Generally speaking the rest of the parameters are self-explanatory.

Summary:

• Returns the signature of the consignee

Error codes & description¶

Overview¶

With the elements ErrorCode and ErrorDscr the web service is returning possible error messages to the ERP system of the consignor.

Codes¶