Skip to content
FX-Port/Docs
GuidesAPI referenceChangelog
Get API keys
  • Introduction
  • Quickstart
  • Security
  • Authentication
  • Environments and Postman
  • Sandbox
  • Conventions and naming
  • Legacy names and twins
  • Errors
  • Rate limits and fair use
  • Streaming search results
  • Use these docs with AI

API fundamentals

Legacy names and twins

Every previous spelling a request still accepts and every snake_case twin a response adds, per endpoint, listed from the API's own map.

FX-Port's names are snake_case. Older endpoints took, or returned, other spellings (searchId, offerId, bookingType ...). Nothing was removed: this page lists, per endpoint, every previous spelling a request still accepts and the snake_case twin a response adds next to its older key. The tables are generated from the API's own map, so they are always exact. The rules behind them are in Conventions and naming.

New code should send the names in the second column of the request tables, and read the twins of the response tables. A request that uses a previous spelling still works and is answered with a warnings array that names the spelling to use. Add ?naming=snake to any request to get every response key in snake_case.

Machine readers can fetch the same map as JSON from GET /api/v1/conventions/naming (no key needed).

Flights

POST /api/v1/flights/book_flight Reference

Request: the previous spelling still works, use the name in the second column
Previous spellingUse
agencyIdagency_id
agentIdagent_id
bookingTypebooking_type
commissionOverridecommission_override
contactcontact_details
contact_details.emailAddresscontact_details.email
contact_details.mobilecontact_details.phone_number
contact_details.phonecontact_details.phone_number
contact_details.phoneNumbercontact_details.phone_number
contactDetailscontact_details
contactscontact_details
offerIdoffer_id
passengers[].born_onpassengers[].date_of_birth
passengers[].bornOnpassengers[].date_of_birth
passengers[].dateOfBirthpassengers[].date_of_birth
passengers[].dobpassengers[].date_of_birth
passengers[].documentspassengers[].identity_documents
passengers[].family_namepassengers[].last_name
passengers[].familyNamepassengers[].last_name
passengers[].firstNamepassengers[].first_name
passengers[].given_namepassengers[].first_name
passengers[].givenNamepassengers[].first_name
passengers[].identity_documents[].documentNumberpassengers[].identity_documents[].number
passengers[].identity_documents[].expires_onpassengers[].identity_documents[].expiry_date
passengers[].identity_documents[].expiryDatepassengers[].identity_documents[].expiry_date
passengers[].identity_documents[].issuing_country_codepassengers[].identity_documents[].issuing_country
passengers[].identity_documents[].issuingCountrypassengers[].identity_documents[].issuing_country
passengers[].identity_documents[].issuingCountryCodepassengers[].identity_documents[].issuing_country
passengers[].identity_documents[].unique_identifierpassengers[].identity_documents[].number
passengers[].identityDocumentspassengers[].identity_documents
passengers[].lastNamepassengers[].last_name
passengers[].passengerTypepassengers[].type
passengers[].surnamepassengers[].last_name
searchIdsearch_id
sendEmailsend_email
Response: the key stays, and the snake_case twin is added next to it
KeyTwin
booking.referenceorder_id
exchangeRateexchange_rate
meta.supportHoldsupport_hold
meta.supportVoidsupport_void
meta.voidDeadlinevoid_deadline
offerIdoffer_id
passengers[].bornOndate_of_birth
passengers[].familyNamelast_name
passengers[].givenNamefirst_name
passengers[].idpassenger_id
passengers[].phoneNumberphone_number
passengers[].typepassenger_type
pricing.agencyCommissionagency_commission
pricing.b2bPriceb2b_price
pricing.basePricebase_price
pricing.finalPricefinal_price
pricing.taxesAndFeestaxes_and_fees
processingTimeprocessing_time
requestIdrequest_id
searchIdsearch_id
supplier.idsupplier_id
supplier.namesupplier_name
supplier.offerIdsupplier_offer_id
travelerPricing[].travelerIdpassenger_id
travelerPricing[].travelerTypepassenger_type

POST /api/v1/flights/cancel_order Reference

Request: the previous spelling still works, use the name in the second column
Previous spellingUse
agencyIdagency_id
bookingIdbooking_id
orderIdorder_id
Response: the key stays, and the snake_case twin is added next to it
KeyTwin
meta.supportHoldsupport_hold
meta.supportVoidsupport_void
meta.voidDeadlinevoid_deadline
orderIdorder_id
processingTimeprocessing_time
requestIdrequest_id
supplier.idsupplier_id
supplier.namesupplier_name
supplier.offerIdsupplier_offer_id

POST /api/v1/flights/cancel_quote Reference

