Developer - Shipment Tracking

Shipment Tracking

With this tracking API you can easily retrieve the status of your air freight shipment. The API provides you maximum shipment transparency and reliability. Just track your shipment with the AWB number. The information given via this API is the same that is publically available in the LH Cargo Tracking ePortal on our homepage.

Developer - shipment tracking - request uri

Request URI

GET https://api.lhcargo.com/shipment/tracking?aWBPrefix={aWBPrefix}&aWBNumber={aWBNumber}
Variable Description Format
{aWBPrefix} Represents the airline that is the owner of this AWB, i.e. "020" = Lufthansa Cargo 3-digit : [0-9]{3} e.g. 020.
{aWBNumber} The Air Waybill Number (AWB) 8-digit [0-9]{8} e.g. 08002050

Developer - shipment tracking - request examples

Request Example

GET https://api.lhcargo.com/shipment/tracking?aWBPrefix=020&aWBNumber=08002050

Developer - shipment tracking - response structure

Response Structure

.shipment

 

..shipmentId

 

...carrierNumericCode

Represents the airline that is the owner of this AWB, i.e. "020" = Lufthansa Cargo

...aWBNumber

The Air Waybill Number

Value must match the following pattern: [0-9]{8}

...isAWBNoCheckDigitUsed

Indicates whether the AWB number (aWBNumber) fulfils the Mod7 requirement and thus is a valid number (not a test number). In this case the value will always be "true"

...aWBSequenceNumber

Indicates how often the same AWB number (aWBnumber) has been re-used for a shipment. The value will be greater than or equal to 0 and less than or equal to 999

..awbIssueStation

The station that issued the AWB

.status

This is the actual status of the shipment.

Can be: BKD (confirmed booking, no other handling status reached yet), RCS (shipment physically received from shipper/agent), MAN (shipment manifested on flight), DEP (shipment departed on flight), ARR (shipment arrived from flight), RCF (shipment physically received from flight), NFD (agent/consignee informed of shipment arrival), DLV (shipment delivered to agent/consignee), DDL (shipment delivered to the consignee’s door), RCT (shipment received from another airline), TFD (shipment transferred to another airline), DIS (discrepancy: offload, shortshipped, missing cargo or found cargo)

.milestonePlan

Group element that contains different milestone types (RCS, MAN, DEP, …) with station of milestone, planned time etc. see below

..version

Version number of the milestone plan, starts with 0, will be incremented by 1

..milestones

Group element with list of the milestones

...milestone []

Group element with information of the milestone

.....type

Type of the milestone. Can be:

RCS (shipment physically received from shipper/agent), MAN (shipment manifested on flight), DEP (shipment departed on flight), ARR (shipment arrived on flight), RCF (shipment physically received from flight), NFD (agent/consignee informed of shipment arrival), DLV (shipment delivered to agent/consignee)

.....station

Station of the milestone

.....plannedTime

Planned time of the milestone in local time

.....actualTime

Actual time of the milestone in local time

.....plannedTotals

Group element with planned number of pieces and planned weight for the milestone

......noOfPieces

Planned number of pieces of the milestone

......weight

Planned weight of the milestone.

The number of digits to the right of the decimal point will be less than or equal to 3.

The value will be greater than or equal to 0.000.

The value will be less than or equal to 9999999.999

.....actualTotals

Group element with actual number of pieces and actual weight for the milestone

......noOfPieces

Actual number of pieces of the milestone. If no actuals have been received yet it will be "0"

......weight

Actual weight of the milestone

The number of digits to the right of the decimal point must be less than or equal to 3.

The value must be greater than or equal to 0.000.

The value must be less than or equal to 9999999.99999.

If no actuals have been received yet it will be "0.0"

.....flight

Group element with flight information

......flightCarrierCode

The two or three alphanumeric code for the particular airline, i.e. "LH" for Lufthansa

......flightNumber

Flight number

......flightDate

Flight date

......flightSegmentOrigin

Three letter code for a station e.g. FRA, HAM, SFO

......flightSegmentDestination

Three letter code for a station e.g. FRA, HAM, SFO

