Travel tools

Search any product your account sells, from a plain-language query or structured fields. Waits for slower searches to finish.

Read only.

Tool signaturesearch_trips(
  query*: string,
  domain?: string,
  origin?: string,
  destination?: string,
  dates?: object,
  travelers?: object,
  esim?: object,
  maxResults?: integer,
  intent?: object
)
// * required   ? optional

Arguments

• queryrequired
  string What you want, in plain words (for example: 2 nights in Lisbon next weekend for 2 adults); the search is filled in from it.
• domainoptional
  string Optional; inferred from query if absent.
• originoptional
  string Where the trip starts, as a place code (IATA for flights).
• destinationoptional
  string A place code: IATA for HTL and FLT, an ISO 3166-1 alpha-2 country code such as JP for ESIM (country names are not resolved).
• datesoptional
  object The travel dates.

  2 fields

  • startoptional
    string (date) First day: check-in, departure or the day of use.
  • endoptional
    string (date) Last day: check-out or return.
• travelersoptional
  object Who travels.

  2 fields

  • adultsoptional
    integer How many adults, at least one.
  • childAgesoptional
    array of integer The age of each child, one entry per child.
• esimoptional
  object ESIM only: the plan filter (region, global, minDataGb, minDays, quantity).

  5 fields

  • regionoptional
    string A regional plan by its listing name (for example europe), instead of a country.
  • globaloptional
    boolean Global plans, instead of a country or region.
  • minDataGboptional
    number The smallest data allowance in GB; unlimited plans always match, 0 means no floor.
  • minDaysoptional
    integer The shortest plan validity in days; without it, the span of dates.start to dates.end.
  • quantityoptional
    integer How many eSIMs in one order (a supplier may allow fewer); without it, the travelers count, else 1.
• maxResultsoptional
  integer The most offers to return, 1 to 50.
• intentoptional
  object Optional raw per-domain intent fields merged over the slot-filled intent (expert override).

Compare up to five offers side by side. Details, conditions and rules.

Read only.

Tool signaturecompare_offers(
  offerRefs*: array of string,
  domain?: string
)
// * required   ? optional

Arguments

• offerRefsrequired
  array of string The offers to compare, one to five, as a search returned them.
• domainoptional
  string Optional when the offers came from search_trips.

Get a live price, then hold the offer for free where the supplier allows it. Holds that need a deposit are refused.

Makes a change that moves no money. It runs only where your account lets agents make changes; otherwise the agent is told the change needs approval.

Tool signaturehold_offer(
  offerRef*: string,
  domain?: string,
  idempotencyKey?: string (uuid)
)
// * required   ? optional

Arguments

• offerRefrequired
  string The offer, as search_trips or v1_search returned it.
• domainoptional
  string Canonical product code or alias from the capabilities document (HTL, FLT, EXP, ...).
• idempotencyKeyoptional
  string (uuid) Idempotency-Key.

Ask for more time on an active hold, where the supplier allows it.

Makes a change that moves no money. It runs only where your account lets agents make changes; otherwise the agent is told the change needs approval.

Tool signatureextend_hold(
  body*: HoldExtendRequest,
  holdRef*: string,
  idempotencyKey*: string (uuid)
)
// * required   ? optional

Arguments

• bodyrequired
  HoldExtendRequest Ask for more time on a hold.

  HoldExtendRequest: 2 fields

  • contextrequired
    MondeeContext Request context envelope.

    MondeeContext: 13 fields

    • actionoptional
      string Mirrors the verb; optional (server sets from route).
    • clientReferenceoptional
      string Caller's own id; searchable; the reconciliation primitive.
    • currencyoptional
      string ISO-4217; absent = tenant default; blank/invalid = 400.
    • domainrequired
      string Canonical code or alias per the domain registry; unknown = 400 UNKNOWN_DOMAIN.
    • enrichoptional
      array of string Opt-in enrichment on shopping answers: EMISSIONS | RATINGS | AMENITIES | ROUTE.
    • fareSourcePolicyoptional
      enum BYOC tenants only; narrows, never widens, the configured strategy.DEFAULTOWN_ONLYMONDEE_ONLYBLEND
    • includeUpstreamoptional
      boolean Ask for the supplier's own answer, verbatim, beside what the platform read from it: Offer.upstream on every offer of a search, poll, detail or flight-returns answer, AirReturnOption.upstream on each ….
    • localeoptional
      string The language and region for text in the answer, as a BCP 47 tag (for example en-US).
    • onBehalfOfoptional
      OnBehalfOf Who a desk or agent books FOR: stamped into the audit actor and the clientReference lineage of the order.

      OnBehalfOf: 2 fields

      • customerIdoptional
        string A customer or traveller id your own system knows.
      • traveleroptional
        string Free-text traveller identity when there is no customer id.
    • posoptional
      string Point-of-sale market, orthogonal to tenant.
    • selectionoptional
      SelectionPreferences Context.selection: the caller's offer-selection preferences for this search.

      SelectionPreferences: 4 fields

      • excludeSuppliersoptional
        array of string Supplier codes whose offers this search does not show; narrows only.
      • objectiveoptional
        enum How the winner of an item is picked.CHEAPESTREFUNDABLE_FIRSTPREFERRED_SUPPLIERSPLATFORM_DEFAULT
      • preferSuppliersoptional
        array of string Supplier codes as in fareSource.supplier, most preferred first (PREFERRED_SUPPLIERS).
      • viewoptional
        enum SELECTED (one entry per item, alternatives under the winner) or ALL (the flat list, tagged).SELECTEDALL
    • session_idoptional
      string Your own id for the user session the call belongs to.
    • transaction_idoptional
      string Constant across one shop-to-book journey.
  • messagerequired
    object The request: `message.intent` says how long you want the hold.

    1 field

    • intentoptional
      object The time you want the hold until, as requestedUntil; the supplier decides the actual expiry.

      1 field

      • requestedUntiloptional
        string (date-time) Absent = the supplier's default extension.
• holdRefrequired
  string The hold to extend, as the hold call returned it.
• idempotencyKeyrequired
  string (uuid) Mandatory on mutations: **48h TTL**; replay with same body-hash returns the original response with Idempotency-Replayed true; same key + different body is 409 ….

Get a live price, then file a request to book the offer at that price. A person on your team approves it before anything is booked.

