API Reference

Changelog

Keep track of changes to the CargoCONNECT API

Subscribe to CargoCONNECT updates by email here!

API Update: 4 Apr 2025

Summary

In this release, we’re highlighting two key updates: tracking events are now available through our Booking Callback and updated error handling has been implemented. Read on for more details.

Booking Callback Changes

As announced in the Feb 2025 release, you can now receive tracking events through our Booking Callback. Find additional technical details here.

Error Handling Changes

As announced in the Mar 2025 release, we have implemented the updated error handling, detailed below.

Breaking Changes

  • Error Handling Updates:
    • The Booking endpoints of our Quote & Book API will return standardised error response formats.
    • Some error codes and response structures will change to enhance consistency and clarity.
    • Clients relying on previous error formats may need updates to handle the new responses correctly.

Key Changes

HTTP 4xx and 5xx Errors: Error responses will now include a structured JSON body with the following format based on the error origin.

  • Validation/CargoAi errors will include "error" and "description" fields:
    { "bookingStatus": "FAILED", "error": "formation does not match between search and booking: 0000000-0000", "description": "your api-key is not allowed" }
  • Airlines error will include a "rejectedReason" field:
    { "flightUUID": "efebae82-f913-11ef-b2d1-7ec029ae0c1b", "bookingStatus": "FAILED", "awb": "000", "rejectedReason": "GetAWBFailed" }

Action Required

  • Clients consuming the API responses must update their error-handling logic to support the new structured format.
  • Applications parsing error messages based on the previous error response structure may break if not updated.

For a full list of error code changes and migration guidance, refer to the booking error page.

API Update: 10 Mar 2025

Summary

As we see more need from customers to delete users from their API Key, we’ve introduced a new Delete User endpoint in the User Provisioning API, allowing users to be removed from an API Key without addressing Support. Additionally, the "stackable" field in Search and Direct Booking requests now defaults to true for better result accuracy, and the FWB & FHL API will return a clear error message when an airline is not supported.

Changes

  • Changed:
    • Search & Direct Booking: We’ve changed the default behaviour of the “stackable” field. Previously set to false, it now defaults to true unless explicitly set otherwise. This ensures users receive the maximum possible results and aligns API responses with CargoMART.
  • Improved:
    • FWB & FHL API is now able to let you know when an airline is not supported via our API. In such cases the API will return "errorMessage": "invalid request: awb_number: awb prefix is not supported."
  • Added:
    • User Provisioning API: Added a new endpoint to delete users from a customer's API Key. This allows automatic user deletion removing the need to contact our support.
    • Track & Trace is now covering China Central Airlines, and Schedules is now covering Etihad.

Update for a future release (target date 3 Apr 2025)

In order to help you prepare for future changes, we're sharing details about the updates coming in our April release.

Breaking Changes

Error Handling Updates:

  • The Booking endpoints of our Quote & Book API will return standardised error response formats.
  • Some error codes and response structures will change to enhance consistency and clarity.
  • Clients relying on previous error formats may need updates to handle the new responses correctly.

Key Changes

HTTP 4xx and 5xx Errors: Error responses will now include a structured JSON body with the following format based on the error origin.

  • Validation/CargoAi errors will include "error" and "description" fields:
    { "bookingStatus": "FAILED", "error": "formation does not match between search and booking: 0000000-0000", "description": "your api-key is not allowed" }
  • Airlines error will include a "rejectedReason" field:
    { "flightUUID": "efebae82-f913-11ef-b2d1-7ec029ae0c1b", "bookingStatus": "FAILED", "awb": "000", "rejectedReason": "GetAWBFailed" }

Action Required

  • Clients consuming the API responses must update their error-handling logic to support the new structured format.
  • Applications parsing error messages based on the previous error response structure may break if not updated.

For a full list of error code changes and migration guidance, refer to the booking error page.

API Update: 7 Feb 2025

We’re continuously expanding our airline coverage, now supporting 106 airlines for eBooking, 213 airlines for Track & Trace, and 698 airlines for Live Schedule.

Summary

In this release, we’re introducing a brand-new feature: the Booking Callback.

This callback is a webhook event that automatically pushes booking creation and update notifications to your system, regardless of whether the booking is made through our API or not. To start receiving these updates, simply provide us with a webhook URL.