.....events

Group element with events for this milestone

......event

Group element with all actual events that are connected to this milestone

.......type

Three letter code event type.

Can be: RCS (shipment physically received from shipper/agent), MAN (shipment manifested on flight), DEP (shipment departed on flight), ARR (shipment arrived on flight), RCF (shipment physically received from flight), NFD (agent/consignee informed of shipment arrival), DLV (shipment delivered to agent/consignee)

.......station

Station of the event

.......plannedTime

Planned time of the event (=planned time of the milestone) in local time

.......actualTime

Actual time of the event in local time

.......actualTotals

Group element with actual values of the event (no. of pieces, weight)

........noOfPieces

Actual number of pieces of the event; if no actuals have been received yet it will be "0"

........weight

"Actual weight of the event.

The number of digits to the right of the decimal point must be less than or equal to 3.

The value must be greater than or equal to 0.000.

The value must be less than or equal to 9999999.99999.

If no actuals have been received yet it will be "0.0"

.......category

"F" means "flight specific event" (MAN, DEP, ARR, RCF),

"S" means "station specific event" (RCS, NFD, DLV)

.booking

Group element with information of the booking

..product

Group element with information of the product

...productName

Lufthansa Cargo product name. Can be e.g. td.Flash, td.Pro

...productConditions

Group element with information on the product conditions

....sPLList

Group element with special handling codes

.....splCode []

SPLs represent the special handling codes defined for a shipment. SPLs depend on the product code and the goods information for a shipment.

Length of value must be equal to 3

..totals

Group element with information in the booked pieces and weight for the complete shipment

...noOfPieces

Number of booked pieces of the complete shipment

...weight

Booked weight of the complete shipment.

The number of digits to the right of the decimal point must be less than or equal to 3.

The value must be greater than or equal to 0.000.

The value must be less than or equal to 9999999.999

..originalTimeFrame

Group element that gives LAT (Latest Acceptance Time) and TOA (Time of Availability) of the latest rebooking

...lAT

LAT (Latest Acceptance Time, i.e. the time when the shipper/ agents needs to deliver the shipment latest at the export station) of the latest rebooking

...tOA

TOA (Time of Availability, i.e the time when the shipment will be available for pick-up of the consignee) of the latest rebooking

..origin

Origin station of the booking

..destination

Destination station of the booking

..bookingTime

Time of the latest booking/rebooking in local time of the station of the booking

..isSplitBooking

Indicates whether the booking is a split booking according to the transport plan or not

..confirmationStatus

Indicates whether the whole booking is confirmed or not.

Allowed values are: KK (confirmed), FC (confirmed), QU (pending), UU (rejected), XX (deleted)

.events

Group element with all events for this shipment so far actually performed. The latest event is displayed first

..event []

Group element with information of one event

....type

Three letter code event type.

Can be: BKD (confirmed booking, no other handling status reached yet), RCS (shipment physically received from shipper/ agent), MAN (shipment manifested on flight), DEP (shipment departed on flight), ARR (shipment arrived from flight), RCF (shipment physically received from flight), NFD (agent/consignee informed of shipment arrival), DLV (shipment delivered to agent/ consignee), DDL (shipment delivered to the consignee’s door), RCT (shipment received from another airline), TFD (shipment transferred to another airline), DIS (Type of discrepency see in "classifier")

....station

Station of the event

....actualTime

Actual time of the event in local time of the "station".

If type = "BKD", then it is the time of the latest booking/rebooking before GAC.

....actualTotals

Group element with piece and weight information

.....noOfPieces

Actual number of pieces of this event

.....weight

Actual weight of this event.

The number of digits to the right of the decimal point must be less than or equal to 3.

The value must be greater than or equal to 0.000.

The value must be less than or equal to 9999999.999

....category

"F" means "flight specific event" (MAN, DEP, ARR, RCF),

"S" means "station specific event" (RCS, NFD, DLV)

.efreightDetailsGroup element of the status (plural) eFreight. Normally it is only one status
..preCheckStatus 
...preCheckStatusCode

"S" means "Success"

"F" means "Failed"