Files a request. Nothing is booked, cancelled or paid until a person on your team approves it in the console.

Tool signaturebook_offer(
  offerRef*: string,
  travelers*: array of traveler,
  requiredInfoAnswers?: object,
  paymentRef?: string,
  domain?: string,
  clientReference?: string
)
// * required   ? optional

Arguments

• offerRefrequired
  string The offer, as search_trips or v1_search returned it.
• travelersrequired
  array of traveler The people travelling, one entry each.

  traveler: 5 fields

  • firstNamerequired
    string First name, as on the travel document.
  • lastNamerequired
    string Last name, as on the travel document.
  • emailoptional
    string Email address for the booking's messages.
  • typeoptional
    string Adult (ADT), child (CHD) or infant (INF); ADT | CHD | INF.
  • dateOfBirthoptional
    string (date) Date of birth; needed for children and infants.
• requiredInfoAnswersoptional
  object Answers to the questions the offer's requiredInfo asks, keyed as it names them.
• paymentRefoptional
  string Pre-created payment intent.
• domainoptional
  string Optional when the offer came from search_trips.
• clientReferenceoptional
  string Your own reference for the booking, kept on the order.

Quote the cancellation penalty, then file a request to cancel at that penalty. A person on your team approves it before anything is cancelled.

Files a request. Nothing is booked, cancelled or paid until a person on your team approves it in the console.

Tool signaturecancel_with_quote(
  orderRef*: string,
  domain?: string,
  reason?: string
)
// * required   ? optional

Arguments

• orderRefrequired
  string The order to cancel.
• domainoptional
  string Optional; read from the order when absent.
• reasonoptional
  string Why the order is cancelled.

Follow a booking or cancellation request until a person approves or rejects it, and read the outcome.

Read only.

Tool signatureget_proposal_status(
  proposalId*: string,
  waitSeconds?: number
)
// * required   ? optional

Arguments

• proposalIdrequired
  string The proposalId the money tool returned.
• waitSecondsoptional
  number How long to wait for a person to decide, 0 to 60 seconds; 0 answers at once.

What your account can sell, product by product, and which steps each supports.

Read only.

Tool signaturev1_capabilities(
  domain?: string
)
// * required   ? optional

Arguments

• domainoptional
  string Canonical product code or alias from the capabilities document (HTL, FLT, EXP, ...).

Start a search for any product your account sells.

Read only.

Tool signaturev1_search(
  domain*: string,
  intent*: object
)
// * required   ? optional

Arguments

• domainrequired
  string Canonical product code or alias from the capabilities document (HTL, FLT, EXP, ...).
• intentrequired
  object The verb's `message` body exactly as the public API takes it.

Poll, page and filter the results of a search that is still running.

Read only.

Tool signaturev1_search_poll(
  searchRef*: string,
  cursor?: string
)
// * required   ? optional

Arguments

• searchRefrequired
  string The search to poll, as v1_search returned it in context.searchRef.
• cursoroptional
  string The nextCursor of the previous page; absent for the first page.

The second step of a round-trip flight search. List the return flights for a chosen outbound, or choose one.

Read only.

Tool signatureflight_returns(
  body*: FlightReturnsRequest
)
// * required   ? optional

Arguments

• bodyrequired
  FlightReturnsRequest The unified envelope, context.domain FLT.

  FlightReturnsRequest: 2 fields

  • contextrequired
    MondeeContext Request context envelope.

    MondeeContext: 13 fields

    • actionoptional
      string Mirrors the verb; optional (server sets from route).
    • clientReferenceoptional
      string Caller's own id; searchable; the reconciliation primitive.
    • currencyoptional
      string ISO-4217; absent = tenant default; blank/invalid = 400.
    • domainrequired
      string Canonical code or alias per the domain registry; unknown = 400 UNKNOWN_DOMAIN.
    • enrichoptional
      array of string Opt-in enrichment on shopping answers: EMISSIONS | RATINGS | AMENITIES | ROUTE.
    • fareSourcePolicyoptional
      enum BYOC tenants only; narrows, never widens, the configured strategy.DEFAULTOWN_ONLYMONDEE_ONLYBLEND
    • includeUpstreamoptional
      boolean Ask for the supplier's own answer, verbatim, beside what the platform read from it: Offer.upstream on every offer of a search, poll, detail or flight-returns answer, AirReturnOption.upstream on each ….
    • localeoptional
      string The language and region for text in the answer, as a BCP 47 tag (for example en-US).
    • onBehalfOfoptional
      OnBehalfOf Who a desk or agent books FOR: stamped into the audit actor and the clientReference lineage of the order.

      OnBehalfOf: 2 fields

      • customerIdoptional
        string A customer or traveller id your own system knows.
      • traveleroptional
        string Free-text traveller identity when there is no customer id.
    • posoptional
      string Point-of-sale market, orthogonal to tenant.
    • selectionoptional
      SelectionPreferences Context.selection: the caller's offer-selection preferences for this search.

      SelectionPreferences: 4 fields

      • excludeSuppliersoptional
        array of string Supplier codes whose offers this search does not show; narrows only.
      • objectiveoptional
        enum How the winner of an item is picked.CHEAPESTREFUNDABLE_FIRSTPREFERRED_SUPPLIERSPLATFORM_DEFAULT
      • preferSuppliersoptional
        array of string Supplier codes as in fareSource.supplier, most preferred first (PREFERRED_SUPPLIERS).
      • viewoptional
        enum SELECTED (one entry per item, alternatives under the winner) or ALL (the flat list, tagged).SELECTEDALL
    • session_idoptional
      string Your own id for the user session the call belongs to.
    • transaction_idoptional
      string Constant across one shop-to-book journey.
  • messagerequired
    object The request: `message.intent` names the outbound offer and, to choose one, the return.

    1 field

    • intentrequired
      object Send offerRef alone to list the returns of that outbound; add returnOption to choose one.

      2 fields

      • offerRefrequired
        string An OUTBOUND_FIRST FLT offer whose journey is not complete.
      • returnOptionoptional
        string A key from the latest listing of this offer (AirReturnOption.key).

Full details of one offer or product.

Read only.

Tool signaturev1_detail(
  domain*: string,
  message*: object
)
// * required   ? optional

Arguments

• domainrequired
  string Canonical product code or alias from the capabilities document (HTL, FLT, EXP, ...).