For more details, visit the dedicated page in our documentation. You'll also see Tracking events included in the examples—while this feature isn’t fully ready yet, we’re actively working to add it as soon as possible.

Changes

  • Improved:
    • To enhance the customer experience, our Track & Trace team has worked to identify issues and improve API data quality. In this release, we’ve made two improvements and three fixes across four airlines, ensuring our API remains a reliable tracking source.
  • Added:
    • New Feature: Booking Callback — A webhook event that pushes booking creations and updates directly to your system. Simply provide a webhook URL to start receiving these updates. Tracking events will be added soon.
    • Authentication for Tracking updates — To enhance data security, we’ve added an authentication process for Tracking updates. To activate it, reach out to your CargoCONNECT technical point of contact, and we’ll assist in setting up a secure connection. Don't worry about interruptions to your integrations — authentication is enabled only upon request.

API Update: 19 Dec 2024

Summary

Over the past month, we’ve focused on enhancing the ULD/BUP and Allotment Booking functionality in our Direct Booking feature within the Quote & Book API. While most updates are behind the scenes, we’ve notably improved request validation for ULD/BUP to ensure smoother operations.

Additionally, we’ve upgraded the Track & Trace Subscription feature. Previously, users could enter multiple email addresses, but the system processed only the first one. Now users can subscribe up to five email addresses for an AWB or FlightUUID.

Changes

  • Changed:
    • Quote & Book (Direct Booking): Starting now, if your request contains the SHC "BUP" or the LoadType "BUP" in "dimensions", the "uldType" field within "dimensions" becomes mandatory. The "uldType" field accepts the values "AKE", "LDP" or "MDP"
    • Quote & Book: To reduce the number of failed bookings due to wrong "loadType" and "weightType" values in search requests, we have improved validation for these fields. Now they can either be left empty or be one of the following values: "TOTAL", "DIMENSIONS" or "BUP" for "loadType"; "TOTAL" or "PER_ITEM" for "weightType". This change aims to enhance the customer experience by minimizing failed bookings due to errors.
  • Added:
    • Quote & Book (Direct Booking): The "allotmentCode" field can now be set either in the "itinerary" object of the Direct Booking request or directly at the root level (same level as "awb"). This change anticipates the planned removal of "allotmentCode" from the "itinerary" object in the future.
    • Track & Trace: Users can now subscribe up to five email addresses at once.

API Update: 15 Nov 2024

Summary

We've made extensive improvements to data quality to enhance your experience. Additionally, the Tracking Unsubscription feature now aligns with Tracking Subscription behaviour.

Changes

  • Changed:
    • Users can now unsubscribe from either a URL, an email, or both.
    • Added the "emails" field to the Tracking Unsubscription to replace the "email" field in the future, allowing users time to transition smoothly. Currently, the "emails" field still only accepts one value, with plans to support multiple in the future.

Additional Notes

Further enhancements to the Tracking Subscription and Unsubscription endpoints and to Direct Booking are coming in future releases.

API Update: 21 Oct 2024

Summary

It's been a while since our last update, but we've been focused on improving API data quality. We've also made progress on the long-awaited FlyWINDOW callback feature.

Changes

  • Added:
    • FlyWINDOW Callback feature now ensures that all booking creations made by your users through FlyWINDOW are automatically sent to your system, reducing data loss between systems and improving performance by eliminating the need for manual input.

Additional Notes

To activate this FlyWINDOW callback, please contact us and provide a URL that can receive the update described here. Once activated, all bookings performed on FlyWINDOW by users attached to your API Key will be automatically sent to your system.

API Update: 23 Aug 2024

Summary

We have renamed the eAWB API to FWB&FHL API to clarify its functionality. The previous name, eAWB API, may have implied support only for electronic AWBs, however the API fully supports both electronic and paper AWBs, providing the ability to send FWB and FHL messages.

This update introduces the ability for the FWB&FHL API to send a callback via HTTP POST to a URL targeting users' system. Its purpose is to establish a REST-based communication that directly pushes the airline’s response to FWB and FHL messages to the user's system in real-time.

