Settings
Settings allow administrators to manage key platform configurations such as fuel surcharges, exchange rates, and environment behavior. These values ensure consistent pricing, automation, and system-wide control.
Due to the fact application settings are used across the codebase of CargoPilot, creating, duplicating and deleting settings is disabled. When CargoPilot updates, new settings could be added.
Category filters
Looking for specific settings? CargoPilot allows admins to easily filter through available variables. Click the filter icon at the right-top of the table under "Setting category filter". The available filters are:
- System
- Order
- Booking
- General
- APIs
Setting types
Each setting has a specific data type, which must be followed exactly when modifying values in the Admin Panel. Using incorrect formats may lead to errors or unexpected behavior. The following types are used within CargoPilot:
string (text)
Normal plain text like: john.doe@hotmail.com.
array (list)
AF,KL,CV,BA,IB,EI,VY
int (number)
1.05
boolean (yes/no)
true / false
Editing a setting
- Navigate to the admin panel
- Navigate to
Application management > Settings. - Select a setting record
- Click the edit icon, located top-right of the page
- Click
Update Setting
Variables
cp-webcargo-airline-filter
This setting allows you to filter the airlines retrieved from the WebCargo API. To apply filters, please use the airline IATA codes in the following format:
TODO: INCLUDE AIRLINE IATA CODE LIST
AF,KL,CV,BA,IB,EI,VY
cp-webcargo-service-filter
This setting allows you to filter the services retrieved from the WebCargo API. To apply filters, please use the services codes in the following format:
TODO: INCLUDE SERVICE LIST WEBCARGO
GEN,DNG
cp-webcargo-acceptable-surcharges
This setting allows you to filter the surcharges retrieved from the WebCargo API. To apply filters, please use the surcharge codes in the following format:
TODO: INCLUDE SURCHARGE LIST WEBCARGO
FSC,SSC
TODO: ADD STANDARD CURRENCY
Some APIs return results in a single currency (e.g., dollars). To maintain consistency across the platform, CargoPilot converts all currencies to a standard currency. Please specify your preferred standard currency in the three letter code:
TODO: INCLUDE LIST OF THREE LETTER CODES
EUR
cp-exchangerate-margin-percentage
Currencies are converted to a standard currency, a conversion fee may be applied to all transactions.
1.05
cp-whitelisted-user-from-rate-margin
This setting allows users to view all generated quotes without any (profit) margin. To whitelist specific users, please provide the user ID's in the following format:
1,2,3,4,5
cp-cargoai-airline-filter
This setting allows you to filter the airlines retrieved from the CargoAI API. To apply filters, please use the airline IATA codes in the following format:
AF,KL,CV,BA,IB,EI,VY
cp-lufthansa-autoawb
This setting modifies the AWB generation behavior for the Lufthansa Cargo API. We recommend keeping this set to true, as it eliminates the need to manage additional AWB stock:
true
cp-exfreight-margin-percentage
TODO
1.15
cp-iata-regulated-countries
If your company operates in multiple countries, specify them here to enable quoting functionality for those locations:
NL,DE,BE
cp-booking-confirmation-email
When a custom quote is booked, the user will receive a confirmation email at their registered email address. To ensure administrators are notified, CargoPilot requires you to provide a designated email address for notifications.
john.doe@example.com
cancel-booking-failed-notification
If a booking cancellation fails, an email with the error details and booking information will be sent to the designated email address, allowing administrators to manually process the booking.
john.doe@example.com
cp-awb-alerts-email
Certain APIs do not currently support automatic AWB generation, requiring administrators to manually import AWBs from stock. When the stock level reaches the specified threshold (e.g., 5), a notification will be sent to the designated email address.
john.doe@example.com
cp-spot-quote-alerts-email
If CargoPilot fails to return a valid option for a search query, the user can manually request a spot quote. This request will be sent to the designated email address for further processing.
john.doe@example.com
cp-failed-booking-alerts-email
If a custom quote booking fails, an email containing the error details and quote information will be sent to the designated email address, allowing for manual booking of the quote.
john.doe@example.com