Request: the previous spelling still works, use the name in the second column
Previous spellingUse
agencyIdagency_id
bookingIdbooking_id
orderIdorder_id
supplierIdsupplier_id
Response: the key stays, and the snake_case twin is added next to it
KeyTwin
cancellation.cancellationIdcancellation_id
cancellation.orderIdorder_id
exchangeRateexchange_rate
orderIdorder_id
processingTimeprocessing_time
requestIdrequest_id

POST /api/v1/flights/confirm_cancel Reference

Request: the previous spelling still works, use the name in the second column
Previous spellingUse
agencyIdagency_id
bookingIdbooking_id
cancellationIdcancellation_id
orderIdorder_id
supplierIdsupplier_id
Response: the key stays, and the snake_case twin is added next to it
KeyTwin
confirmation.cancellationIdcancellation_id
confirmation.orderIdorder_id
exchangeRateexchange_rate
orderIdorder_id
processingTimeprocessing_time
requestIdrequest_id

POST /api/v1/flights/flexible_search Reference

Request: the previous spelling still works, use the name in the second column
Previous spellingUse
acdExemptCompanyIdacd_exempt_company_id
agencyIdagency_id
agentIdagent_id
airline_excludeexcluded_airlines
airline_includeincluded_airlines
airlineExcludeexcluded_airlines
airlineIncludeincluded_airlines
airlinespreferred_airlines
cabinClasscabin_class
checkedBagschecked_bags
departureDatedeparture_date
directnonstop
exclude_airlineexcluded_airlines
exclude_airlinesexcluded_airlines
excludeAirlinesexcluded_airlines
excluded_airlineexcluded_airlines
excludedAirlinesexcluded_airlines
filters.airline_excludefilters.excluded_airlines
filters.airline_includefilters.included_airlines
filters.airlineExcludefilters.excluded_airlines
filters.airlineIncludefilters.included_airlines
filters.airlinesfilters.preferred_airlines
filters.exclude_airlinefilters.excluded_airlines
filters.exclude_airlinesfilters.excluded_airlines
filters.excludeAirlinesfilters.excluded_airlines
filters.excluded_airlinefilters.excluded_airlines
filters.excludedAirlinesfilters.excluded_airlines
filters.include_airlinefilters.included_airlines
filters.include_airlinesfilters.included_airlines
filters.includeAirlinesfilters.included_airlines
filters.included_airlinefilters.included_airlines
filters.includedAirlinesfilters.included_airlines
filters.preferredAirlinesfilters.preferred_airlines
flexibleOnlyflexible_only
fromCcfrom_cc
include_airlineincluded_airlines
include_airlinesincluded_airlines
includeAirlinesincluded_airlines
included_airlineincluded_airlines
includedAirlinesincluded_airlines
loyalty_program_accounts[].accountNumberloyalty_program_accounts[].account_number
loyalty_program_accounts[].airline_codeloyalty_program_accounts[].airline_iata_code
loyalty_program_accounts[].airlineCodeloyalty_program_accounts[].airline_iata_code
loyalty_program_accounts[].airlineIataCodeloyalty_program_accounts[].airline_iata_code
loyalty_program_accounts[].family_nameloyalty_program_accounts[].last_name
loyalty_program_accounts[].familyNameloyalty_program_accounts[].last_name
loyalty_program_accounts[].firstNameloyalty_program_accounts[].first_name
loyalty_program_accounts[].given_nameloyalty_program_accounts[].first_name
loyalty_program_accounts[].givenNameloyalty_program_accounts[].first_name
loyalty_program_accounts[].lastNameloyalty_program_accounts[].last_name
loyalty_program_accounts[].membership_numberloyalty_program_accounts[].account_number
loyalty_program_accounts[].membershipNumberloyalty_program_accounts[].account_number
loyalty_program_accounts[].program_ownerloyalty_program_accounts[].airline_iata_code
loyalty_program_accounts[].programOwnerloyalty_program_accounts[].airline_iata_code
loyalty_program_accounts[].surnameloyalty_program_accounts[].last_name
loyaltyProgramAccountsloyalty_program_accounts
maxPricemax_price
maxSuppliersmax_suppliers
passengers.childAgespassengers.child_ages
passengers.infantAgespassengers.infant_ages
passengers.seatedInfantAgespassengers.seated_infant_ages
passengers.seatedInfantspassengers.seated_infants
passengers.toddlerspassengers.seated_infants
passengers.youngpassengers.young_adults
passengers.youngAdultAgespassengers.young_adult_ages
passengers.youngAdultspassengers.young_adults
preferredAirlinespreferred_airlines
preferredSupplierspreferred_suppliers
returnDatereturn_date
segments[].datesegments[].departure_date
segments[].departuresegments[].departure_date
segments[].departureDatesegments[].departure_date
supplierIdsupplier_id
supplierIdssupplier_ids
toCcto_cc
travelerspassengers
Response: the key stays, and the snake_case twin is added next to it
KeyTwin
data.exchangeRate (events: supplier_result, supplier_start)exchange_rate
data.meta.filtersApplied (events: supplier_result, supplier_start)filters_applied
data.meta.supplierId (events: supplier_result, supplier_start)supplier_id
data.meta.supportHold (events: supplier_result, supplier_start)support_hold
data.meta.supportVoid (events: supplier_result, supplier_start)support_void
data.meta.voidDeadline (events: supplier_result, supplier_start)void_deadline
data.processingTime (events: supplier_result, supplier_start)processing_time
data.requestId (events: supplier_result, supplier_start)request_id
data.results.offers[].id (events: supplier_result, supplier_start)offer_id
data.results.offers[].pricing.agencyCommission (events: supplier_result, supplier_start)agency_commission
data.results.offers[].pricing.b2bPrice (events: supplier_result, supplier_start)b2b_price
data.results.offers[].pricing.basePrice (events: supplier_result, supplier_start)base_price
data.results.offers[].pricing.finalPrice (events: supplier_result, supplier_start)final_price
data.results.offers[].pricing.taxesAndFees (events: supplier_result, supplier_start)taxes_and_fees
data.results.offers[].supportHold (events: supplier_result, supplier_start)support_hold
data.results.offers[].supportVoid (events: supplier_result, supplier_start)support_void
data.results.offers[].travelerPricing[].travelerId (events: supplier_result, supplier_start)passenger_id
data.results.offers[].travelerPricing[].travelerType (events: supplier_result, supplier_start)passenger_type
data.results.offers[].voidDeadline (events: supplier_result, supplier_start)void_deadline
data.searchId (events: supplier_result, supplier_start)search_id
data.searchType (events: supplier_result, supplier_start)search_type
failures[].supplierIdsupplier_id
offers[].id (events: offers_chunk)offer_id
offers[].pricing.agencyCommission (events: offers_chunk)agency_commission
offers[].pricing.b2bPrice (events: offers_chunk)b2b_price
offers[].pricing.basePrice (events: offers_chunk)base_price
offers[].pricing.finalPrice (events: offers_chunk)final_price
offers[].pricing.taxesAndFees (events: offers_chunk)taxes_and_fees
offers[].supportHold (events: offers_chunk)support_hold
offers[].supportVoid (events: offers_chunk)support_void
offers[].travelerPricing[].travelerId (events: offers_chunk)passenger_id
offers[].travelerPricing[].travelerType (events: offers_chunk)passenger_type
offers[].voidDeadline (events: offers_chunk)void_deadline
processingTimeprocessing_time
requestIdrequest_id
searchTypesearch_type
successfulSuppliers[].supplierId (events: summary)supplier_id
supplierId (events: error, flex_prices, offers_chunk, supplier_complete, supplier_result, supplier_start)supplier_id
suppliers[].exchangeRateexchange_rate
suppliers[].filtersAppliedfilters_applied
suppliers[].flexPrices.matrix[].agencyCommissionagency_commission
suppliers[].flexPrices.matrix[].b2bPriceb2b_price
suppliers[].flexPrices.matrix[].basePricebase_price
suppliers[].flexPrices.matrix[].finalPricefinal_price
suppliers[].flexPrices.matrix[].taxesAndFeestaxes_and_fees
suppliers[].meta.processingTimeprocessing_time
suppliers[].meta.supplierIdsupplier_id
suppliers[].meta.supplierNamesupplier_name
suppliers[].results.offers[].idoffer_id
suppliers[].results.offers[].pricing.agencyCommissionagency_commission
suppliers[].results.offers[].pricing.b2bPriceb2b_price
suppliers[].results.offers[].pricing.basePricebase_price
suppliers[].results.offers[].pricing.finalPricefinal_price
suppliers[].results.offers[].pricing.taxesAndFeestaxes_and_fees
suppliers[].results.offers[].supportHoldsupport_hold
suppliers[].results.offers[].supportVoidsupport_void
suppliers[].results.offers[].travelerPricing[].travelerIdpassenger_id
suppliers[].results.offers[].travelerPricing[].travelerTypepassenger_type
suppliers[].results.offers[].voidDeadlinevoid_deadline
suppliers[].searchIdsearch_id
suppliers[].supportHoldsupport_hold
suppliers[].supportVoidsupport_void
suppliers[].voidDeadlinevoid_deadline