"P" means "Pending"

"H" means "On hold"

...preCheckStatusDescriptionDescription of the status
...preCheckTimeLocal timestamp of preCheckStatus validation
...precheckTimeUTCUTC timestamp of preCheckStatus validation

.shipmentStatusEvents

Group element of the status (plural) of the shipment. Normally it is only one status

..event

Group element of one of the status of the event

...category

"F" means "flight specific event" (MAN, DEP, ARR, RCF)

"S" means "station specific event" (RCS, NFD, DLV)

...type

Three letter code event type

Can be: BKD (confirmed booking, no other handling status reached yet), RCS (shipment physically received from shipper/ agent), MAN (shipment manifested on flight), DEP (shipment departed on flight), ARR (shipment arrived from flight), RCF (shipment physically received from flight), NFD (agent/consignee informed of shipment arrival), DLV (shipment delivered to agent/ consignee), DDL (shipment delivered to the consignee’s door), RCT (shipment received from another airline), TFD (shipment transferred to another airline), DIS (Type of discrepancy see in "classifier")

...station

Station of the event

Developer - shipment tracking - response example

Response Example

{
  "shipment": {
    "shipmentId": {
      "carrierNumericCode": "020",
      "aWBNumber": "08002050",
      "isAWBNoCheckDigitUsed": "true",
      "aWBSequenceNumber": 1.0
    },
    "awbIssueStation": "FRA"
  },
  "status": "MAN",
  "milestonePlan": {
    "version": 0,
    "milestones": {
      "milestone": [
        {
          "type": "RCS",
          "station": "FRA",
          "plannedTime": "2017-07-17T21:00:00Z",
          "actualTime": "2017-07-17T14:20:00Z",
          "plannedTotals": {
            "noOfPieces": 10,
            "weight": 100
          },
          "actualTotals": {
            "noOfPieces": 10,
            "weight": 100
          },
          "flight": {
            "flightCarrierCode": "LH",
            "flightNumber": "8170",
            "flightDate": "2017-07-19",
            "flightSegmentOrigin": "FRA",
            "flightSegmentDestination": "JFK"
          },
          "events": {
            "event": {
              "type": "RCS",
              "station": "FRA",
              "plannedTime": "2017-07-17T21:00:00Z",
              "actualTime": "2017-07-17T14:20:00Z",
              "actualTotals": {
                "noOfPieces": 10,
                "weight": 100
              },
              "category": "S"
            }
          }
        },
        {
          "type": "MAN",
          "station": "FRA",
          "plannedTime": "2017-07-19T08:00:00Z",
          "actualTime": "2017-07-19T08:10:00Z",
          "plannedTotals": {
            "noOfPieces": 10,
            "weight": 100
          },
          "actualTotals": {
            "noOfPieces": 10,
            "weight": 100
          },
          "flight": {
            "flightCarrierCode": "LH",
            "flightNumber": "8170",
            "flightDate": "2017-07-19",
            "flightSegmentOrigin": "FRA",
            "flightSegmentDestination": "JFK"
          },
          "events": {
            "event": {
              "type": "MAN",
              "station": "FRA",
              "plannedTime": "2017-07-19T08:00:00Z",
              "actualTime": "2017-07-19T08:10:00Z",
              "actualTotals": {
                "noOfPieces": 10,
                "weight": 100
              },
              "category": "F"
            }
          }
        },
        {
          "type": "DEP",
          "station": "FRA",
          "plannedTime": "2017-07-19T09:35:00Z",
          "plannedTotals": {
            "noOfPieces": 10,
            "weight": 100
          },
          "actualTotals": {
            "noOfPieces": 0,
            "weight": 0
          },
          "flight": {
            "flightCarrierCode": "LH",
            "flightNumber": "8170",
            "flightDate": "2017-07-19",
            "flightSegmentOrigin": "FRA",
            "flightSegmentDestination": "JFK"
          },
          "events": ""
        },
        {
          "type": "ARR",
          "station": "JFK",
          "plannedTime": "2017-07-19T17:35:00Z",
          "plannedTotals": {
            "noOfPieces": 10,
            "weight": 100
          },
          "actualTotals": {
            "noOfPieces": 0,
            "weight": 0
          },
          "flight": {
            "flightCarrierCode": "LH",
            "flightNumber": "8170",
            "flightDate": "2017-07-19",
            "flightSegmentOrigin": "FRA",
            "flightSegmentDestination": "JFK"
          },
          "events": ""
        },
        {
          "type": "RCF",
          "station": "JFK",
          "plannedTime": "2017-07-19T23:00:00Z",
          "plannedTotals": {
            "noOfPieces": 10,
            "weight": 100
          },
          "actualTotals": {
            "noOfPieces": 0,
            "weight": 0
          },
          "flight": {
            "flightCarrierCode": "LH",
            "flightNumber": "8170",
            "flightDate": "2017-07-19",
            "flightSegmentOrigin": "FRA",
            "flightSegmentDestination": "JFK"
          },
          "events": ""
        },
        {
          "type": "NFD",
          "station": "JFK",
          "plannedTime": "2017-07-20T01:00:00Z",
          "plannedTotals": {
            "noOfPieces": 10,
            "weight": 100
          },
          "actualTotals": {
            "noOfPieces": 0,
            "weight": 0
          },
          "flight": {
            "flightCarrierCode": "LH",
            "flightNumber": "8170",
            "flightDate": "2017-07-19",
            "flightSegmentOrigin": "FRA",
            "flightSegmentDestination": "JFK"
          },
          "events": ""
        },
        {
          "type": "DLV",
          "station": "JFK",
          "plannedTime": "2017-07-20T01:00:00Z",
          "plannedTotals": {
            "noOfPieces": 10,
            "weight": 100
          },
          "actualTotals": {
            "noOfPieces": 0,
            "weight": 0
          },
          "flight": {
            "flightCarrierCode": "LH",
            "flightNumber": "8170",
            "flightDate": "2017-07-19",
            "flightSegmentOrigin": "FRA",
            "flightSegmentDestination": "JFK"
          },
          "events": ""
        }
      ]
    }
  },
  "booking": {
    "product": {
      "productName": "td.Pro",
      "productConditions": {
        "sPLList": {
          "splCode": [
            "SPX",
            "GEN"
          ]
        }
      }
    },
    "totals": {
      "noOfPieces": 10,
      "weight": 100
    },
    "originalTimeFrame": {
      "lAT": "2017-07-18T18:35:00Z",
      "tOA": "2017-07-20T01:00:00Z"
    },
    "origin": "FRA",
    "destination": "JFK",
    "bookingTime": "2017-07-17T10:45:00Z",
    "isSplitBooking": false,
    "confirmationStatus": "KK"
  },
  "events": {
    "event": [
      {
        "type": "MAN",
        "station": "FRA",
        "actualTime": "2017-07-19T08:10:00Z",
        "actualTotals": {
          "noOfPieces": 10,
          "weight": 100
        },
        "category": "F"
      },
      {
        "type": "BKD",
        "station": "FRA",
        "actualTime": "2017-07-17T09:10:00Z",
        "actualTotals": {
          "noOfPieces": 10,
          "weight": 100
        },
        "category": "S"
      },
      {
        "type": "RCS",
        "station": "FRA",
        "actualTime": "2017-07-17T14:20:00Z",
        "actualTotals": {
          "noOfPieces": 10,
          "weight": 100
        },
        "category": "S"
      }
    ]
  },
  "efreightDetails": {
    "preCheckStatus": {
      "preCheckStatusCode": "S",
      "precheckStatusDescription": "Success",
      "precheckTime": "2017-07-17T11:09:03Z",
      "precheckTimeUTC": "2017-07-17T11:09:03Z"
    }
  },
  "shipmentStatusEvents": {
    "event": {
      "category": "F",
      "type": "MAN",
      "station": "FRA",
      "flight": {
        "flightCarrierCode": "LH",
        "flightNumber": "8170",
        "flightDate": "2017-07-19",
        "flightSegmentOrigin": "FRA",
        "flightSegmentDestination": "JFK"
      }
    }
  }
}