• messagerequired
  object The verb's `message` body exactly as the public API takes it.

Fare rules, cancellation policy and terms for an offer, before you book.

Read only.

Tool signaturev1_rules(
  domain*: string,
  message*: object
)
// * required   ? optional

Arguments

• domainrequired
  string Canonical product code or alias from the capabilities document (HTL, FLT, EXP, ...).
• messagerequired
  object The verb's `message` body exactly as the public API takes it.

Departure, sailing and showtime calendars.

Read only.

Tool signatureget_schedules(
  body*: SchedulesRequest
)
// * required   ? optional

Arguments

• bodyrequired
  SchedulesRequest The departures, sailings or showtimes of a product, in the request envelope.

  SchedulesRequest: 2 fields

  • contextrequired
    MondeeContext Request context envelope.

    MondeeContext: 13 fields

    • actionoptional
      string Mirrors the verb; optional (server sets from route).
    • clientReferenceoptional
      string Caller's own id; searchable; the reconciliation primitive.
    • currencyoptional
      string ISO-4217; absent = tenant default; blank/invalid = 400.
    • domainrequired
      string Canonical code or alias per the domain registry; unknown = 400 UNKNOWN_DOMAIN.
    • enrichoptional
      array of string Opt-in enrichment on shopping answers: EMISSIONS | RATINGS | AMENITIES | ROUTE.
    • fareSourcePolicyoptional
      enum BYOC tenants only; narrows, never widens, the configured strategy.DEFAULTOWN_ONLYMONDEE_ONLYBLEND
    • includeUpstreamoptional
      boolean Ask for the supplier's own answer, verbatim, beside what the platform read from it: Offer.upstream on every offer of a search, poll, detail or flight-returns answer, AirReturnOption.upstream on each ….
    • localeoptional
      string The language and region for text in the answer, as a BCP 47 tag (for example en-US).
    • onBehalfOfoptional
      OnBehalfOf Who a desk or agent books FOR: stamped into the audit actor and the clientReference lineage of the order.

      OnBehalfOf: 2 fields

      • customerIdoptional
        string A customer or traveller id your own system knows.
      • traveleroptional
        string Free-text traveller identity when there is no customer id.
    • posoptional
      string Point-of-sale market, orthogonal to tenant.
    • selectionoptional
      SelectionPreferences Context.selection: the caller's offer-selection preferences for this search.

      SelectionPreferences: 4 fields

      • excludeSuppliersoptional
        array of string Supplier codes whose offers this search does not show; narrows only.
      • objectiveoptional
        enum How the winner of an item is picked.CHEAPESTREFUNDABLE_FIRSTPREFERRED_SUPPLIERSPLATFORM_DEFAULT
      • preferSuppliersoptional
        array of string Supplier codes as in fareSource.supplier, most preferred first (PREFERRED_SUPPLIERS).
      • viewoptional
        enum SELECTED (one entry per item, alternatives under the winner) or ALL (the flat list, tagged).SELECTEDALL
    • session_idoptional
      string Your own id for the user session the call belongs to.
    • transaction_idoptional
      string Constant across one shop-to-book journey.
  • messagerequired
    object The request: `message.intent` names the product and dates to list.

The seat, berth, cabin or table map of an offer.

Read only.

Tool signatureget_seatmap(
  body*: SeatmapRequest
)
// * required   ? optional

Arguments

• bodyrequired
  SeatmapRequest The seat, berth, cabin or table map of a selection, in the request envelope.

  SeatmapRequest: 2 fields

  • contextrequired
    MondeeContext Request context envelope.

    MondeeContext: 13 fields

    • actionoptional
      string Mirrors the verb; optional (server sets from route).
    • clientReferenceoptional
      string Caller's own id; searchable; the reconciliation primitive.
    • currencyoptional
      string ISO-4217; absent = tenant default; blank/invalid = 400.
    • domainrequired
      string Canonical code or alias per the domain registry; unknown = 400 UNKNOWN_DOMAIN.
    • enrichoptional
      array of string Opt-in enrichment on shopping answers: EMISSIONS | RATINGS | AMENITIES | ROUTE.
    • fareSourcePolicyoptional
      enum BYOC tenants only; narrows, never widens, the configured strategy.DEFAULTOWN_ONLYMONDEE_ONLYBLEND
    • includeUpstreamoptional
      boolean Ask for the supplier's own answer, verbatim, beside what the platform read from it: Offer.upstream on every offer of a search, poll, detail or flight-returns answer, AirReturnOption.upstream on each ….
    • localeoptional
      string The language and region for text in the answer, as a BCP 47 tag (for example en-US).
    • onBehalfOfoptional
      OnBehalfOf Who a desk or agent books FOR: stamped into the audit actor and the clientReference lineage of the order.

      OnBehalfOf: 2 fields

      • customerIdoptional
        string A customer or traveller id your own system knows.
      • traveleroptional
        string Free-text traveller identity when there is no customer id.
    • posoptional
      string Point-of-sale market, orthogonal to tenant.
    • selectionoptional
      SelectionPreferences Context.selection: the caller's offer-selection preferences for this search.

      SelectionPreferences: 4 fields

      • excludeSuppliersoptional
        array of string Supplier codes whose offers this search does not show; narrows only.
      • objectiveoptional
        enum How the winner of an item is picked.CHEAPESTREFUNDABLE_FIRSTPREFERRED_SUPPLIERSPLATFORM_DEFAULT
      • preferSuppliersoptional
        array of string Supplier codes as in fareSource.supplier, most preferred first (PREFERRED_SUPPLIERS).
      • viewoptional
        enum SELECTED (one entry per item, alternatives under the winner) or ALL (the flat list, tagged).SELECTEDALL
    • session_idoptional
      string Your own id for the user session the call belongs to.
    • transaction_idoptional
      string Constant across one shop-to-book journey.
  • messagerequired
    object The request: `message.intent` names the selection whose map is read.

The extras you can add to an offer before booking.

Read only.

Tool signaturelist_ancillaries(
  body*: AncillariesRequest
)
// * required   ? optional

Arguments