Changes

  • Added:
    • Possibility to set a URL or an email list to receive response from the airlines for FWB and FHL messages.
  • Changed:
    • The FWB&FHL API no longer accepts requested bookings ("PENDING_AIRLINE_INFORMATION" in "awb_status"). Now bookings need to be confirmed (with "awb_status": "PENDING_DELIVERY") when sending FWB&FHL messages to the airlines.

API Update: 30 Jul 2024

Summary

This update introduces the Electronic AWB feature. Moreover, Track & Trace API responses will now follow strict data formatting, no matter the source of the tracking data. Additionally, changes were made to the "flightUUID" field.

Changes

  • Removed:
    • The "flightUUID" field is removed from the root of the Direct Booking response with alternative flights to avoid confusion with the "flightUUID" in flight object (of the same response) which has to be used to perform bookings.
  • Added:
    • A new feature is added for handling electronic AWBs (read the documentation here).
  • Changed:
    • Track & Trace API now returns data in uniform format (see details here). The affected fields are: "weight", "volume", "pieces", "carbonEmission", "flightNumber", "distance", coordinates fields, date fields.
    • The "flightUID" field is being replaced with a "flightUUID" field and will become deprecated soon.

Additional Notes

Regarding switching from "flightUID" to "flightUUID": for the moment, both fields will be maintained until our partners migrate to using the new field. After that, the "flightUID" will be removed.

API Update: 27 Jun 2024

Summary

In this update Search by City Code becomes available for Route & Schedule and small improvements are made to the search and the booking process.

Changes

  • Removed:
    • A deprecated "awbPrefix" field is removed from flight information in the search response. The "awbPrefixes" field should be used.
  • Added:
    • Search by City Code is now available for Route & Schedule.
    • A new "trackingURL" field will be added to the booking response, which will provide a redirection link to our Tracking by Flight UUID.
  • Changed:
    • The “details” field in the timed out booking cancellation response will be renamed to “trackingURL”.
  • Fixed:
    • FlyWINDOW links were generated with a wrong domain name. This has been fixed.

Additional Notes

Search by City Code operates the same way for Route & Schedule as for Rate & Book: use a city code instead of an airport code for the origin or the destination and set to true “isOriginByCity” or “isDestinationByCity” in "filters" field.

API Update: 10 Jun 2024

Summary

In this update the possibility of getting the latest status when you use Direct Booking is added.

Changes

  • Added:
    • New "id" field returned in the direct booking response to be used when the latest status is not returned.
    • New status "DIRECT_BOOKING_PROCESSING" for pending direct booking

Additional Notes

Upon receiving a response with a status "DIRECT_BOOKING_PROCESSING", you may proceed to refine your booking request by using the responded "id" field within the request until the status change.

Coming Soon

  • Estimated Date: 8 Jul 2024
    • A new "trackingURL" field will be added to the booking response, which will provide a redirection link to our Tracking by Flight UUID. The “details” field in the booking cancellation response will also be renamed to “trackingURL”.
    • A deprecated "awbPrefix" field will be removed from flight information.

API Update: 14 May 2024

Summary

This update focuses on enhancing the Cancel endpoint of the Booking API, introducing new fields to improve user experience.

Changes

  • Added:
    • New field "cancelledReasons" in the request: Allows users to provide reasons for their booking cancellation requests. This information will be forwarded to the Airline.
    • New field "details" in the response: Provides additional details about the cancellation response, including a redirection link to our tracking by flight_uuid.
  • Fixed:
    • Timeout handling: Previously, timeouts were not correctly managed, resulting in some users losing cancellation responses. Now, users will receive a response within 25 seconds maximum. If we are still awaiting a response from the Airline API, the response will include a redirection link to our tracking by flight_uuid for users to retrieve the cancellation response from the airline if received.

Additional Notes

Users are encouraged to integrate these new fields promptly to better handle timeouts during cancellations due to slow responses from partners' APIs.

Coming Soon

  • Estimated Date: 10 Jun 2024
    • Possibility of getting the latest status when you use "Direct Booking" mode.
      • a new "id" field will be added in the booking response to be used when the latest status is not returned
      • a new status "DIRECT_BOOKING_PROCESSING" will be added for pending direct booking
    • a deprecated "awbPrefix" field will be removed from flight information