- Who can use the Air Visibility API? This API is useful for any forwarders, shippers or transport management systems (TMSs) who would like to get real-time visibility on air freight shipments integrated into their internal system.
- What are the input details required to start tracking shipments? We require the Master Airway Bill number (MAWB) and the airline code to start tracking the shipment.
- What kind of information do I get for each shipment tracked? You get the following data for each MAWB from the Air Visibility product:
- Summary about the airwaybill's journey
- Events: list of events received from the airline
- Metadata: details of the tracking number
- Routes: list of flights and journey(s) taken, listed based on unique flight number and datetime of flight
See more details on what the API returns here.
- I’m receiving varying event codes across airlines. Can you advise? We standardize the data across airlines and add statuses and error codes where possible. However not all airlines share all event milestones and hence there can be some differences across airlines. We constantly improve our datasets and if there’s anything specific, we'd be most happy to receive such feedback and improve if needed.
- How frequently will the data be refreshed? At present, the data is refreshed 6 times per day per airway bill.
- Is there a limit on how many times the API can be called? No, there is no limit how many times you call the API. We only charge once per MAWB.
- How do you deal with split air shipments on the same MAWB? If the cargo is split into two journeys with the same flight number but different days, this would be listed as two journeys within the MAWB in the routes section. This allows you to easily filter any shipments that are split in their journey.
- What are the error messages that I would likely receive and how to interpret them? Here are the responses that the API will share:
- 200: Successfully Initiated Tracking for the provided Airway Bill Number
- 400: Bad Request Could be triggered due to the Invalid Payload being shared in the API payload and doesn't follow the API requirements. Resolution: Make sure the keys in the airway bill shared is not null and follows the AAA-BBBBBBBB format.
- 401: Unauthorized Access: You've provided an incorrect API Key. Resolution: Please check your API Key. Refer to the before you begin section of the Quick Start Guide.
- 403: API Quota Exceeded: API Quota for the org is finished. Resolution: For further assistance, please reach out to your account manager or [email protected]
- 409: Duplicate Upload ~ Record Already Exists. A bookmark with the same Airway Bill Number exists in the same org. Resolution: The API responds with the Bookmark ID for the same, which can be used to fetch the data.
- 500: Internal Server Error: These could be due to: Data Sources aren't responding, Error in Bookmark Creation process, Internal Database errors. Resolution: For further assistance, please reach out to your account manager or [email protected]
- Do you have a webhook for Air Visibility as well? Not yet, please write to us at [email protected] and we can advise on the timeline when it’ll be ready.
- Which airlines are supported? Please see here for the latest coverage of airlines in our datasets.
- What if the airline that I want to track is not supported? Please write to us at [email protected] and we can advise if it's technically possible to get that integrated and setup.
- Can I also use a web dashboard to track the air shipments? Yes, we have a beta version of the air tracking and will have a revamp ready in Aug 2024. Please write to us at [email protected] and we can advise on the timeline when it’ll be ready.
- Do you provide CO2 emissions calculation for Air shipments as well? Not yet, please write to us at [email protected] and we can advise on the timeline when it’ll be ready.
- Do you track express shipments as well? No, we only track master airway bill numbers.