• bodyrequired
  AncillariesRequest The extras (bags, seats, early check-in and the like) a selection can take before booking: send a repriceRef or an offerRef.

  AncillariesRequest: 2 fields

  • contextrequired
    MondeeContext Request context envelope.

    MondeeContext: 13 fields

    • actionoptional
      string Mirrors the verb; optional (server sets from route).
    • clientReferenceoptional
      string Caller's own id; searchable; the reconciliation primitive.
    • currencyoptional
      string ISO-4217; absent = tenant default; blank/invalid = 400.
    • domainrequired
      string Canonical code or alias per the domain registry; unknown = 400 UNKNOWN_DOMAIN.
    • enrichoptional
      array of string Opt-in enrichment on shopping answers: EMISSIONS | RATINGS | AMENITIES | ROUTE.
    • fareSourcePolicyoptional
      enum BYOC tenants only; narrows, never widens, the configured strategy.DEFAULTOWN_ONLYMONDEE_ONLYBLEND
    • includeUpstreamoptional
      boolean Ask for the supplier's own answer, verbatim, beside what the platform read from it: Offer.upstream on every offer of a search, poll, detail or flight-returns answer, AirReturnOption.upstream on each ….
    • localeoptional
      string The language and region for text in the answer, as a BCP 47 tag (for example en-US).
    • onBehalfOfoptional
      OnBehalfOf Who a desk or agent books FOR: stamped into the audit actor and the clientReference lineage of the order.

      OnBehalfOf: 2 fields

      • customerIdoptional
        string A customer or traveller id your own system knows.
      • traveleroptional
        string Free-text traveller identity when there is no customer id.
    • posoptional
      string Point-of-sale market, orthogonal to tenant.
    • selectionoptional
      SelectionPreferences Context.selection: the caller's offer-selection preferences for this search.

      SelectionPreferences: 4 fields

      • excludeSuppliersoptional
        array of string Supplier codes whose offers this search does not show; narrows only.
      • objectiveoptional
        enum How the winner of an item is picked.CHEAPESTREFUNDABLE_FIRSTPREFERRED_SUPPLIERSPLATFORM_DEFAULT
      • preferSuppliersoptional
        array of string Supplier codes as in fareSource.supplier, most preferred first (PREFERRED_SUPPLIERS).
      • viewoptional
        enum SELECTED (one entry per item, alternatives under the winner) or ALL (the flat list, tagged).SELECTEDALL
    • session_idoptional
      string Your own id for the user session the call belongs to.
    • transaction_idoptional
      string Constant across one shop-to-book journey.
  • messagerequired
    object The request: `message.intent` names the selection, a repriceRef or an offerRef.

A firm, live price for an offer. Always fresh, never cached.

Read only.

Tool signaturev1_reprice(
  domain*: string,
  message*: object
)
// * required   ? optional

Arguments

• domainrequired
  string Canonical product code or alias from the capabilities document (HTL, FLT, EXP, ...).
• messagerequired
  object The verb's `message` body exactly as the public API takes it.

Reserve an offer without paying, where the supplier allows it.

Makes a change that moves no money. It runs only where your account lets agents make changes; otherwise the agent is told the change needs approval.

Tool signaturev1_hold(
  domain*: string,
  message*: object,
  idempotencyKey*: string (uuid)
)
// * required   ? optional

Arguments

• domainrequired
  string Canonical product code or alias from the capabilities document (HTL, FLT, EXP, ...).
• messagerequired
  object The verb's `message` body exactly as the public API takes it.
• idempotencyKeyrequired
  string (uuid) Idempotency-Key.

The state of an order and each of its items, by order reference or by your own reference.

Read only.

Tool signatureget_trip_status(
  orderRef?: string,
  clientReference?: string,
  domain?: string
)
// * required   ? optional

Arguments

• orderRefoptional
  string The order to read; or send clientReference.
• clientReferenceoptional
  string Your own reference given at booking, to find the order without its orderRef.
• domainoptional
  string Canonical product code or alias from the capabilities document (HTL, FLT, EXP, ...).

Find orders by your own reference, traveller, date, product or state.

Read only.

Tool signaturev1_orders_search(
  domain*: string,
  message*: object
)
// * required   ? optional

Arguments

• domainrequired
  string Canonical product code or alias from the capabilities document (HTL, FLT, EXP, ...).
• messagerequired
  object The verb's `message` body exactly as the public API takes it.

One order and the state of each of its items.

Read only.

Tool signaturev1_orders_get(
  orderRef*: string
)
// * required   ? optional

Arguments

• orderRefrequired
  string The order, by its orderRef.

An order's timeline, its events oldest first.

Read only.

Tool signaturelist_order_events(
  cursor?: string,
  orderRef*: string,
  type?: string
)
// * required   ? optional

Arguments

• cursoroptional
  string The nextCursor of the previous page; absent for the first page.
• orderRefrequired
  string MO-XXX-XXX-XXX; BK- retained as read alias.
• typeoptional
  string Only events of this type, for example order.state_changed.

The booking's tickets, read live from the supplier.

Read only.

Resourceresources/read aikonic://public/get_order_tickets/{orderRef}

Arguments

• orderRefrequired
  string MO-XXX-XXX-XXX; BK- retained as read alias.

The booked fare's rule text, read live from the supplier.

Read only.

Resourceresources/read aikonic://public/get_order_fare_rules/{orderRef}

Arguments

• orderRefrequired
  string MO-XXX-XXX-XXX; BK- retained as read alias.

Trip page data for one order. Flight status, weather, entry requirements and route estimates.

Read only.

Resourceresources/read aikonic://public/get_order_enrichment/{orderRef}

Arguments

• orderRefrequired
  string MO-XXX-XXX-XXX; BK- retained as read alias.

An order's vouchers, e-tickets, invoices and QR codes.

Read only.

Resourceresources/read aikonic://public/list_order_documents/{orderRef}

Arguments

• orderRefrequired
  string MO-XXX-XXX-XXX; BK- retained as read alias.

Regenerate an order's documents, such as vouchers and invoices.

Makes a change that moves no money. It runs only where your account lets agents make changes; otherwise the agent is told the change needs approval.

Tool signatureregenerate_order_documents(
  orderRef*: string
)
// * required   ? optional

Arguments

• orderRefrequired
  string MO-XXX-XXX-XXX; BK- retained as read alias.

Get a one-time upload slot for a file a booking asks for, such as a travel document.

Makes a change that moves no money. It runs only where your account lets agents make changes; otherwise the agent is told the change needs approval.

Tool signaturecreate_upload(
  body*: UploadRequest,
  idempotencyKey*: string (uuid)
)
// * required   ? optional

