Flight returns

Headers

• TeststringOptional
  Sandbox scenario simulation: price_changed | sold_out | ambiguous | hold_expired | payment_declined | supplier_timeout | partial_search | duplicate_order (case-insensitive).Show more

  Sandbox scenario simulation: price_changed | sold_out | ambiguous | hold_expired | payment_declined | supplier_timeout | partial_search | duplicate_order (case-insensitive). Read on every travel verb before the permission wall and idempotency; a scenario sent on a verb it does not apply to has no effect. Every simulated error carries details.simulated true and details.scenario. price_changed (reprice, hold, orders) → 409 PRICE_CHANGED; sold_out → 422 SOLD_OUT; hold_expired (orders) → 409 HOLD_EXPIRED; duplicate_order (orders) → 409 DUPLICATE_ORDER existingOrderRef MO-SIM-DUPLICATE; payment_declined (orders, POST /v1/payments/{paymentId}/confirm) → 402 PAYMENT_FAILED; supplier_timeout → 502 UPSTREAM_UNAVAILABLE; partial_search (search) → two SUPPLIER_DROPPED warnings; ambiguous (orders) → 202 PENDING_RECONCILIATION on an MO-SIM- ref. wallet_insufficient → 402 PAYMENT_FAILED details.reason WALLET_INSUFFICIENT.

Request bodyFlightReturnsRequest

