- Previous: GET /awbs/{urn}
- Up: Cargo Tracking API
- Next: All Other APIS
GET /awbs/{awb}
GET /awbs/{awb}
Use this endoint to get all details of an AirwayBill
By entering an AWB number with a 057 or 074 prefix, the user will have access to the shipment details. The data provided by the API is the reflection of what is displayed in the Track&Trace on afklcargo.com.
List of details which can be displayed :
Track a shipment:
- Route : Possibility to build the route avaible by using the "Track your shipment" tool on afklcargo.com.
- Status : Display the progress history of the shipment journey with all status (done or expected).
- Booking information : Information on the booking of all segments of the route.
HEADER
Name
|
Value
|
Required
|
---|---|---|
Authorization | Bearer {{token}} | true |
RESOURCE
GET https://api.klm.com/cargo/tracking/awbs/{awb}
QUERY PARAMETERS
Name
|
Value
|
Required
|
---|---|---|
AWB | AirwayBill to be tracked | true |
RESPONSE PARAMETERS
Name
|
Type
|
Multiplicity
|
Description
|
---|---|---|---|
- ShipmentDetails |
Object | 1 | Details about the shipment |
| - Summary | Object | 1 | Summary about the shipment |
| | - originLocationId | String | 1 | Origin of the shipment |
| | - finalDesinationLocationId | String | 1 | Destination of the shipment |
| | - airlinePrefix | String | 1 | AWB airline prefix number |
| | - awbSerialNumber | String | 1 | AWB unique identification code |
| | - TotalPieceQuantity | Integer | 1 | Total number of pieces |
| | - grossWeightMeasure | String | 1 | Unit Weight |
| | - TotalGrossWeightMeasure | Integer | 0..1 | Total Weight of the Shipment (without unit) |
| | - grossVolumeMeasure | String | 0..1 | Unit Volume |
| | - TotalGrossVolumeMeasure | Integer | 0..1 | Total Volume of the Shipment (without unit) |
| | - productCode | String | 1 | Product Code |
| | - transportPhase | String | 0..1 |
State of the shipment (Booked, En route or Delivered) |
| | - MetaStatus | String | 1 |
Meta-Status to describe if the shipment if on schedule or not |
| | - EtaDate | Object | 0..1 | Date occurrence time (UTC) |
| | | - dateUtc | Date | 0..1 | UTC date in ms |
| | | - dateLT |
Date | 0..1 | Local date in ms |
| | - cargoAccountIds | Array of Objects | 0..1 | List of cargoAccountId |
| | | - cargoAccountId | String | 1 | The cargo account Id |
| | | - extra |
String | 0..1 | Extra information |
| - Progress | Object | 1 | Information about the progress |
| | - LatInformation | Object | 1 |
Information about Latest Acceptance Time |
| | | - latStatus | String | 1 | Latest Acceptance Time status |
| | | - latTime | Object | 0..1 | Latest Acceptance Time |
| | | | - dateUtc | Date | 0..1 | UTC date in ms |
| | | | - dateLT |
Date | 0..1 | Local date in ms |
| | | - pieces | Integer | 0..1 | Number of pieces of the FOH |
| | | - latdiff | String | 0..1 | Difference between FOH date and LAT |
| | | - fohinsertiondate | Object | 0..1 | FOH insertion date |
| | | | - dateUtc | Date | 0..1 | UTC date in ms |
| | | | - dateLT |
Date | 0..1 | Local date in ms |
| | - Routes | Array of Objects | 1 | Description of the routes |
| | | - routingLocationId | String | 1 | Current Pieces Location (1 per segment) |
| | | - totalPieceQuantity | Integer | 1 | Total number of pieces |
| | | - pieceQuantity | Integer | 0..1 | Piece at the segment station |
| | | - sequence | Integer | 1 | Occurrence order (per segment or status) |
| | | - arrivedPieceQuantity | Integer | 1 | Arrived pieces at the segment station |
| | | - departedPiecequantity | Integer | 1 | Departed pieces at the segment station |
| | | - atStation | Boolean | 1 | If the shipment is at the station |
| | | - details | Object | 1 | Details of the route |
| | | | - routingLocationId | String | 1 | Station Name (depending on the segment) |
| | | | - status | Array of Object | 1 | List of status linked to the route |
| | | | | - occured | Boolean | 1 | Already occured or expected |
| | | | | - occurenceDateTime | Object | 1 | Date occurrence time |
| | | | | | - dateUtc | Date | 0..1 | UTC date in ms |
| | | | | | - dateLT | Date | 0..1 | Local date in ms |
| | | | | - reasonCode | String | 1 | Milestone code |
| | | | | - routingLocationId | String | 1 | Station Name |
| | | | | - flight | Object | 0..1 | Information about the flight |
| | | | | | - carrierCode | String | 1 | Flight Carrier |
| | | | | | - flightNumber | String | 1 | Flight identification number |
| | | | | | - flightType | String | 0..1 | Type of the flight |
| | | | | | - operatedBy | String | 0..1 | Carrier which operate the flight |
| | | | | - pieceQuantity | Integer | 1 | Pieces at the station |
| | | | | - sequence | Integer | 1 | Occurrence order (per segment or status) |
| | | | | - isLastStatus | Boolean | 1 | If it is the Last Status or not |
| | - Statuses | Array of Objects | 1 | List of all status |
| | | - occured | Boolean | 1 | Already occured or expected |
| | | - occurenceDateTime | Object | 1 | Date occurrence time |
| | | | - dateUtc | Date | 0..1 | UTC date in ms |
| | | | - dateLT | Date | 0..1 | Local date in ms |
| | | - reasonCode | String | 1 | Milestone code |
| | | - routingLocationId | String | 1 | Station Name |
| | | | - flight | Object | 0..1 | Information about the flight |
| | | | | - carrierCode | String | 1 | Flight Carrier |
| | | | | - flightNumber | String | 1 | Flight identification number |
| | | | | - flightType | String | 0..1 | Type of the flight |
| | | | | - operatedBy | String | 0..1 | Carrier which operate the flight |
| | | | - pieceQuantity | Integer | 1 | Pieces at the station |
| | | | - sequence | Integer | 1 | Occurrence order (per segment or status) |
| | | | - isLastStatus | Boolean | 1 | If it is the Last Status or not |
| - Bookings | Array of Objects | 1 | List of bookings |
| | - Flight | Object | 0..1 | Information about the flight |
| | | - carrierCode | String | 1 | Flight Carrier |
| | | - flightNumber | String | 1 | Flight identification number |
| | | - flightType | String | 0..1 | Type of the flight |
| | | - operatedBy | String | 0..1 | Carrier which operate the flight |
| | - originLocationId | String | 1 | Origin of the segment booked |
| | - destinationLocationId | String | 1 | Destination of the segment booked |
| | - departureOccurrenceDateTime | Object | 1 | Supposed departure time of the segment booked |
| | | - dateUtc | Date |
0..1 |
UTC date in ms |
| | | - dateLT | Date | 0..1 | Local date in ms |
| | - arrivalOccurrenceDateTime | Object | 1 | Supposed arrival time of the segment booked |
| | | - dateUtc | Date | 0..1 | UTC date in ms |
| | | - dateLT | Date | 0..1 | Local date in ms |
| | - offloadReason | String | 0..1 | The offload reason |
| | - offloadStatus | String | 0..1 | Status of the booking regarding the offload |
| | - bookingStatus | String | 0..1 |
Status of the booking
|
| | - RepairFlight | Object | 0..1 | Information about the repair flight |
| | | - Flight | Object | 1 | The repair flight |
| | | | - carrierCode | String | 1 | Flight Carrier |
| | | | - flightNumber | String | 1 | Flight identification number |
| | | | - flightType | String | 0..1 | Type of the flight |
| | | | - operatedBy | String | 0..1 | Carrier which operate the flight |
| | | - departureOccurrenceDateTime | Object | 1 | Supposed departure time of the repair flight |
| | | | - dateUtc | Date | 0..1 | UTC date in ms |
| | | | - dateLT | Date | 0..1 | Local date in ms |
- _links | Object HATEOAS link | 1 | Represent a HATEOAS link to navigate |
| - self | Object | 1 | |
| | - href | String | 1 | Current url |
SAMPLE REQUEST
GET https:
//api.ute1.klm.com/cargo/tracking/awb/012-12345678
SAMPLE RESPONSE
{ "shipmentDetails": { "summary": { "originLocationId": "CDG", "finalDestinationLocationId": "JFK", "airlinePrefixe": "057", "awbSerialNumber": "93814780", "totalPieceQuantity": 10, "grossWeightMeasure": "KGM", "totalGrossWeightMeasure": "100.0", "totalGrossVolumeMeasure": "0.0", "transportPhase": "EN_ROUTE", "metaStatus": "REPLANNED" }, "progress": { "latInformation": { "latStatus": "ON_TIME", "latTime": null, "pieces": 0, "latdiff": null, "fohinsertionDate": null }, "routes": [ { "routingLocationId": "CDG", "totalPieceQuantity": 10, "pieceQuantity": 10, "sequence": 0, "arrivedPieceQuantity": 10, "departedPieceQuantity": 0, "atStation": true, "details": { "routingLocationId": "CDG", "status": [ { "occurred": true, "occurenceDateTime": { "dateUtc": 1493467200000, "dateLt": 1493474400000 }, "reasonCode": "RCS", "routingLocationId": "CDG", "pieceQuantity": 10, "sequence": 3, "isLastStatus": true } ] } }, { "routingLocationId": "JFK", "totalPieceQuantity": 10, "sequence": 1, "arrivedPieceQuantity": 0, "departedPieceQuantity": 0, "atStation": false, "details": { "routingLocationId": "JFK", "status": [ { "occurred": false, "occurenceDateTime": {}, "reasonCode": "ARR", "routingLocationId": "JFK", "pieceQuantity": 0, "sequence": 5, "isLastStatus": false } ] } } ], "statuses": [ { "occurred": true, "occurenceDateTime": { "dateUtc": 1493467200000, "dateLt": 1493474400000 }, "reasonCode": "RCS", "routingLocationId": "CDG", "pieceQuantity": 10, "sequence": 3, "isLastStatus": true }, { "occurred": false, "occurenceDateTime": {}, "reasonCode": "ARR", "routingLocationId": "JFK", "pieceQuantity": 0, "sequence": 5, "isLastStatus": false }, { "occurred": false, "occurenceDateTime": {}, "reasonCode": "RCF", "routingLocationId": "JFK", "pieceQuantity": 0, "sequence": 6, "isLastStatus": false }, { "occurred": false, "occurenceDateTime": {}, "reasonCode": "DEP", "routingLocationId": "CDG", "pieceQuantity": 0, "sequence": 4, "isLastStatus": false }, { "occurred": false, "occurenceDateTime": {}, "reasonCode": "NFD", "routingLocationId": "JFK", "pieceQuantity": 0, "sequence": 7, "isLastStatus": false }, { "occurred": false, "occurenceDateTime": {}, "reasonCode": "DLV", "routingLocationId": "JFK", "pieceQuantity": 0, "sequence": 9, "isLastStatus": false }, { "occurred": false, "occurenceDateTime": {}, "reasonCode": "AWD", "routingLocationId": "JFK", "pieceQuantity": 0, "sequence": 8, "isLastStatus": false }, { "occurred": false, "occurenceDateTime": {}, "reasonCode": "FOH", "routingLocationId": "CDG", "pieceQuantity": 0, "sequence": 2, "isLastStatus": false } ] }, "bookings": [ { "flight": { "carrierCode": "AF", "flightNumber": "006", "flightType": "PLANE" }, "originLocationId": "CDG", "destinationLocationId": "JFK", "departureOccurrenceDateTime": { "dateUtc": 1495627200000, "dateLt": 1495634400000 }, "arrivalOccurrenceDateTime": { "dateUtc": 1495659600000, "dateLt": 1495645200000 }, "offloadReason": "ISSUE", "offloadStatus": "BOOKING_OLD", "repairFlight": { "flight": { "carrierCode": "AF", "flightNumber": "006", "flightType": "PLANE" }, "departureDate": { "dateUtc": 1495713600000, "dateLt": 1495720800000 } } }, { "flight": { "carrierCode": "AF", "flightNumber": "006", "flightType": "PLANE" }, "originLocationId": "CDG", "destinationLocationId": "JFK", "departureOccurrenceDateTime": { "dateUtc": 1495713600000, "dateLt": 1495720800000 }, "arrivalOccurrenceDateTime": { "dateUtc": 1495746000000, "dateLt": 1495731600000 }, "offloadStatus": "BOOKING_REPAIR" } ] }, "_links": { "self": { "href": "http://api.ute1.klm.com/cargo/tracking/awb/057-93814780" } } }
ERROR RESPONSES
Error
400 : Bad Request : invalid awb format
"AWB must be ([0-9]{3}-[0-9]{8})"
412 : Precondition failed : No shipments found
- Previous: GET /awbs/{urn}
- Up: Cargo Tracking API
- Next: All Other APIS
Docs Navigation
- Air France-KLM Documentation
- Open Data
- Baggage allowance API Process flow - Pre-booking (inspiration) context
- Introduction
- Data scope
- Quick peak
- How to use
- Services overview
- Header
- GET All Allowances without Loyalty
- V1- All Allowances without Loyalty- Request
- V1- All Allowances without Loyalty- Response
- GET Base Allowances
- V1- Base Allowance - Request
- V1- Base Allowance - Response
- GET Loyalty Allowances
- V1- Loyalty Allowance - Request
- V1- Loyalty Allowance - Response
- GET Paid Options with Loyalty
- V1- GET Paid Options with Loyalty - Request
- V1- GET Paid Options with Loyalty - Response
- GET Paid Options without Loyalty
- V1- GET Paid Options without Loyalty - Request
- V1- GET Paid Options without Loyalty - Response
- GET All Allowances with Loyalty
- V1- All Allowances with Loyalty- Request
- V1- All Allowances with Loyalty- Response
- Get Started
- Offers API
- GET /reference-data v1
- GET /reference-data/deals v1
- GET /search-context v1
- POST /lowest-fare-offers v1
- GET /lowest-fare-offers v1
- POST /available-offers v1
- GET /available-offers v1
- GET /flightDetails
- POST /upsell-offers v1
- GET /upsell-offers v1
- GET /priceDetails v1
- GET /tax-breakdown
- GET /ticket-conditions
- GET /ticket-conditions with Reservation ID
- GET /ticket-conditions with Trip Parameters
- POST /shopping-carts
- GET /related-products
- POST /related-products/shopping-carts
- POST /mail-my-search
- POST /flights-availability v1
- POST /best-fare-offers v1
- POST/ bestOffers/feed
- Errors Code
- POST /available-offers/all v1
- POST /best-fare-offers/all-deals v1
- Inspire API / Amenities
- Flight Status API
- Network and Schedule API
- Baggage allowance API Process flow - Pre-booking (inspiration) context
- Metasearch API
- Cargo API
- All Other APIS