POST /api/v1/flights/get_acd_documents Reference

Request: the previous spelling still works, use the name in the second column
Previous spellingUse
agencyIdagency_id
bookingIdbooking_id
orderIdbooking_id
Response: the key stays, and the snake_case twin is added next to it
KeyTwin
acd.booking_idpnr
booking_idpnr
requestIdrequest_id

POST /api/v1/flights/get_booking Reference

Request: the previous spelling still works, use the name in the second column
Previous spellingUse
agencyIdagency_id
bookingIdbooking_id
includeApiResponseinclude_api_response
orderIdbooking_id
Response: the key stays, and the snake_case twin is added next to it
KeyTwin
booking.amadeus_idorder_id
booking.booking_idpnr
booking.bucket_linkpdf_url
booking.bucket_link_no_pricepdf_url_no_price
processingTimeprocessing_time
requestIdrequest_id

POST /api/v1/flights/get_order_quote Reference

Request: the previous spelling still works, use the name in the second column
Previous spellingUse
agencyIdagency_id
bookingIdbooking_id
orderIdorder_id
supplierIdsupplier_id
Response: the key stays, and the snake_case twin is added next to it
KeyTwin
exchangeRateexchange_rate
orderIdorder_id
orderQuote.bookingReferencepnr
orderQuote.orderIdorder_id
orderQuote.pricing.agencyCommissionagency_commission
orderQuote.pricing.b2bPriceb2b_price
orderQuote.pricing.basePricebase_price
orderQuote.pricing.finalPricefinal_price
orderQuote.pricing.taxesAndFeestaxes_and_fees
processingTimeprocessing_time
requestIdrequest_id
supplier.idsupplier_id
supplier.namesupplier_name

