Track your parcels

Table of Contents

• Accessing the REST service
• Available REST service operations
  • findParcels (F-111)
    • Input validation
    • Sample request
  • getParcelDetailsByID (F-112)
    • Input validation
    • Sample request
    • Sample response
  • getParcelPODByID (F-113)
    • Input validation
    • Sample request
    • Sample response

Accessing the REST 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/TrackingService/TrackingPortType?wsdl

This service is about tracking parcels (retrieving information about the current status as well as retrieving a proof of delivery).

If the user is authenticated successfully the actual backend state is requested from datahub. If the backend is active in datahub, the backend state in backend database is set to active and the request is executed, else the backend state in backend database is set to inactive and a response with HTTP status 490 is returned.

Available REST service operations

findParcels (F-111)

This operations searches for parcels. Several parameters can be passed to the service. The search returns all parcels that match the search criteria (and to which the user issuing the request has access to). Partial matches or wildcard matches are not supported. The DateFrom and DateTo each include the specified day. That means searching DateFrom to '2017-02-07' and DateTo to '2017-02-07' finds all parcels created during that day.

Please consider: Only parcels that went through Use case description: getEndOfDayReport (F-118) are being found by the tracking service.

The REST method is available at sub-path /parcels with http request method POST

Parameter	Mandatory	Location in Request	Description
tulReferenceData	TRUE	request body	The eu.glsgroup.fpcs.datatypes.soap.v1.tracking.TULReferenceData with the request parameters.

Input validation

There is no special input validation for this service.

The REST response is an instance of eu.glsgroup.fpcs.datatypes.soap.v1.tracking.TUListResponse or one of the following faults:

• eu.gls_group.fpcs.v1.tracking.InvalidFieldValueMessage

To retrieve all parcels created between 7th and 8th February, you could issue a request as follows:

Sample request

POST https://localhost:8443/backend/rs/tracking/parcels
 
POST data:
{
    "DateFrom": "2016-02-07",
    "DateTo": "2016-02-08"
}

If the request was successful:

{
    "UnitItems": [{
            "TrackID": "P3L11002",
            "ShipmentReference": "abdeckjdefsss012",
            "ShipmentUnitReference": "RefTwo",
            "InitialDate": "2016-02-07T13:17:15+01:00",
            "Status": "DELIVERED"
        }
    ]
}

If the request was successful (but no result was found):

{}

If a mandatory parameter is not provided, a HTTP response with error code '400 Bad Request' is returned:

Response headers:
HTTP/1.1 400 Bad Request
message: The Mandatory parameter TULReferenceData.DateTo is not set
error: MANDATORY_PARAMETER_NOT_SET
Content-Length: 0
args: ["TULReferenceData.DateTo"]

If DateFrom is after DateTo, a HTTP response with error code '400 Bad Request' is returned:

Response headers:
HTTP/1.1 400 Bad Request
message: Invalid field DateTo. Value 2017-02-17 is not a valid value. DateTo must be after DateFrom
error: INVALID_FIELD_VALUE
Content-Length: 0
args: ["DateTo","2017-02-17","DateTo must be after DateFrom"]

getParcelDetailsByID (F-112)

Retrieves the detailed Track&Trace information (including the transport history) for a specific shipment unit identified by it’s track ID. If the parcel has been delivered, the delivery date and the signature will be set.

The REST method is available at sub-path /parceldetails with http request method POST

Parameter	Mandatory	Location in Request	Description
detailsReferenceData	TRUE	request body	The eu.glsgroup.fpcs.datatypes.soap.v1.tracking.DetailsReferenceData with the request parameters.

Input validation

• The parcel referenced by the reference number must exist and be accessible for the user issuing the request

The REST response is an instance of eu.glsgroup.fpcs.datatypes.soap.v1.tracking.ParcelDetailResponse or one of the following faults:

• eu.gls_group.fpcs.v1.tracking.InvalidFieldValueMessage

Sample request

POST https://localhost:8443/backend/rs/tracking/parceldetails
 
POST data:
{
"TrackID" : "YZ8YO11K"
}

Sample response

If the request was successful:

{
    "UnitDetail": {
        "TrackID": "YZ8YO11K",
        "Weight": "23.2",
        "Product": "PARCEL",
        "Consignee": {
            "Address": {
                "Name1": "Max",
                "CountryCode": "DE",
                "ZIPCode": "38106",
                "City": "Braunschweig",
                "Street": "Ringstrasse",
                "eMail": null
            }
        },
        "Shipper": {
            "ContactID": "2761234567",
            "AlternativeShipperAddress": {
                "Name1": "Public WS/RS Doc Shipper",
                "Name2": "Docu",
                "Name3": "Mentation",
                "CountryCode": "DE",
                "ZIPCode": "65760",
                "City": "Eschborn",
                "Street": "Mergenthalerallee",
                "StreetNumber": "77",
                "eMail": "fpcs.docu@syrocon.de",
                "FixedLinePhonenumber": "0172321321",
                "MobilePhoneNumber": "0172123123"
            }
        }
    }
}

If the parcel does not exist / is not accessible:

Response headers:
HTTP/1.1 400 Bad Request
message: Invalid field DetailsReferenceData.TrackID. Value YZ8YNSJP is not a valid value. Invalid field DetailsReferenceData.TrackID. Value YZ8YNSJP is not a valid value
error: INVALID_FIELD_VALUE
Content-Length: 0
args: ["DetailsReferenceData.TrackID","YZ8YNSJP","Invalid field DetailsReferenceData.TrackID. Value YZ8YNSJP is not a valid value"]

getParcelPODByID (F-113)

Retrieves the proof of delivery document for a parcel. The parcel is identified by its track ID.

The REST method is available at sub-path /parcelpod with http request method POST

Parameter	Mandatory	Location in Request	Description
tupReferenceData	TRUE	request body	The eu.glsgroup.fpcs.datatypes.soap.v1.tracking.TUPReferenceData with the request parameters.

Input validation

• The parcel referenced by the given Track ID must exist and be visible for the user (must have been created for a shipper to which the user that is issuing the request has access to)

The rest response is an instance of eu.glsgroup.fpcs.datatypes.soap.v1.tracking.PODResponse or one of the following rest faults:

• eu.gls_group.fpcs.v1.tracking.InvalidFieldValueMessage

Sample request

POST https://localhost:8443/backend/rs/tracking/parcelpod
 
POST data:
{
"TrackID" : "P3L11002"
}

Sample response

If the request was successful (ImageData is shortened. Here a Base64 encoded byte[] will be returned):

{
    "PODItem": {
        "TrackID": "P3L11002",
        "ImageData": "JVBERi0xLjQKJfbk/N8...kKJSVFT0YK"
    }
}

If no signature is available / the parcel is in the wrong state:

Response headers:
HTTP/1.1 400 Bad Request
message: Invalid field TUPReferenceData.TrackID. Value P3L11001 is not a valid value. POD cannot be generated, the parcel is in the wrong state.
error: INVALID_FIELD_VALUE
Content-Length: 0
args: ["TUPReferenceData.TrackID","P3L11001","POD cannot be generated, the parcel is in the wrong state."]