Arguments

• bodyrequired
  UploadRequest Ask for a pre-signed upload slot for one file answer (POST /v1/uploads).

  UploadRequest: 6 fields

  • contentTyperequired
    string The file's media type, for example application/pdf.
  • fieldoptional
    string The RequiredInfo.field this upload answers, when known.
  • fileNamerequired
    string The file's name, for the record.
  • offerRefoptional
    string The offer the answer is for, when known.
  • purposeoptional
    string Mirrors FileAnswerSpec.purpose; the platform pins retention and data class from it.
  • sizeBytesrequired
    integer The file's size in bytes.
• idempotencyKeyrequired
  string (uuid) Mandatory on mutations: **48h TTL**; replay with same body-hash returns the original response with Idempotency-Replayed true; same key + different body is 409 ….

Whether a file reached its upload slot and passed scanning.

Read only.

Resourceresources/read aikonic://public/get_upload/{uploadId}

Arguments

• uploadIdrequired
  string The upload slot to read, as the upload call returned it.

Preview the cancellation penalty of a booking before cancelling.

Read only.

Tool signaturev1_orders_cancel_quote(
  orderRef*: string,
  domain*: string,
  message?: object
)
// * required   ? optional

Arguments

• orderRefrequired
  string The order, by its orderRef.
• domainrequired
  string Canonical product code or alias from the capabilities document (HTL, FLT, EXP, ...).
• messageoptional
  object The verb's `message` body exactly as the public API takes it.

Replay the events your webhooks may have missed.

Read only.

Tool signaturelist_events(
  cursor?: string,
  type?: string
)
// * required   ? optional

Arguments

• cursoroptional
  string The nextCursor of the previous page; absent for the first page.
• typeoptional
  string Only events of this type, for example order.state_changed.

Send an enquiry to a supplier that takes leads only, such as private dining. Nothing is priced, held or booked.

Makes a change that moves no money. It runs only where your account lets agents make changes; otherwise the agent is told the change needs approval.

Tool signaturecreate_enquiry(
  body*: EnquiryCreateRequest,
  idempotencyKey*: string (uuid)
)
// * required   ? optional

Arguments

• bodyrequired
  EnquiryCreateRequest A lead to a supplier that takes enquiries, not bookings (Example Dining private dining; any other lead-only supplier).

  EnquiryCreateRequest: 2 fields

  • contextrequired
    MondeeContext Request context envelope.

    MondeeContext: 13 fields

    • actionoptional
      string Mirrors the verb; optional (server sets from route).
    • clientReferenceoptional
      string Caller's own id; searchable; the reconciliation primitive.
    • currencyoptional
      string ISO-4217; absent = tenant default; blank/invalid = 400.
    • domainrequired
      string Canonical code or alias per the domain registry; unknown = 400 UNKNOWN_DOMAIN.
    • enrichoptional
      array of string Opt-in enrichment on shopping answers: EMISSIONS | RATINGS | AMENITIES | ROUTE.
    • fareSourcePolicyoptional
      enum BYOC tenants only; narrows, never widens, the configured strategy.DEFAULTOWN_ONLYMONDEE_ONLYBLEND
    • includeUpstreamoptional
      boolean Ask for the supplier's own answer, verbatim, beside what the platform read from it: Offer.upstream on every offer of a search, poll, detail or flight-returns answer, AirReturnOption.upstream on each ….
    • localeoptional
      string The language and region for text in the answer, as a BCP 47 tag (for example en-US).
    • onBehalfOfoptional
      OnBehalfOf Who a desk or agent books FOR: stamped into the audit actor and the clientReference lineage of the order.

      OnBehalfOf: 2 fields

      • customerIdoptional
        string A customer or traveller id your own system knows.
      • traveleroptional
        string Free-text traveller identity when there is no customer id.
    • posoptional
      string Point-of-sale market, orthogonal to tenant.
    • selectionoptional
      SelectionPreferences Context.selection: the caller's offer-selection preferences for this search.

      SelectionPreferences: 4 fields

      • excludeSuppliersoptional
        array of string Supplier codes whose offers this search does not show; narrows only.
      • objectiveoptional
        enum How the winner of an item is picked.CHEAPESTREFUNDABLE_FIRSTPREFERRED_SUPPLIERSPLATFORM_DEFAULT
      • preferSuppliersoptional
        array of string Supplier codes as in fareSource.supplier, most preferred first (PREFERRED_SUPPLIERS).
      • viewoptional
        enum SELECTED (one entry per item, alternatives under the winner) or ALL (the flat list, tagged).SELECTEDALL
    • session_idoptional
      string Your own id for the user session the call belongs to.
    • transaction_idoptional
      string Constant across one shop-to-book journey.
  • messagerequired
    object The request: `message.intent` is the lead.

    1 field

    • intentrequired
      EnquiryIntent The lead.

      EnquiryIntent: 8 fields

      • clientReferenceoptional
        string Your own reference for the lead, returned on the enquiry.
      • contactrequired
        object Who the venue should contact; personal data, sent to the venue and never echoed back.
      • eventDaterequired
        string (date) Date of the event, in the future.
      • eventTimerequired
        string Start time of the event, 24-hour HH:MM, local to the venue.
      • eventTyperequired
        string The kind of event, from the venue's list (for example Birthday or CorporateEvent).
      • flexibleDateoptional
        boolean True when another date near eventDate would also work.
      • partySizerequired
        integer How many guests.
      • productIdrequired
        string The venue the lead is for (for dining, the restaurant id).
• idempotencyKeyrequired
  string (uuid) Mandatory on mutations: **48h TTL**; replay with same body-hash returns the original response with Idempotency-Replayed true; same key + different body is 409 ….

Your enquiries, newest first.

Read only.

Tool signaturelist_enquiries(
  createdAfter?: string (date-time),
  cursor?: string,
  domain?: string,
  limit?: integer,
  status?: string
)
// * required   ? optional

Arguments

• createdAfteroptional
  string (date-time) Only enquiries created after this instant.
• cursoroptional
  string Opaque; the message.nextCursor of the previous page.
• domainoptional
  string Only this domain (code or alias).
• limitoptional
  integer Page size (1-100); absent = 25.
• statusoptional
  string Only enquiries in this state (SUBMITTED, UNCONFIRMED, FAILED).