POST /api/v1/flights/get_ticket Reference

Request: the previous spelling still works, use the name in the second column
Previous spellingUse
agencyIdagency_id
bookingIdbooking_id
orderIdbooking_id
Response: the key stays, and the snake_case twin is added next to it
KeyTwin
download_urlpdf_url
download_url_no_pricepdf_url_no_price
requestIdrequest_id

POST /api/v1/flights/get_ticket_number Reference

Request: the previous spelling still works, use the name in the second column
Previous spellingUse
agencyIdagency_id
bookingIdbooking_id
orderIdbooking_id
Response: the key stays, and the snake_case twin is added next to it
KeyTwin
booking_idpnr
requestIdrequest_id
supplier_order_idorder_id

POST /api/v1/flights/pay_order Reference

Request: the previous spelling still works, use the name in the second column
Previous spellingUse
agencyIdagency_id
bookingIdbooking_id
orderIdorder_id
paymentTypepayment_type
priceGuaranteedprice_guaranteed
supplierIdsupplier_id
threeDSecureSessionIdthree_d_secure_session_id
Response: the key stays, and the snake_case twin is added next to it
KeyTwin
booking.referenceorder_id
exchangeRateexchange_rate
meta.supportHoldsupport_hold
meta.supportVoidsupport_void
meta.voidDeadlinevoid_deadline
orderIdorder_id
passengers[].bornOndate_of_birth
passengers[].familyNamelast_name
passengers[].givenNamefirst_name
passengers[].idpassenger_id
passengers[].phoneNumberphone_number
passengers[].typepassenger_type
pricing.agencyCommissionagency_commission
pricing.b2bPriceb2b_price
pricing.basePricebase_price
pricing.finalPricefinal_price
pricing.taxesAndFeestaxes_and_fees
processingTimeprocessing_time
requestIdrequest_id
supplier.idsupplier_id
supplier.namesupplier_name
supplier.offerIdsupplier_offer_id
travelerPricing[].travelerIdpassenger_id
travelerPricing[].travelerTypepassenger_type

POST /api/v1/flights/price_flight Reference

Request: the previous spelling still works, use the name in the second column
Previous spellingUse
agencyIdagency_id
offerIdoffer_id
searchIdsearch_id
Response: the key stays, and the snake_case twin is added next to it
KeyTwin
exchangeRateexchange_rate
offerIdoffer_id
processingTimeprocessing_time
requestIdrequest_id
results.offers[].idoffer_id
results.offers[].pricing.agencyCommissionagency_commission
results.offers[].pricing.b2bPriceb2b_price
results.offers[].pricing.basePricebase_price
results.offers[].pricing.finalPricefinal_price
results.offers[].pricing.taxesAndFeestaxes_and_fees
results.offers[].supplier.idsupplier_id
results.offers[].supplier.namesupplier_name
results.offers[].supplier.originalIdsupplier_offer_id
results.offers[].supportHoldsupport_hold
results.offers[].supportVoidsupport_void
results.offers[].travelerPricing[].travelerIdpassenger_id
results.offers[].travelerPricing[].travelerTypepassenger_type
results.offers[].voidDeadlinevoid_deadline

POST /api/v1/flights/upload_acd_documents Reference

Request: the previous spelling still works, use the name in the second column
Previous spellingUse
agencyIdagency_id
bookingIdbooking_id
documentdocuments
filedocuments
filesdocuments
orderIdbooking_id
traveler_idtraveler_ids
travelerIdtraveler_ids
travelerIdstraveler_ids
Response: the key stays, and the snake_case twin is added next to it
KeyTwin
acd.booking_idpnr
booking_idpnr
requestIdrequest_id

