Cargo API

CARGO API - DOCUMENTATION

The CargoTracking API is a new API created by the Digital Commercial program of Airfrance / KLM e-Cargo that will enable the user to retrieve information about the status of his shipment.

Based on the information that are already accessible via the Tracking tool on afklcargo.com, the API has been created in order to give the possibility to the user to build its own tracking tool within his system.

The CGOTRKAPI uses Freight Status Update (or FSU) information to display the Last status of each shipment to the user. For each FSU generated by the station agent at the current location of the shipment, the system will update the last status of the shipment.

 

RESOURCE OVERVIEW

Currently, 3 endpoints are available

  1. GET /urns/{email}

    As a user, you have the possibility on afklcargo.com to create an account with an e-mail address known by the Airfrance KLM system to display a perosnalized dashboard of your current active shipments. 

    To create an account, visit afklcargo.com, myCargo rubric, and create an account in a few steps. 
    After the creation of your Cargo Account, you will have the possibility to switch between all of the entities, stations or companies linked to your account in our customer database, all represented by an IATA Unique Reference Number (or URN: IATA identifier per customer, entity or station). The purpose of this endpoint is to retrieve all of the URNs linked to your Cargo Account

  2. GET /awbs/{urn}


    A personalized page is available via myCargo in afklcargo.com. With that, the user has the possibility to retrieve a list of AirWay Bill status based on the Unique Reference number (or URN). If you select the myshipment functionality on afklcargo, myCargo rubric, you will be able to display the entire list of active AirWay Bills linked to your URN. This endpoint of the API has the exact same function (The URN is the entry point of this endpoint). 

    Based on the URN selected, the following data are available:

    a/ List of available filters:

    -          Total number of active shipments with corresponding status (Booked, En route or Delivered)

    -          Filter on the AirWay Bill number, the Destination, the Shipper name or the Consignee name

    -          Filter on the Origin

    -          Filter on the Weight

    -          Filter on the Product Label

    -          Filter on the Metastatus: Is the shipment on time? Is it just booked? Has it been replanned?

     

    A list of AWB will be displayed according to the filter selected. Every AirWay Bill will be displayed with a short summary containing:

    b/ List of data retrieved per AWB:

    -          AirWay Bill number

    -          Metastatus

    -          Origin and Destination

    -          Last status of the shipment

    -          Bookings per segment with Origin, Destination, and Flight information

    -          Product label

    -          Total number of pieces

    -          Chargeable Weight

    -          Shipper name

    -          Consignee name 

     

  3. GET /awbs/{awb}

    As a user, you also have the possibility to display the Details of a single AirWay Bill. The Single AirWay Bill tracking functionality is accessible on afklcargo.com via the Tracking Tool or by clicking on the "Details" button at the right of each AWB present in the list.  Clicking on this button will give you all of the information that we have about a shipment.

    To use this endpoint, an AirWay Bill (AWB) number is required.  This number is the unique identifier of the shipment. Based on that number, the API will return the following information:

     

    -          The AirWay Bill number

    -          The Origin

    -          The Destination

    -          The Product label (Example: Variation, Equation …)

    -          The metastatus of the shipment: Is the shipment on time? Is it just booked? Has it been delivered?

    -          The Latest Acceptance Time status: Freight received on time ? Accepted on time ?

    -          The total number of pieces

    -          The chargeable weight

    -          The shipment progress, with the last status of the shipment at each station on the route

    -          The booking information for each segment (Date, flight code, flight number, Offload reason if there is one and the Repair flight if there is one)

 

FLOW

First, call the endpoint GET /urns/{email} to retrieve all Urns linked to an afklcargo.com account.

 Then, for each Urn, call GET /awbs/{urn} to retrieve all Awbs linked to a single Urn.

 And, for each Awb, call GET /awbs/{awb} to retrieve all details about a specific Awb