One enquiry and its current state.

Read only.

Resourceresources/read aikonic://public/get_enquiry/{enquiryRef}

Arguments

• enquiryRefrequired
  string EN-XXX-XXX-XXX from POST /v1/enquiries.

Search reference data, such as places and codes.

Read only.

Tool signaturev1_lookup(
  type*: string,
  q?: string,
  cursor?: string
)
// * required   ? optional

Arguments

• typerequired
  string What to look up, for example airports, cities or currencies.
• qoptional
  string Text to match, for example part of a name.
• cursoroptional
  string The nextCursor of the previous page; absent for the first page.

One reference record, by its id.

Read only.

Tool signaturev1_lookup_record(
  type*: string,
  id*: string
)
// * required   ? optional

Arguments

• typerequired
  string What to look up, for example airports, cities or currencies.
• idrequired
  string The record's id, as a lookup listed it.

The documents a traveller needs between two countries. It is guidance, not an eligibility decision.

Read only.

Tool signatureget_entry_requirements(
  age?: integer,
  destination*: string,
  nationality*: string,
  origin*: string,
  purpose?: string,
  residence*: string,
  stayDays?: integer,
  transport?: string
)
// * required   ? optional

Arguments

• ageoptional
  integer The traveller's age in years, where requirements differ for minors.
• destinationrequired
  string Where the traveller enters, as a country code (ISO 3166-1 alpha-2).
• nationalityrequired
  string The traveller's nationality, as a country code (ISO 3166-1 alpha-2).
• originrequired
  string Where the traveller departs from, as a country code (ISO 3166-1 alpha-2).
• purposeoptional
  string The reason for the trip, for example TOURISM, BUSINESS, TRANSIT, STUDY or WORK.
• residencerequired
  string The traveller's country of residence, as a country code (ISO 3166-1 alpha-2), when it differs from the nationality.
• stayDaysoptional
  integer How many days the traveller stays.
• transportoptional
  string How the traveller arrives at the destination.

Public holidays and long weekends for a country.

Read only.

Tool signatureget_holidays(
  country*: string,
  from?: string (date),
  include?: string,
  subdivision?: string,
  to?: string (date)
)
// * required   ? optional

Arguments

• countryrequired
  string The country, as its ISO 3166-1 alpha-2 code.
• fromoptional
  string (date) First day of the range (inclusive).
• includeoptional
  string LONG_WEEKENDS to add the platform-computed long weekends; CELLS (planned) to add one HolidayCalendar.cells[] entry per day.
• subdivisionoptional
  string A state or region, as its ISO 3166-2 code, to add its own holidays.
• tooptional
  string (date) Last day of the range (inclusive).

Current, forecast or historical weather at a place.

Read only.

Tool signatureget_weather(
  from?: string (date),
  kind?: enum,
  place*: string,
  to?: string (date)
)
// * required   ? optional

Arguments

• fromoptional
  string (date) First day of the forecast or history (inclusive).
• kindoptional
  enum CURRENT for now, FORECAST for coming days or HISTORICAL for past days.CURRENTFORECASTHISTORICAL
• placerequired
  string A mondee:place:… id or an IATA code.
• tooptional
  string (date) Last day of the forecast or history (inclusive).

Operational status of a flight, one record per operated leg.

Read only.

Tool signatureget_flight_status(
  carrier*: string,
  date*: string (date),
  flightNumber*: string,
  origin?: string
)
// * required   ? optional

Arguments

• carrierrequired
  string The airline, as its two-character IATA code.
• daterequired
  string (date) The departure date, local to the departure airport.
• flightNumberrequired
  string The flight number without the airline code.
• originoptional
  string The departure airport, as its IATA code, to narrow a multi-leg flight to one leg.

The flown track of a flight, one record per operated leg that has taken off.

Read only.

Tool signatureget_flight_track(
  carrier*: string,
  date*: string (date),
  flightNumber*: string,
  origin?: string
)
// * required   ? optional

Arguments

• carrierrequired
  string The airline, as its two-character IATA code.
• daterequired
  string (date) The departure date, local to the departure airport.
• flightNumberrequired
  string The flight number without the airline code.
• originoptional
  string The departure airport, as its IATA code, to narrow a multi-leg flight to one leg.

Cabin amenities of a flight, with confidence.

Read only.

Tool signatureget_flight_amenities(
  cabin?: string,
  carrier*: string,
  date?: string (date),
  flightNumber*: string
)
// * required   ? optional

Arguments

• cabinoptional
  string Only this cabin, for example ECONOMY or BUSINESS; absent means every cabin.
• carrierrequired
  string The airline, as its two-character IATA code.
• dateoptional
  string (date) The departure date, local to the departure airport.
• flightNumberrequired
  string The flight number without the airline code.

On-time statistics for a flight number or a route.

Read only.

Tool signatureget_flight_ratings(
  carrier?: string,
  destination?: string,
  flightNumber?: string,
  origin?: string
)
// * required   ? optional

Arguments

• carrieroptional
  string The airline, as its two-character IATA code.
• destinationoptional
  string The arrival airport, as its IATA code, for a route.
• flightNumberoptional
  string The flight number without the airline code; send it, or origin and destination for a route.
• originoptional
  string The departure airport, as its IATA code, for a route.

Door-to-door time and distance per leg, or an origins × destinations matrix.

Read only.

Tool signatureget_route_estimates(
  body*: RouteEstimatesRequest
)
// * required   ? optional

Arguments