POST /api/v1/get_flights Reference

Request: the previous spelling still works, use the name in the second column
Previous spellingUse
acdExemptCompanyIdacd_exempt_company_id
agencyIdagency_id
agentIdagent_id
airline_excludeexcluded_airlines
airline_includeincluded_airlines
airlineExcludeexcluded_airlines
airlineIncludeincluded_airlines
airlinespreferred_airlines
cabinClasscabin_class
checkedBagschecked_bags
departureDatedeparture_date
directnonstop
exclude_airlineexcluded_airlines
exclude_airlinesexcluded_airlines
excludeAirlinesexcluded_airlines
excluded_airlineexcluded_airlines
excludedAirlinesexcluded_airlines
filters.airline_excludefilters.excluded_airlines
filters.airline_includefilters.included_airlines
filters.airlineExcludefilters.excluded_airlines
filters.airlineIncludefilters.included_airlines
filters.airlinesfilters.preferred_airlines
filters.exclude_airlinefilters.excluded_airlines
filters.exclude_airlinesfilters.excluded_airlines
filters.excludeAirlinesfilters.excluded_airlines
filters.excluded_airlinefilters.excluded_airlines
filters.excludedAirlinesfilters.excluded_airlines
filters.include_airlinefilters.included_airlines
filters.include_airlinesfilters.included_airlines
filters.includeAirlinesfilters.included_airlines
filters.included_airlinefilters.included_airlines
filters.includedAirlinesfilters.included_airlines
filters.preferredAirlinesfilters.preferred_airlines
flexibleOnlyflexible_only
fromCcfrom_cc
include_airlineincluded_airlines
include_airlinesincluded_airlines
includeAirlinesincluded_airlines
included_airlineincluded_airlines
includedAirlinesincluded_airlines
loyalty_program_accounts[].accountNumberloyalty_program_accounts[].account_number
loyalty_program_accounts[].airline_codeloyalty_program_accounts[].airline_iata_code
loyalty_program_accounts[].airlineCodeloyalty_program_accounts[].airline_iata_code
loyalty_program_accounts[].airlineIataCodeloyalty_program_accounts[].airline_iata_code
loyalty_program_accounts[].family_nameloyalty_program_accounts[].last_name
loyalty_program_accounts[].familyNameloyalty_program_accounts[].last_name
loyalty_program_accounts[].firstNameloyalty_program_accounts[].first_name
loyalty_program_accounts[].given_nameloyalty_program_accounts[].first_name
loyalty_program_accounts[].givenNameloyalty_program_accounts[].first_name
loyalty_program_accounts[].lastNameloyalty_program_accounts[].last_name
loyalty_program_accounts[].membership_numberloyalty_program_accounts[].account_number
loyalty_program_accounts[].membershipNumberloyalty_program_accounts[].account_number
loyalty_program_accounts[].program_ownerloyalty_program_accounts[].airline_iata_code
loyalty_program_accounts[].programOwnerloyalty_program_accounts[].airline_iata_code
loyalty_program_accounts[].surnameloyalty_program_accounts[].last_name
loyaltyProgramAccountsloyalty_program_accounts
maxPricemax_price
maxSuppliersmax_suppliers
passengers.childAgespassengers.child_ages
passengers.infantAgespassengers.infant_ages
passengers.seatedInfantAgespassengers.seated_infant_ages
passengers.seatedInfantspassengers.seated_infants
passengers.toddlerspassengers.seated_infants
passengers.youngpassengers.young_adults
passengers.youngAdultAgespassengers.young_adult_ages
passengers.youngAdultspassengers.young_adults
preferredAirlinespreferred_airlines
preferredSupplierspreferred_suppliers
returnDatereturn_date
segments[].datesegments[].departure_date
segments[].departuresegments[].departure_date
segments[].departureDatesegments[].departure_date
supplierIdsupplier_id
supplierIdssupplier_ids
toCcto_cc
travelerspassengers
Response: the key stays, and the snake_case twin is added next to it
KeyTwin
data.exchangeRate (events: supplier_result, supplier_start)exchange_rate
data.meta.filtersApplied (events: supplier_result, supplier_start)filters_applied
data.meta.supplierId (events: supplier_result, supplier_start)supplier_id
data.meta.supportHold (events: supplier_result, supplier_start)support_hold
data.meta.supportVoid (events: supplier_result, supplier_start)support_void
data.meta.voidDeadline (events: supplier_result, supplier_start)void_deadline
data.processingTime (events: supplier_result, supplier_start)processing_time
data.requestId (events: supplier_result, supplier_start)request_id
data.results.offers[].id (events: supplier_result, supplier_start)offer_id
data.results.offers[].pricing.agencyCommission (events: supplier_result, supplier_start)agency_commission
data.results.offers[].pricing.b2bPrice (events: supplier_result, supplier_start)b2b_price
data.results.offers[].pricing.basePrice (events: supplier_result, supplier_start)base_price
data.results.offers[].pricing.finalPrice (events: supplier_result, supplier_start)final_price
data.results.offers[].pricing.taxesAndFees (events: supplier_result, supplier_start)taxes_and_fees
data.results.offers[].supportHold (events: supplier_result, supplier_start)support_hold
data.results.offers[].supportVoid (events: supplier_result, supplier_start)support_void
data.results.offers[].travelerPricing[].travelerId (events: supplier_result, supplier_start)passenger_id
data.results.offers[].travelerPricing[].travelerType (events: supplier_result, supplier_start)passenger_type
data.results.offers[].voidDeadline (events: supplier_result, supplier_start)void_deadline
data.searchId (events: supplier_result, supplier_start)search_id
data.searchType (events: supplier_result, supplier_start)search_type
failures[].supplierIdsupplier_id
offers[].id (events: offers_chunk)offer_id
offers[].pricing.agencyCommission (events: offers_chunk)agency_commission
offers[].pricing.b2bPrice (events: offers_chunk)b2b_price
offers[].pricing.basePrice (events: offers_chunk)base_price
offers[].pricing.finalPrice (events: offers_chunk)final_price
offers[].pricing.taxesAndFees (events: offers_chunk)taxes_and_fees
offers[].supportHold (events: offers_chunk)support_hold
offers[].supportVoid (events: offers_chunk)support_void
offers[].travelerPricing[].travelerId (events: offers_chunk)passenger_id
offers[].travelerPricing[].travelerType (events: offers_chunk)passenger_type
offers[].voidDeadline (events: offers_chunk)void_deadline
processingTimeprocessing_time
requestIdrequest_id
searchTypesearch_type
successfulSuppliers[].supplierId (events: summary)supplier_id
supplierId (events: error, flex_prices, offers_chunk, supplier_complete, supplier_result, supplier_start)supplier_id
suppliers[].exchangeRateexchange_rate
suppliers[].filtersAppliedfilters_applied
suppliers[].flexPrices.matrix[].agencyCommissionagency_commission
suppliers[].flexPrices.matrix[].b2bPriceb2b_price
suppliers[].flexPrices.matrix[].basePricebase_price
suppliers[].flexPrices.matrix[].finalPricefinal_price
suppliers[].flexPrices.matrix[].taxesAndFeestaxes_and_fees
suppliers[].meta.processingTimeprocessing_time
suppliers[].meta.supplierIdsupplier_id
suppliers[].meta.supplierNamesupplier_name
suppliers[].results.offers[].idoffer_id
suppliers[].results.offers[].pricing.agencyCommissionagency_commission
suppliers[].results.offers[].pricing.b2bPriceb2b_price
suppliers[].results.offers[].pricing.basePricebase_price
suppliers[].results.offers[].pricing.finalPricefinal_price
suppliers[].results.offers[].pricing.taxesAndFeestaxes_and_fees
suppliers[].results.offers[].supportHoldsupport_hold
suppliers[].results.offers[].supportVoidsupport_void
suppliers[].results.offers[].travelerPricing[].travelerIdpassenger_id
suppliers[].results.offers[].travelerPricing[].travelerTypepassenger_type
suppliers[].results.offers[].voidDeadlinevoid_deadline
suppliers[].searchIdsearch_id
suppliers[].supportHoldsupport_hold
suppliers[].supportVoidsupport_void
suppliers[].voidDeadlinevoid_deadline