• contextMondeeContextRequired
  Request context envelope. domain selects the product; URL carries the verb.
  13 child attributes

  • domainstringRequired
    Canonical code or alias per the domain registry; unknown = 400 UNKNOWN_DOMAIN.Show more

    Canonical code or alias per the domain registry; unknown = 400 UNKNOWN_DOMAIN. APTSVC (airport services: meet and assist, porter, buggy, wheelchair, concierge bundles) is registered by this release beside FASTTRK. FNB (dining: restaurant reservations; aliases REST, DINING, RESTAURANT, RESTAURANTS; category DO, money model FREE, artifact CONF_NUMBER, served under the dining service key with base path /v1/dining) is registered since v1.7.0. GIFT (gift cards; category SUPPORT, money model MERCHANT, artifact VOUCHER, served under the gift-cards service key with base path /v1/gift-cards) is described from v1.31.0: until the backend seam change merges, domain GIFT answers 400 UNKNOWN_DOMAIN. AICONT (the Example Content experience-scraping service's operations; category DO, money model MERCHANT, artifact NONE, served under the aicont service key with base path /v1/aicont; a content supplier) has its typed intent from v1.39.0; it answers only where its supplier set is landed and ACTIVE. PARK (airport and cruise-port parking; aliases PRK and PARKING; category SUPPORT, money model MERCHANT, artifact CONF_NUMBER — the supplier's gate barcode is the order's BARCODE document — served under the parking service key with base path /v1/parking) has its typed intent and its verb book from v1.55.0.
  • actionstringOptional
    Mirrors the verb; optional (server sets from route)
  • enricharray of stringOptional
    Opt-in enrichment on shopping answers: EMISSIONS | RATINGS | AMENITIES | ROUTE.Show more

    Opt-in enrichment on shopping answers: EMISSIONS | RATINGS | AMENITIES | ROUTE. Absent = the tenant's configured default. Decoration reads cache or the pre-warmed store only and never delays the verb.
  • session_idstringOptional
    Your own id for the user session the call belongs to.
  • transaction_idstringOptional
    Constant across one shop-to-book journey
  • currencystringOptional
    ISO-4217; absent = tenant default; blank/invalid = 400
  • localestringOptional
    The language and region for text in the answer, as a BCP 47 tag (for example en-US).
  • posstringOptional
    Point-of-sale market, orthogonal to tenant
  • clientReferencestringOptional
    Caller's own id; searchable; the reconciliation primitive
  • fareSourcePolicystringOptional
    BYOC tenants only; narrows, never widens, the configured strategy
    • DEFAULT
    • OWN_ONLY
    • MONDEE_ONLY
    • BLEND
  • includeUpstreambooleanOptionalDefault false
    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…Show more

    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 listed return, RepriceResponse.message.upstream and OrderItem.upstream. Served only where the deployment enables upstream pass-through; elsewhere a true value is 400 VALIDATION details.reason UPSTREAM_PASS_THROUGH_DISABLED, details.field context.includeUpstream, before any supplier call. Absent or false, nothing changes. The block is informational: offerRef, repriceRef and price stay the only handles and the only price of record.
  • selectionSelectionPreferencesOptional
    context.selection: the caller's offer-selection preferences for this search.Show more

    context.selection: the caller's offer-selection preferences for this search. Each field set here replaces the tenant's and the platform's for this search, within the caller's entitlements and the platform's ceilings, unless the tenant has locked request overrides. It never widens reach: a preferred supplier the caller may not reach is ignored with context.warnings[] SELECTION_PREFERENCE_IGNORED. Ignored where selection is off.
    4 child attributes

    • viewstringOptional
      SELECTED (one entry per item, alternatives under the winner) or ALL (the flat list, tagged)
      • SELECTED
      • ALL
    • objectivestringOptional
      How the winner of an item is picked. CHEAPEST is the lowest comparison total; REFUNDABLE_FIRST the lowest total among offers free to cancel now (else CHEAPEST); PREFERRED_SUPPLIERS the first of…Show more

      How the winner of an item is picked. CHEAPEST is the lowest comparison total; REFUNDABLE_FIRST the lowest total among offers free to cancel now (else CHEAPEST); PREFERRED_SUPPLIERS the first of preferSuppliers with an offer inside the tenant's preference band (else CHEAPEST); PLATFORM_DEFAULT defers to the tenant and platform policies. Any other value is 400 VALIDATION details.field context.selection.objective.
      • CHEAPEST
      • REFUNDABLE_FIRST
      • PREFERRED_SUPPLIERS
      • PLATFORM_DEFAULT
    • preferSuppliersarray of stringOptional
      Supplier codes as in fareSource.supplier, most preferred first (PREFERRED_SUPPLIERS)
    • excludeSuppliersarray of stringOptional
      Supplier codes whose offers this search does not show; narrows only
  • onBehalfOfOnBehalfOfOptional
    Who a desk or agent books FOR: stamped into the audit actor and the clientReference lineage of the order.Show more

    Who a desk or agent books FOR: stamped into the audit actor and the clientReference lineage of the order. Send customerId (a customer or traveller id the tenant knows) or traveler (a free-text identity), or both. Attribution only: it grants nothing, and the credential's own actor is still what authorises the call. Audit mapping: the audit actor.onBehalfOf (a string) is customerId when present, otherwise "traveler:<redacted-hash>" (a stable hash of traveler, never the text).
    2 child attributes

    • customerIdstringOptional
      A customer or traveller id your own system knows.
    • travelerstringOptional
      Free-text traveller identity when there is no customer id.Show more

      Free-text traveller identity when there is no customer id. Personal data: it is logged redacted, never in clear. A card number in it is 400 VALIDATION details.reason INSTRUMENT_DATA_REFUSED.
• messageobjectRequired
  The request: `message.intent` names the outbound offer and, to choose one, the return.
  1 child attribute

  • intentobjectRequired
    Send offerRef alone to list the returns of that outbound; add returnOption to choose one.
    2 child attributes

    • offerRefstringRequired
      An OUTBOUND_FIRST FLT offer whose journey is not complete (OF-F-...)
    • returnOptionstringOptional
      A key from the latest listing of this offer (AirReturnOption.key).Show more

      A key from the latest listing of this offer (AirReturnOption.key). Absent: list the options. Present: choose it.

Responses

• 200
  Listing: the outbound offer with returnOptions and returnOptionsComplete.Show more

  Listing: the outbound offer with returnOptions and returnOptionsComplete. Choosing: the offer narrowed under the same offerRef (FlightReturnsResponse).
  FlightReturnsResponse
• 400VALIDATION — a bad intent shape (BadRequest), or details.reason NOT_FLT_OFFER: the offerRef is not an FLT offer, or context.domain is not FLTApiErrorResponse
• 401
  UNAUTHENTICATED — missing or expired token.Show more

  UNAUTHENTICATED — missing or expired token. Declared on every operation because `security` is declared globally at the document root: every route is authenticated, so every route can answer 401.
  ApiErrorResponse
• 403
  PERMISSION_DENIED | TAB_DISABLED | OUT_OF_SCOPE | TENANT_MISMATCH, exactly as Forbidden, plus TENANT_SUSPENDED — declared on the verbs that start new business: search and poll, detail, schedules,…Show more

  PERMISSION_DENIED | TAB_DISABLED | OUT_OF_SCOPE | TENANT_MISMATCH, exactly as Forbidden, plus TENANT_SUSPENDED — declared on the verbs that start new business: search and poll, detail, schedules, seatmap, ancillaries, rules, reprice, hold and order create, and on the payments routes (intent, confirm, 3ds-callback, checkout-session). While the caller's tenant is SUSPENDED every such request is refused TENANT_SUSPENDED, except an idempotent replay of an answer completed before the suspension (see hold / createOrder), before the entitlement and permission checks, and it is not retryable: the answer changes only when platform ops reinstates the tenant. The post-booking verbs (cancel-quote, cancel, amend), the order reads, and capture and refund on an existing payment intent (whose 403 is PaymentForbidden) stay up, so no traveller is stranded. On the production deployment the same requests are refused PERMISSION_DENIED with details.reason TENANT_NOT_LIVE while the tenant's production activation has not been approved, whichever credential is presented, console session or API key; use the sandbox deployment until activation. Not retryable; the post-booking verbs stay up.
  ApiErrorResponse
• 404NOT_FOUND — an unknown offerRef (also another tenant's), or details.reason RETURN_OPTION_UNKNOWN: a returnOption key the latest listing of this offer did not answerApiErrorResponse
• 405
  VALIDATION — the public edge serves GET, POST, PUT, PATCH and DELETE only; any other method is refused before the platform sees it (details.reason METHOD_NOT_ALLOWED, details.source edge).Show more

  VALIDATION — the public edge serves GET, POST, PUT, PATCH and DELETE only; any other method is refused before the platform sees it (details.reason METHOD_NOT_ALLOWED, details.source edge). Not retryable as sent.
  ApiErrorResponse
• 409
  OFFER_EXPIRED (details.reason OFFER_EXPIRED) — the offer is past expiresAt; search again.Show more

  OFFER_EXPIRED (details.reason OFFER_EXPIRED) — the offer is past expiresAt; search again. Or CONFLICT details.reason JOURNEY_COMPLETE_ALREADY — the offer's journey is complete; reprice it
  ApiErrorResponse
• 413
  VALIDATION — the request body is larger than the surface's limit.Show more

  VALIDATION — the request body is larger than the surface's limit. Not retryable as sent: shrink the body. Declared on every operation that takes a request body. details carries exactly one key, maxBodyBytes (integer): the limit that applies to this surface, in bytes.
  ApiErrorResponse
• 414
  VALIDATION — the request URI (path and query string) is longer than 8 KiB; the public edge refuses it before the platform sees it (details.reason URI_TOO_LONG, details.source edge).Show more

  VALIDATION — the request URI (path and query string) is longer than 8 KiB; the public edge refuses it before the platform sees it (details.reason URI_TOO_LONG, details.source edge). Not retryable as sent: send long input in the body of a POST.
  ApiErrorResponse
• 415
  VALIDATION — a request body that is not JSON (application/json or application/*+json; a form body only on the OAuth token routes).Show more

  VALIDATION — a request body that is not JSON (application/json or application/*+json; a form body only on the OAuth token routes). The public edge refuses it before the platform sees it (details.reason UNSUPPORTED_MEDIA_TYPE, details.source edge). Not retryable as sent: send Content-Type application/json. Declared on every operation that takes a JSON request body.
  ApiErrorResponse
• 422
  SOLD_OUT with details.reason OFFER_UNSELLABLE — a drill-down (detail, rules) of an offer the tenant's pricing rules cannot sell.Show more

  SOLD_OUT with details.reason OFFER_UNSELLABLE — a drill-down (detail, rules) of an offer the tenant's pricing rules cannot sell. A drill-down shows one offer, so it cannot drop and count it as search does; it is refused, never answered at the supplier's net.
  ApiErrorResponse
• 429
  RATE_LIMITED — the API key or its tenant is over a rate limit; wait for Retry-After, then retry.Show more

  RATE_LIMITED — the API key or its tenant is over a rate limit; wait for Retry-After, then retry. Every routed request is counted against two token buckets, the key's and the tenant's (all its keys together): 50 requests a second with a burst of 100 on the standard plan. Every travel verb except polling a search also spends from a supplier budget, per key and per tenant: 10 requests a second with a burst of 20, and a plan may add a daily quota of supplier calls. Answers carry the IETF RateLimit header fields for the tightest bucket consulted (RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset, RateLimit-Policy); a refusal adds Retry-After and details.scope (KEY or TENANT), details.budget (PLATFORM or SUPPLIER), details.reason (RATE or DAILY_QUOTA), details.tier and details.retryAfterMs. A sandbox may run with the limiter off, in which case none of these headers is sent. A search that is still warming is a different answer with a different meaning (keep polling). with the key-velocity check on, also details.reason VELOCITY_LIMIT, a soft breach of the API key's own scope (components/responses/VelocityLimited), nextAction slow_down.
  ApiErrorResponse
• 500INTERNAL — a bug, and traceId is the support handle.ApiErrorResponse
• 501
  NOT_IMPLEMENTED — honest fallback; every production 501 is a capabilities-doc bug.Show more

  NOT_IMPLEMENTED — honest fallback; every production 501 is a capabilities-doc bug. Also the order read routes (getOrder, listOrderDocuments, listOrderEvents, searchOrders) on a deployment with no order reader assembled; not retryable.
  ApiErrorResponse
• 502Also the order read routes (getOrder, listOrderDocuments, listOrderEvents, searchOrders) when the order store times out: details.store names the store, retryable true.ApiErrorResponse
• 503ApiErrorResponse

Errors you should handle

Branch on code and honour retryable — never on the HTTP status alone.