• bodyrequired
  RouteEstimatesRequest Body of POST /v1/enrichment/route-estimates — legs, or origins × destinations for a matrix.

  RouteEstimatesRequest: 6 fields

  • departAtoptional
    string (date-time) When the traveller sets off, for travel times that depend on traffic.
  • destinationsoptional
    array of PlaceRef One way to name a place, used by every intent that takes a location (ground waypoints, experiences pickup, lounge and airport-service stations, weather).

    PlaceRef: 6 fields

    • countryCodeoptional
      string The country, as its ISO 3166-1 alpha-2 code, to narrow the match.
    • geooptional
      GeoPoint A point on the map.

      GeoPoint: 2 fields

      • latrequired
        number Latitude, -90 to 90.
      • lonrequired
        number Longitude, -180 to 180.
    • iataoptional
      string An airport or rail station code.
    • placeIdoptional
      string A place id from the lookup calls, or a map provider's place id passed through as it is.
    • textoptional
      string Free text the platform resolves; never enough on its own to book.
    • timeZoneoptional
      string IANA time zone of the place (e.g.
  • legsoptional
    array of object The legs to estimate, at most 25.

    3 fields

    • destinationrequired
      PlaceRef One way to name a place, used by every intent that takes a location (ground waypoints, experiences pickup, lounge and airport-service stations, weather).

      PlaceRef: 6 fields

      • countryCodeoptional
        string The country, as its ISO 3166-1 alpha-2 code, to narrow the match.
      • geooptional
        GeoPoint A point on the map.
      • iataoptional
        string An airport or rail station code.
      • placeIdoptional
        string A place id from the lookup calls, or a map provider's place id passed through as it is.
      • textoptional
        string Free text the platform resolves; never enough on its own to book.
      • timeZoneoptional
        string IANA time zone of the place (e.g.
    • legRefoptional
      string Your own id for the leg, returned on its estimate.
    • originrequired
      PlaceRef One way to name a place, used by every intent that takes a location (ground waypoints, experiences pickup, lounge and airport-service stations, weather).

      PlaceRef: 6 fields

      • countryCodeoptional
        string The country, as its ISO 3166-1 alpha-2 code, to narrow the match.
      • geooptional
        GeoPoint A point on the map.
      • iataoptional
        string An airport or rail station code.
      • placeIdoptional
        string A place id from the lookup calls, or a map provider's place id passed through as it is.
      • textoptional
        string Free text the platform resolves; never enough on its own to book.
      • timeZoneoptional
        string IANA time zone of the place (e.g.
  • modesoptional
    array of string How the traveller moves, for example CAR.
  • originsoptional
    array of PlaceRef One way to name a place, used by every intent that takes a location (ground waypoints, experiences pickup, lounge and airport-service stations, weather).

    PlaceRef: 6 fields

    • countryCodeoptional
      string The country, as its ISO 3166-1 alpha-2 code, to narrow the match.
    • geooptional
      GeoPoint A point on the map.

      GeoPoint: 2 fields

      • latrequired
        number Latitude, -90 to 90.
      • lonrequired
        number Longitude, -180 to 180.
    • iataoptional
      string An airport or rail station code.
    • placeIdoptional
      string A place id from the lookup calls, or a map provider's place id passed through as it is.
    • textoptional
      string Free text the platform resolves; never enough on its own to book.
    • timeZoneoptional
      string IANA time zone of the place (e.g.
  • trafficoptional
    string LIVE | HISTORICAL | NONE.

CO2 emissions per passenger for flights, and typical emissions for routes.

Read only.

Tool signatureget_flight_emissions(
  body*: FlightEmissionsRequest
)
// * required   ? optional

Arguments

• bodyrequired
  FlightEmissionsRequest Body of POST /v1/enrichment/flight-emissions — lists outgrow query strings.

  FlightEmissionsRequest: 3 fields

  • cabinoptional
    string The cabin to estimate for, for example ECONOMY.
  • flightsoptional
    array of FlightKey The flights to estimate, at most 50.

    FlightKey: 6 fields

    • departureDaterequired
      string (date) Airport-local date.
    • destinationrequired
      string The arrival airport, as its IATA code.
    • flightNumberrequired
      string Normalised, no leading zeros.
    • marketingCarrieroptional
      string The airline that sells the flight, when it differs from the operating one.
    • operatingCarrierrequired
      string The airline that flies the aircraft, as its two-character IATA code.
    • originrequired
      string The departure airport, as its IATA code.
  • marketsoptional
    array of object Origin-destination pairs for typical emissions.

    2 fields

    • destinationrequired
      string The arrival airport of a market, as its IATA code.
    • originrequired
      string The departure airport of a market, as its IATA code.

Your account's emissions and carbon saved over a period.

Read only.

Tool signatureget_carbon_summary(
  from*: string (date),
  to*: string (date)
)
// * required   ? optional

Arguments

• fromrequired
  string (date) First day of the period (inclusive).
• torequired
  string (date) Last day of the period (inclusive).

Sync the static content catalogue, with a feed of what changed.

Read only.

Tool signaturesync_content(
  body*: ContentRequest
)
// * required   ? optional

Arguments

• bodyrequired
  ContentRequest Static content of a product catalog, or the changes since a previous sync, in the request envelope.

  ContentRequest: 2 fields

  • contextrequired
    MondeeContext Request context envelope.

    MondeeContext: 13 fields

    • actionoptional
      string Mirrors the verb; optional (server sets from route).
    • clientReferenceoptional
      string Caller's own id; searchable; the reconciliation primitive.
    • currencyoptional
      string ISO-4217; absent = tenant default; blank/invalid = 400.
    • domainrequired
      string Canonical code or alias per the domain registry; unknown = 400 UNKNOWN_DOMAIN.
    • enrichoptional
      array of string Opt-in enrichment on shopping answers: EMISSIONS | RATINGS | AMENITIES | ROUTE.
    • fareSourcePolicyoptional
      enum BYOC tenants only; narrows, never widens, the configured strategy.DEFAULTOWN_ONLYMONDEE_ONLYBLEND
    • includeUpstreamoptional
      boolean Ask for the supplier's own answer, verbatim, beside what the platform read from it: Offer.upstream on every offer of a search, poll, detail or flight-returns answer, AirReturnOption.upstream on each ….
    • localeoptional
      string The language and region for text in the answer, as a BCP 47 tag (for example en-US).
    • onBehalfOfoptional
      OnBehalfOf Who a desk or agent books FOR: stamped into the audit actor and the clientReference lineage of the order.

      OnBehalfOf: 2 fields

      • customerIdoptional
        string A customer or traveller id your own system knows.
      • traveleroptional
        string Free-text traveller identity when there is no customer id.
    • posoptional
      string Point-of-sale market, orthogonal to tenant.
    • selectionoptional
      SelectionPreferences Context.selection: the caller's offer-selection preferences for this search.

      SelectionPreferences: 4 fields

      • excludeSuppliersoptional
        array of string Supplier codes whose offers this search does not show; narrows only.
      • objectiveoptional
        enum How the winner of an item is picked.CHEAPESTREFUNDABLE_FIRSTPREFERRED_SUPPLIERSPLATFORM_DEFAULT
      • preferSuppliersoptional
        array of string Supplier codes as in fareSource.supplier, most preferred first (PREFERRED_SUPPLIERS).
      • viewoptional
        enum SELECTED (one entry per item, alternatives under the winner) or ALL (the flat list, tagged).SELECTEDALL
    • session_idoptional
      string Your own id for the user session the call belongs to.
    • transaction_idoptional
      string Constant across one shop-to-book journey.
  • messagerequired
    object The request: `message.intent` names the catalog and, for a delta, where the last sync stopped.

Your wallets, one per settlement currency.

Read only.

Resourceresources/read aikonic://public/list_wallets{?environment}

Arguments

• environmentoptional
  WalletEnvironment Which side of the sandbox/production tenant pair to read or act on.PRODUCTIONSANDBOX

One wallet. Balance, held and available funds, and how to top it up.

Read only.

Resourceresources/read aikonic://public/get_wallet/{currency}{?environment}

Arguments

• currencyrequired
  string The wallet's settlement currency, ISO-4217.
• environmentoptional
  WalletEnvironment Which side of the sandbox/production tenant pair to read or act on.PRODUCTIONSANDBOX

Your wallet's movements, newest first.

Read only.

Tool signaturelist_wallet_transactions(
  currency*: string,
  cursor?: string,
  environment?: WalletEnvironment,
  limit?: integer,
  orderRef?: string,
  type?: string
)
// * required   ? optional

Arguments

• currencyrequired
  string The wallet's settlement currency, ISO-4217.
• cursoroptional
  string Opaque; the nextCursor of the previous page.
• environmentoptional
  WalletEnvironment Which side of the sandbox/production tenant pair to read or act on.PRODUCTIONSANDBOX
• limitoptional
  integer Page size; default 20 [assumption].
• orderRefoptional
  string Only the legs of this order.
• typeoptional
  string Only legs of this type (WALLET_TOPUP | WALLET_HOLD | WALLET_SETTLE | WALLET_RELEASE | WALLET_FEE).

Your webhook subscriptions.

Read only.

Resourceresources/read aikonic://public/list_webhooks

Arguments

A resource takes no arguments: the agent reads it by its address.

One webhook subscription. Its signing secret is never shown again.

Read only.

Resourceresources/read aikonic://public/get_webhook/{webhookId}

Arguments

• webhookIdrequired
  string The subscription to read, as creating it returned it.

The delivery log of one webhook subscription, with every attempt.

Read only.

Tool signaturelist_webhook_deliveries(
  cursor?: string,
  eventId?: string,
  limit?: integer,
  state?: string,
  webhookId*: string
)
// * required   ? optional

Arguments

• cursoroptional
  string The nextCursor of the previous page; absent for the first page.
• eventIdoptional
  string Only the delivery of this event.
• limitoptional
  integer Page size; default 20 [assumption].
• stateoptional
  string PENDING | DELIVERED | DEAD_LETTERED | CANCELLED — filter by delivery state.
• webhookIdrequired
  string The webhookId returned by POST /v1/webhooks.

Your published markup rule set and its version.

Read only.

Resourceresources/read aikonic://public/get_rule_set{?version}

Arguments

• versionoptional
  integer A prior immutable rule-set version to read (absent = current published).

Price sample offers against a draft or published markup rule set, without changing any price.

Read only.

Tool signaturesimulate_rule_set(
  body*: RuleSimulationRequest
)
// * required   ? optional

Arguments

• bodyrequired
  RuleSimulationRequest Envelope in; context.domain is the samples' product.

  RuleSimulationRequest: 2 fields

  • contextrequired
    MondeeContext Request context envelope.

    MondeeContext: 13 fields

    • actionoptional
      string Mirrors the verb; optional (server sets from route).
    • clientReferenceoptional
      string Caller's own id; searchable; the reconciliation primitive.
    • currencyoptional
      string ISO-4217; absent = tenant default; blank/invalid = 400.
    • domainrequired
      string Canonical code or alias per the domain registry; unknown = 400 UNKNOWN_DOMAIN.
    • enrichoptional
      array of string Opt-in enrichment on shopping answers: EMISSIONS | RATINGS | AMENITIES | ROUTE.
    • fareSourcePolicyoptional
      enum BYOC tenants only; narrows, never widens, the configured strategy.DEFAULTOWN_ONLYMONDEE_ONLYBLEND
    • includeUpstreamoptional
      boolean Ask for the supplier's own answer, verbatim, beside what the platform read from it: Offer.upstream on every offer of a search, poll, detail or flight-returns answer, AirReturnOption.upstream on each ….
    • localeoptional
      string The language and region for text in the answer, as a BCP 47 tag (for example en-US).
    • onBehalfOfoptional
      OnBehalfOf Who a desk or agent books FOR: stamped into the audit actor and the clientReference lineage of the order.

      OnBehalfOf: 2 fields

      • customerIdoptional
        string A customer or traveller id your own system knows.
      • traveleroptional
        string Free-text traveller identity when there is no customer id.
    • posoptional
      string Point-of-sale market, orthogonal to tenant.
    • selectionoptional
      SelectionPreferences Context.selection: the caller's offer-selection preferences for this search.

      SelectionPreferences: 4 fields

      • excludeSuppliersoptional
        array of string Supplier codes whose offers this search does not show; narrows only.
      • objectiveoptional
        enum How the winner of an item is picked.CHEAPESTREFUNDABLE_FIRSTPREFERRED_SUPPLIERSPLATFORM_DEFAULT
      • preferSuppliersoptional
        array of string Supplier codes as in fareSource.supplier, most preferred first (PREFERRED_SUPPLIERS).
      • viewoptional
        enum SELECTED (one entry per item, alternatives under the winner) or ALL (the flat list, tagged).SELECTEDALL
    • session_idoptional
      string Your own id for the user session the call belongs to.
    • transaction_idoptional
      string Constant across one shop-to-book journey.
  • messagerequired
    object The request: `message.intent` carries the candidate rules and the samples to price.

    1 field

    • intentrequired
      object `samples` or `sampleRecent`.

      3 fields

      • ruleSetoptional
        object Candidate — a draft `rules` list or a stored `version`; absent = current published.
      • sampleRecentoptional
        object Replay this tenant's recent RP- snapshots as samples instead of listing them.
      • samplesoptional
        array of RuleSimulationSample One sample to price.