Hotels

POST /api/v1/hotels/book_hotel Reference

Request: the previous spelling still works, use the name in the second column
Previous spellingUse
bookHashbook_hash
bookingIdbooking_id
hotelIdhotel_id
partner_order_idbooking_id
partnerOrderIdbooking_id
Response: the key stays, and the snake_case twin is added next to it
KeyTwin
balanceDebitedbalance_debited
bookingIdbooking_id
checkinDatecheckin
checkoutDatecheckout
hotelIdhotel_id
partnerOrderIdpartner_order_id
payoutCreatedpayout_created
postProcessing.bucketLinkvoucher_url
pricing.agencyCommissionagency_commission
pricing.currencyagency_currency
pricing.supplierCurrencysupplier_currency
pricing.totalPricetotal_price
processingTimeprocessing_time
transactionCreatedtransaction_created

POST /api/v1/hotels/cancel_hotel Reference

Request: the previous spelling still works, use the name in the second column
Previous spellingUse
bookingIdbooking_id
partner_order_idbooking_id
partnerOrderIdbooking_id
Response: the key stays, and the snake_case twin is added next to it
KeyTwin
bookingIdbooking_id
bookingStatusbooking_status
processingTimeprocessing_time
refund.agencyAmountagency_refund_amount
refund.cancellationTypecancellation_type
refund.currencyagency_currency
refund.providerAmountsupplier_refund_amount
refund.providerCurrencysupplier_currency
refund.travelerAmounttraveler_refund_amount
refundProcessedrefund_processed

