API referenceorders

Cancel quote order

POST/v1/orders/{orderRef}/cancel-quote

Accepts X-Api-Key · oauthClientCredentials · bearer

Penalty preview before commitment

Path parameters

orderRefstringRequired
MO-XXX-XXX-XXX; BK- retained as read alias

Request bodyCancelQuoteRequest

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

Responses

200cancelQuoteRef + penalty breakdown + refund estimate + validUntilCancelQuoteResponse
400VALIDATION or UNKNOWN_DOMAINApiErrorResponse
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
AGENT_TIER_INSUFFICIENT, also 403, is a request whose agent tier does not allow the tool class; it carries nextAction verify_agent and details.tier, details.required, details.toolClass and…Show more
AGENT_TIER_INSUFFICIENT, also 403, is a request whose agent tier does not allow the tool class; it carries nextAction verify_agent and details.tier, details.required, details.toolClass and details.operationId. A ceiling only narrows an unverified caller and never widens a scope.
ApiErrorResponse
404NOT_FOUND — unknown or expired ref (unguessable refs, 15)ApiErrorResponse
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
CONFLICT | PENALTY_CHANGED. CONFLICT — the order's state forbids a quote: it is over, it has no supplier locator yet, or it is PENDING_RECONCILIATION (details.state names it).Show more
CONFLICT | PENALTY_CHANGED. CONFLICT — the order's state forbids a quote: it is over, it has no supplier locator yet, or it is PENDING_RECONCILIATION (details.state names it). PENALTY_CHANGED with details.reason CONTRADICTS_BOOKED_TERMS — the supplier's penalty contradicts the cancellation terms the order was booked on.
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
500
INTERNAL — a bug, traceId the support handle; or, on this verb, details.reason FX_SNAPSHOT_UNAVAILABLE: the supplier stated the servicing figures in a currency the order's own booked FX snapshot…Show more
INTERNAL — a bug, traceId the support handle; or, on this verb, details.reason FX_SNAPSHOT_UNAVAILABLE: the supplier stated the servicing figures in a currency the order's own booked FX snapshot cannot convert to the order's currency, so they are not shown in another currency (drop-and-count) and no quote is answered. Not retryable: a retry reads the same booked snapshot.
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.

400	VALIDATION message.intent.checkOut must be after message.intent.checkIn	not retryable
400	UNKNOWN_DOMAIN Unknown domain 'HOTELS'. Did you mean HTL?	not retryable
401	UNAUTHENTICATED The bearer token is expired. Re-authenticate and retry.	not retryable
403	PERMISSION_DENIED Role lacks the required scope: booking:write	not retryable
403	TAB_DISABLED Tenant acme-travel is not entitled to sell CRU	not retryable
403	OUT_OF_SCOPE The token's scope ladder does not reach this customer subtree	not retryable
403	TENANT_MISMATCH orderRef MO-8KD-2FQ-9XT does not belong to tenant acme-travel	not retryable
404	NOT_FOUND searchRef SR-F-7b31d0a9 is unknown or has expired; re-search	not retryable
405	VALIDATION This method is not served.	not retryable
409	CONFLICT This order is CANCELLED, so there is nothing left to cancel. Nothing was sent to the supplier and the order is unchanged.	not retryable
409	PENALTY_CHANGED The supplier's cancellation penalty is not the one the terms this order was booked on charge now. Both are in details, in the order's currency; nothing was cancelled.	not retryable
413	VALIDATION The request body is larger than this API accepts (262144 bytes).	not retryable
414	VALIDATION The request URI is longer than 8 KiB.	not retryable
415	VALIDATION Send application/json.	not retryable
500	INTERNAL An unexpected error occurred. Quote the traceId to support.	retryable
501	NOT_IMPLEMENTED seatmap is NOT_APPLICABLE for HTL; GET /v1/capabilities says so	not retryable
502	UPSTREAM_UNAVAILABLE Every supplier for HTL is circuit-open; no fan-out was attempted	retryable
503	PROVIDER_DOWN EXAMPLEHOTELS is unavailable; the order was not attempted and nothing was captured	retryable