This page describes the flow of receiving airlines' responses for FWB&FHL sent via our API
The FWB&FHL API enables the transmission of FWB&FHL messages to over 120 airlines, effectively eliminating the need for physical printing, handling, and archiving of paper AWBs.
Key Benefits of FWB&FHL messages
- Enhanced Efficiency: Streamlines and improves the overall reliability of the cargo handling process.
- Accelerated Delivery: Reduces processing times, resulting in faster deliveries.
- Error Reduction: Minimizes handling errors through automated processes.
- Environmental Impact: Supports sustainability initiatives by significantly reducing paper usage.
How It Works
The FWB&FHL API allows seamless online submission of both Master Air Waybills (MAWB) and House Air Waybills (HAWB), for both paper and electronic Air Waybills. Users can input shipment details, including shipper and consignee information, directly into the system.
When working with electronic Air Waybills, please ensure that you have an existing eAWB agreement with the Airline.
Callback functionality
To enhance user convenience, the FWB&FHL API includes a callback feature that automatically delivers airline responses directly to you via email or HTTP POST requests, eliminating the need for follow-up contact with the airline or our support team.
Callback by URL
To activate the FWB&FHL API Callback to push response directly to your system you need to provide us all the endpoint details during the integration phase.
Once the URL is configured, airline responses will automatically be sent to this endpoint.
Below is the object definition for the FWB&FHL update via URL:
FWB&FHL Callback Object
| Field Name | Data Type | Data Format | Description |
|---|---|---|---|
| mawb_number | string | "xxx-xxxxxxx" | Contains the Master AWB (prefix-serial) |
| fhls_status | []FHLStatus | N/A | Provides response status for each House AWB (empty if response contains only FWB |
| fwb_status | string | enum["FWB_ACCEPTED", "FWB_REJECTED"] | Provides response status for Master AWB (empty if response contains only FHL) |
| airline_response | string | Alphanumeric text | Plain text FMA/FNA response from airline |
FHLStatus
| Field name | Data Type | Data Format | Description |
|---|---|---|---|
| hawb_number | string | AAXXXXXX - Alphanumeric - length 1 to 12 chars | Contains the House AWB number |
| fhl_status | string | "FHL_ACCEPTED_{hawb_number}"; "FHL_REJECTED_{hawb_number}" | Provides response status for House AWB |
Callback by Email
The FWB&FHL API Callback can also be activated via email in two ways:
- You can provide us with a list of email addresses during the integration phase, which will be linked to your API key. We will then send updates to all the provided email addresses.
- Alternatively, you can include an email address in the "userEmail" field (mandatory) within the FWB&FHL send request. This option is mainly intended as a backup if neither a URL nor a list of emails is associated with your API key.
Below is an example of an email response you will receive:
Note: please be aware that we are not responsible if the Airline doesn't provide any response to your messages.
Additional Information
- Printing of FWB and FHL is currently not supported
User Responsibility for Data Accuracy
Our API processes and returns data exactly as provided in your request. It is the user's responsibility to ensure that all shipment details—such as dimensions, weights, and totals—are accurate before submission.
In some cases, Freight Forwarders may manually adjust the chargeable weight to meet specific pricing. As a result, we do not verify or adjust the data you submit. Any discrepancies, incorrect rates, or unexpected pricing outcomes due to incorrect input data are solely the user's responsibility. We are not liable for any errors resulting from incorrect shipment details provided in API requests.
By using this API, you acknowledge and accept that ensuring data accuracy is your responsibility.