POST /api/v1/hotels/details Reference

Request: the previous spelling still works, use the name in the second column
Previous spellingUse
detailLeveldetail_level
hotelIdshotel_ids
idshotel_ids
imagesLimitimages_limit

POST /api/v1/hotels/get_hotel_info Reference

Request: the previous spelling still works, use the name in the second column
Previous spellingUse
detailLeveldetail_level
hidhotel_id
hotelIdhotel_id
hotelIdshotel_ids
idhotel_id
idshotel_ids
imagesLimitimages_limit
Response: the key stays, and the snake_case twin is added next to it
KeyTwin
data[].checkIncheck_in_time
data[].checkOutcheck_out_time
data[].hotelChainhotel_chain
data[].isClosedis_closed
data[].postalCodepostal_code
data[].region.countryCodecountry_code
data[].starCertificatestar_certificate
data[].starRatingstar_rating

POST /api/v1/hotels/get_rates Reference

Request: the previous spelling still works, use the name in the second column
Previous spellingUse
check_incheckin
check_outcheckout
checkin_datecheckin
checkinDatecheckin
checkout_datecheckout
checkoutDatecheckout
hotelIdhotel_id
idhotel_id
Response: the key stays, and the snake_case twin is added next to it
KeyTwin
data.hotelIdhotel_id
data.rates[].bookHashbook_hash
data.rates[].cancellationPolicy.freeCancellationBeforefree_cancellation_before
data.rates[].dailyPricesdaily_prices
data.rates[].exchangeRateexchange_rate
data.rates[].matchHashmatch_hash
data.rates[].pricing.agencyCommissionagency_commission
data.rates[].pricing.agencyCurrencyagency_currency
data.rates[].pricing.supplierCurrencysupplier_currency
data.rates[].pricing.totalPricetotal_price
processingTimeprocessing_time

GET /api/v1/hotels/get_voucher Reference

Request: the previous spelling still works, use the name in the second column
Previous spellingUse
bookingIdbooking_id
partner_order_idbooking_id
partnerOrderIdbooking_id
Response: the key stays, and the snake_case twin is added next to it
KeyTwin
data.bookingIdbooking_id
data.voucherUrlvoucher_url
data.voucherUrlNoPricevoucher_url_no_price
data.voucherUrlWithPricevoucher_url_with_price

POST /api/v1/hotels/pre_book Reference

Request: the previous spelling still works, use the name in the second column
Previous spellingUse
bookHashbook_hash
hashbook_hash
Response: the key stays, and the snake_case twin is added next to it
KeyTwin
data.hotelIdhotel_id
data.rates[].bookHashbook_hash
data.rates[].cancellationPolicy.freeCancellationBeforefree_cancellation_before
data.rates[].dailyPricesdaily_prices
data.rates[].exchangeRateexchange_rate
data.rates[].matchHashmatch_hash
data.rates[].pricing.agencyCommissionagency_commission
data.rates[].pricing.agencyCurrencyagency_currency
data.rates[].pricing.supplierCurrencysupplier_currency
data.rates[].pricing.totalPricetotal_price
formData.partnerOrderIdpartner_order_id
partnerOrderIdbooking_id
partnerOrderIdpartner_order_id
priceChangedprice_changed

POST /api/v1/hotels/search Reference

Request: the previous spelling still works, use the name in the second column
Previous spellingUse
detailLeveldetail_level
hotelIdshotel_ids
idshotel_ids
imagesLimitimages_limit

POST /api/v1/hotels/search_advanced Reference

Request: the previous spelling still works, use the name in the second column
Previous spellingUse
check_incheckin
check_outcheckout
checkin_datecheckin
checkinDatecheckin
checkout_datecheckout
checkoutDatecheckout
hotelIdhotel_id
idhotel_id

eSIMs

GET /api/v1/esims/bookings Reference

Response: the key stays, and the snake_case twin is added next to it
KeyTwin
pagination.pagestotal_pages

GET /api/v1/esims/bookings/{booking_id}/setup-instructions Reference

Response: the key stays, and the snake_case twin is added next to it
KeyTwin
data.codeorder_id
data.total_priceretail_price

GET /api/v1/esims/bookings/{booking_id}/verify Reference

Response: the key stays, and the snake_case twin is added next to it
KeyTwin
isOwneris_owner

POST /api/v1/esims/orders Reference

Request: the previous spelling still works, use the name in the second column
Previous spellingUse
customer_emailemail
customer_first_namefirst_name
customer_last_namelast_name
customer_phonephone
user_idagent_id
Response: the key stays, and the snake_case twin is added next to it
KeyTwin
balanceDebitedbalance_debited
data.order.codeorder_id
data.order.total_priceretail_price
payoutCreatedpayout_created
transactionCreatedtransaction_created

GET /api/v1/esims/packages Reference

Request: the previous spelling still works, use the name in the second column
Previous spellingUse
filter[type]type
Response: the key stays, and the snake_case twin is added next to it
KeyTwin
data[].balance_debit_amountb2b_price
data[].idpackage_id
data[].pricebase_price
meta.agency_currencycurrency

GET /api/v1/esims/topup-packages/{iccid} Reference

Response: the key stays, and the snake_case twin is added next to it
KeyTwin
data.data[].balance_debit_amountb2b_price
data.data[].idpackage_id
data.data[].total_priceretail_price

POST /api/v1/esims/topups Reference

Request: the previous spelling still works, use the name in the second column
Previous spellingUse
customer_emailemail
customer_first_namefirst_name
customer_last_namelast_name
customer_phonephone
user_idagent_id
Response: the key stays, and the snake_case twin is added next to it
KeyTwin
balanceDebitedbalance_debited
data.topup.codeorder_id
data.topup.total_priceretail_price
payoutCreatedpayout_created
transactionCreatedtransaction_created

Account and suppliers

GET /api/v1/balances Reference

Response: the key stays, and the snake_case twin is added next to it
KeyTwin
data[].currency_codecurrency
meta.agencyIdagency_id
meta.financialOperationsEnabledfinancial_operations_enabled

GET /api/v1/balances/{balance_id}/history Reference

Request: the previous spelling still works, use the name in the second column
Previous spellingUse
fromdate_from
from_datedate_from
todate_to
to_datedate_to
Response: the key stays, and the snake_case twin is added next to it
KeyTwin
data[].balanceIdbalance_id
data[].bookingRecordIdbooking_record_id
data[].createdAtcreated_at
meta.agencyIdagency_id
meta.balanceCurrencybalance_currency
meta.balanceIdbalance_id
meta.financialOperationsEnabledfinancial_operations_enabled
pagination.hasMorehas_more

GET /api/v1/bookings/{booking_id} Reference

Response: the key stays, and the snake_case twin is added next to it
KeyTwin
data.agencyCommissionagency_commission
data.agencyIdagency_id
data.agentIdagent_id
data.arrivalDatearrival_date
data.balanceOperationsbalance_operations
data.balanceOperations[].createdAtcreated_at
data.bookingIdbooking_id
data.bookingModebooking_mode
data.checkinDatecheckin
data.checkoutDatecheckout
data.createdAtcreated_at
data.customerEmailcustomer_email
data.flightNumberflight_number
data.hotelIdhotel_id
data.hotelNamehotel_name
data.netPriceb2b_price
data.orderIdorder_id
data.packageNamepackage_name
data.providerNameprovider_name
data.receiptUrlreceipt_url
data.requireAcdrequire_acd
data.supplierIdsupplier_id
data.totalPricetotal_price
data.travelerPricingtraveler_pricing
data.updatedAtupdated_at
data.voucherUrlvoucher_url
data.voucherUrlNoPricevoucher_url_no_price
data.voucherUrlWithPricevoucher_url_with_price
meta.agencyIdagency_id

GET /api/v1/history Reference

Request: the previous spelling still works, use the name in the second column
Previous spellingUse
fromdate_from
from_datedate_from
todate_to
to_datedate_to
Response: the key stays, and the snake_case twin is added next to it
KeyTwin
data[].agencyCommissionagency_commission
data[].agencyIdagency_id
data[].agentIdagent_id
data[].arrivalDatearrival_date
data[].bookingIdbooking_id
data[].bookingModebooking_mode
data[].checkinDatecheckin
data[].checkoutDatecheckout
data[].createdAtcreated_at
data[].customerEmailcustomer_email
data[].flightNumberflight_number
data[].hotelIdhotel_id
data[].hotelNamehotel_name
data[].netPriceb2b_price
data[].orderIdorder_id
data[].packageNamepackage_name
data[].providerNameprovider_name
data[].receiptUrlreceipt_url
data[].requireAcdrequire_acd
data[].supplierIdsupplier_id
data[].totalPricetotal_price
data[].updatedAtupdated_at
data[].voucherUrlvoucher_url
data[].voucherUrlNoPricevoucher_url_no_price
data[].voucherUrlWithPricevoucher_url_with_price
meta.agencyIdagency_id
pagination.hasMorehas_more

GET /api/v1/suppliers Reference

Response: the key stays, and the snake_case twin is added next to it
KeyTwin
meta.permissionRequiredpermission_required
products[].suppliers[].voidDeadlinevoid_deadline
PreviousConventions and namingNext Errors

On this page

  • Flights
  • Hotels
  • eSIMs
  • Account and suppliers

© 2026 FX-Port

TermsPrivacy[email protected]