{"openapi":"3.1.0","info":{"title":"GoChatTravel API","description":"\nThe GoChatTravel API is a white-label travel commerce layer: one search across the suppliers a\npartner holds, **one cart across suppliers** — any number of hotels, flights and car rentals from\ndifferent providers — **one checkout** that books every item, and post-sale cancellation and refund.\nIt sits on top of the partner's own supplier contracts, an aggregator they already buy from, or\nthe providers GoChatTravel is connected to, and powers banking, airline, hotel and group-travel\nproducts under the partner's own brand. See https://gochattravel.com for the product and\nhttps://sandbox.gochattravel.com for live demos built on these endpoints.\n\n### Authentication\n\nEvery endpoint below expects two credentials on each request:\n\n| header | value |\n|---|---|\n| `X-App-Id` | the UUID of the client application calling the API |\n| `Authorization` | `Bearer <token>`, an RS256 JWT identifying the end user |\n\nA request missing or failing either one is answered `401`, and a known but disabled app id is\nanswered `403`. Both come back with an empty body: the status is the whole answer.\n\n### Conventions\n\n* Requests and responses are `application/json`, UTF-8 encoded.\n* Calendar dates use `YYYY-MM-DD`; timestamps follow RFC 3339.\n* Monetary values are decimals paired with an ISO 4217 currency code.\n* Languages are ISO 639-1 codes, countries ISO 3166-1 alpha-2.\n\n### Errors\n\n`4xx` responses signal a malformed or rejected request, `5xx` a temporary failure on our side.\nBoth carry a JSON body of the shape:\n\n```json\n{ \"error\": \"check_in must be before check_out\" }\n```\n\n### Trying it out\n\nChoose a server, open an operation in the sidebar and press **TRY** to send a live request\nstraight from this page.\n","license":{"name":"Proprietary","identifier":"LicenseRef-Proprietary"},"version":"1.0.0"},"servers":[{"url":"https://sandbox.gochattravel.com","description":"Sandbox"},{"url":"/","description":"Current host"}],"paths":{"/api/v1/airline/autocomplete":{"get":{"tags":["Airline"],"summary":"Suggest airlines","description":"\nResolves what a user is typing into an airline. The term is matched against the IATA code and the\nairline's name, ignoring case. An exact code ranks first, then names starting with the term, then\nnames containing it. Only active airlines are returned. Terms shorter than two characters are\nrejected with `400`.\n","operationId":"autocompleteAirlines","parameters":[{"name":"q","in":"query","description":"What the user has typed so far: an airline name or IATA code.","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"How many suggestions to return, 1-25.","required":false,"schema":{"type":["integer","null"],"format":"int64"}}],"responses":{"200":{"description":"Matching airlines, best first. `results` is empty when nothing matched.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AirlineAutocompleteResponse"},"example":{"results":[{"alliance":"Star Alliance","country":"Germany","iata":"LH","logo_url":null,"name":"Lufthansa"}]}}}},"400":{"description":"The term is shorter than two characters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"q must be at least 2 characters"}}}},"401":{"description":"The `X-App-Id` header is missing or malformed, or the bearer token is missing, invalid or expired. The response carries no body."},"403":{"description":"The app id is known but disabled. The response carries no body."},"500":{"description":"The airline catalog could not be queried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Airline autocomplete failed"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/airport/autocomplete":{"get":{"tags":["Airport"],"summary":"Suggest places to fly from and to","description":"\nResolves what a traveller is typing into somewhere a flight can depart from or arrive at.\nEvery suggestion carries `codes`, ready to send straight back as the `origin` or\n`destination` of a flight search — nothing needs resolving a second time.\n\n### What it searches\n\nAirports with scheduled passenger service, and metro codes, told apart by `kind`:\n\n| `kind` | what it is |\n|---|---|\n| `airport` | one airport |\n| `city` | an IATA metro code standing for all the airports of one city — `LON`, `NYC`, `PAR` |\n\n### Matching\n\nThe term is matched against airport names, IATA and ICAO codes and the names of the city served,\nin every supported language and script. Case, accents and punctuation are ignored, so\n`dusseldorf` finds `Düsseldorf`. An exact code ranks first, and small typos in names are\ntolerated. Terms shorter than two characters are rejected with `400`.\n\n### Somewhere with no airport of its own\n\nA term naming a town or resort without an airport — `Ischgl`, `Courchevel` — is answered with the\nairports one actually flies into, and `via` says which place was matched and how far away the\nairport is.\n\n### Localisation\n\n`language` only decides how suggestions are **labelled**. Where there is no name for an airport in\nthat language, `name` falls back to the airport's own name. `country_name` is always in English.\n\n### Using the result\n\n`codes` is the field to use: pass it as the `origin` or `destination` of a flight search. For\nan airport it holds one code, for a metro code all of its airports, best first. `label` is\nready to render as-is; build your own from `name`, `city_name` and `country_name` if you want\nit differently.\n\n`latitude`, `longitude` and `timezone` describe one airport, so they are `null` on a `city`\nsuggestion.\n","operationId":"autocompleteAirports","parameters":[{"name":"q","in":"query","description":"What the user has typed so far.","required":true,"schema":{"type":"string"}},{"name":"language","in":"query","description":"ISO 639-1 code deciding the language of `name`, `city_name` and `label`. Defaults\nto the `Accept-Language` header, then English.","required":false,"schema":{"type":["string","null"]}},{"name":"limit","in":"query","description":"How many suggestions to return, 1–25.","required":false,"schema":{"type":["integer","null"],"format":"int64"}},{"name":"country","in":"query","description":"ISO 3166-1 alpha-2 code to restrict the search to one country.","required":false,"schema":{"type":["string","null"]}},{"name":"kind","in":"query","description":"`airport` or `city` to return only one kind. Both by default.","required":false,"schema":{"type":["string","null"]}}],"responses":{"200":{"description":"Matching air locations, best first. `results` is empty when nothing matched.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AirportAutocompleteResponse"},"example":{"results":[{"airport_count":6,"city_name":"London","code":"LON","codes":["LHR","LGW","STN","LTN","SEN","LCY"],"country_code":"GB","country_name":"United Kingdom","icao_code":null,"kind":"city","label":"London (LON), United Kingdom","latitude":null,"longitude":null,"name":"London","timezone":null},{"airport_count":1,"city_name":"London","code":"LHR","codes":["LHR"],"country_code":"GB","country_name":"United Kingdom","icao_code":"EGLL","kind":"airport","label":"Heathrow Airport (LHR), London, United Kingdom","latitude":51.470311,"longitude":-0.458118,"name":"Heathrow Airport","timezone":"Europe/London"},{"airport_count":1,"city_name":"Innsbruck","code":"INN","codes":["INN"],"country_code":"AT","country_name":"Austria","icao_code":"LOWI","kind":"airport","label":"Innsbruck Airport (INN), Innsbruck, Austria","latitude":47.260188,"longitude":11.345793,"name":"Innsbruck Airport","timezone":"Europe/Vienna","via":{"distance_km":84.5,"geoname_id":2775220,"name":"Ischgl"}}]}}}},"400":{"description":"The term is shorter than two characters, or `kind` is neither `airport` nor `city`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"q must be at least 2 characters"}}}},"401":{"description":"The `X-App-Id` header is missing or malformed, or the bearer token is missing, invalid or expired. The response carries no body."},"403":{"description":"The app id is known but disabled. The response carries no body."},"500":{"description":"The airport catalog could not be queried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Airport autocomplete failed"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/airport/nearby":{"get":{"tags":["Airport"],"summary":"Airports near a point","description":"\nThe airports with scheduled passenger service one would fly into for a place, nearest first, for\nwhen the traveller knows the town but not its airport.\n\nHow far an airport is offered depends on its size: a large airport up to 250 km away, a mid-sized\none up to 110 km, a local one up to 60 km. `results` is empty when none is that close.\n","operationId":"nearbyAirports","parameters":[{"name":"latitude","in":"query","description":"Latitude of the point, in degrees.","required":true,"schema":{"type":"number","format":"double"}},{"name":"longitude","in":"query","description":"Longitude of the point, in degrees.","required":true,"schema":{"type":"number","format":"double"}},{"name":"language","in":"query","description":"ISO 639-1 code deciding the language of `name`, `city_name` and `label`. Defaults\nto the `Accept-Language` header, then English.","required":false,"schema":{"type":["string","null"]}},{"name":"limit","in":"query","description":"How many airports to return, 1–10. Five by default.","required":false,"schema":{"type":["integer","null"],"format":"int64"}}],"responses":{"200":{"description":"Airports near the point, nearest first.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NearbyAirportsResponse"},"example":{"results":[{"airport_count":1,"city_name":"George Town","code":"GCM","codes":["GCM"],"country_code":"KY","country_name":"Cayman Islands","distance_km":3.1,"icao_code":"MWCR","kind":"airport","label":"Owen Roberts International Airport (GCM), George Town, Cayman Islands","latitude":19.2928,"longitude":-81.3577,"name":"Owen Roberts International Airport","timezone":"America/Cayman"}]}}}},"400":{"description":"The point is not a valid latitude and longitude.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"latitude must be between -90 and 90 and longitude between -180 and 180"}}}},"401":{"description":"The `X-App-Id` header is missing or malformed, or the bearer token is missing, invalid or expired. The response carries no body."},"403":{"description":"The app id is known but disabled. The response carries no body."},"500":{"description":"The airport catalog could not be queried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Nearby airports failed"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/bookings":{"get":{"tags":["Bookings"],"summary":"Everything the traveller has booked","description":"\nEvery reservation the authenticated traveller has settled - hotels, flights, events and cars in\none list, newest first. Cancelled ones are included and say so in `status`; anything still in a cart,\nheld or half-paid, is not here and belongs to `GET /api/v1/cart`.\n\nEach entry is the same shape a cart item has, told apart by `type`, so one renderer draws both.\nOn top of that a booking carries `confirmation` - the airline's record locator, the hotel's\nconfirmation code, or the provider's booking id - and `booked_at`.\n\n`confirmation` is absent while the reservation is still being confirmed, e.g. a flight not yet\nticketed.\n\nGroup and custom requests an agent booked by hand come in `quote_bookings`, apart, since no cart\never held them. Travel insurance comes there too, with `kind` `insurance`; its\n`covered_booking_ids` name the `bookings` it covers.\n","operationId":"listBookings","responses":{"200":{"description":"The traveller's reservations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookingsResponse"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/bookings/{item_type}/{item_id}/cancel":{"post":{"tags":["Bookings"],"summary":"Cancel a booking","description":"\nCancels one reservation with its provider and answers with the booking as it now stands.\n\nQuote it first with `GET /api/v1/bookings/{item_type}/{item_id}/cancellation`: this endpoint does\nnot check that the traveller was told the price, and a non-refundable booking cancels just as\nreadily as a free one.\n\nA booking that is already cancelled answers `409` rather than being cancelled twice.\n","operationId":"cancelBooking","parameters":[{"name":"item_type","in":"path","description":"`hotel`, `flight` or `car`","required":true,"schema":{"type":"string"}},{"name":"item_id","in":"path","description":"Booking id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The booking is cancelled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelledResponse"}}}},"404":{"description":"No such booking"},"409":{"description":"It is not in a state that can be cancelled"},"502":{"description":"The cancellation was refused"}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/bookings/{item_type}/{item_id}/cancellation":{"get":{"tags":["Bookings"],"summary":"What cancelling a booking would cost","description":"\nRead this before offering to cancel anything: it says what the traveller gets back and what they\nforfeit, so the confirmation can quote real numbers rather than a general warning.\n\nA hotel is priced from the policy the rate was sold under - `free_until` is the moment free\ncancellation ends. A flight's penalty is quoted by the airline at the time of the call.\n\n`refundability` is `unknown` when the provider would not answer. That is not the same as free and\nnot the same as non-refundable: say so plainly rather than guessing, and let the traveller decide.\n","operationId":"getCancellationQuote","parameters":[{"name":"item_type","in":"path","description":"`hotel`, `flight` or `car`","required":true,"schema":{"type":"string"}},{"name":"item_id","in":"path","description":"Booking id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"What cancelling costs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancellationQuote"}}}},"404":{"description":"No such booking"}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/car/bookings/{booking_id}/similar-offers":{"post":{"tags":["Car"],"summary":"Shop offers similar to a car booking","description":"\nShops the rental of an existing car booking again - the same pickup and dropoff times, in the same\ncurrency - and ranks every car found by how close it comes to the one booked.\n\n### Where it shops\n\nThe booked branch is always shopped, together with branches of other vendors near it. A one-way\nrental is returned at the booked dropoff branch or near it. When the booked branch's location is\nunknown, only the booked vendor comes back.\n\n### Reading the response\n\nThe response is the one `POST /api/v1/car/search` returns, except that every offer carries a\n`similarity` and offers come closest first, at most 50 of them, and are selected exactly like search\nresults, through `POST /api/v1/car/offer/{offer_id}/select`, within the same 15 minutes.\n\n### Reading `offers[].similarity`\n\n`score` runs from 0 to 100, higher is closer.\n\n`match_level` names the kind of match:\n\n| `match_level` | meaning |\n|---|---|\n| `identical` | the booked vendor, branches, car class and mileage terms |\n| `same_car` | the booked vendor, branches and car class on other mileage terms |\n| `same_branch` | another car class from the booked vendor and branches |\n| `similar` | another vendor or another branch |\n\n`same_reservation` flags the very car that was booked, which is exactly `identical`. Its\n`price_difference` tells whether it got dearer or cheaper since. `category_difference` counts size\nclasses up from the booked car, and `pickup_distance_meters` how far the pickup branch is from the\nbooked one. `differences` lists what departs from the booking, only where both sides are known.\n","operationId":"searchSimilarCarOffers","parameters":[{"name":"booking_id","in":"path","description":"`id` of the car booking to compare against.","required":true,"schema":{"type":"string","format":"uuid"},"example":"4b7e1d02-8c3f-4a91-b6d5-2e0f9a7c3b18"}],"responses":{"200":{"description":"Cars found, closest first, each with a `similarity`. An empty `offers` means nothing is available.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarSearchResult"}}}},"400":{"description":"The rental has already started, or the booking carries no offer to compare against.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Car rental has already started"}}}},"401":{"description":"The `X-App-Id` header is missing or malformed, or the bearer token is missing, invalid or expired. The response carries no body."},"403":{"description":"The app id is known but disabled. The response carries no body."},"404":{"description":"No such car booking for this traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Car booking not found"}}}},"500":{"description":"Shopping could not be run.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Car search failed"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/car/locations/dropoff":{"post":{"tags":["Car"],"summary":"Find rental branches to return a car to","description":"\nLists the branches around a point where a car picked up at `pickup_location_ids` can be returned,\nnearest first. Only needed for a one-way rental; leave `dropoff_location_ids` empty in the car\nsearch to return the car where it was picked up.\n\nA car is returned to the vendor it was rented from, so only branches of the vendors behind\n`pickup_location_ids` are listed. The car search pairs each pickup branch with the first dropoff\nbranch of the same vendor in the order you send them, so keep this list's order, or send just the\nnearest branch per vendor.\n\n`search` takes the same fields and defaults as `POST /api/v1/car/locations/pickup`. An empty\n`locations` array means none of those vendors has a branch in range.\n","operationId":"searchCarDropoffLocations","requestBody":{"description":"The pickup branches already chosen and the point to return the car near.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarDropoffLocationSearchRequest"},"example":{"pickup_location_ids":["ZIPHXPHX","ZEPHXPHX"],"search":{"latitude":32.1161,"longitude":-110.941}}}},"required":true},"responses":{"200":{"description":"Branches of the pickup vendors in range, nearest first.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarLocationSearchResult"}}}},"400":{"description":"No pickup branch was sent, too many were, or the search point is out of range.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"at least one pickup_location_id is required"}}}},"401":{"description":"The `X-App-Id` header is missing or malformed, or the bearer token is missing, invalid or expired. The response carries no body."},"403":{"description":"The app id is known but disabled. The response carries no body."},"500":{"description":"The lookup could not be run.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Car location search failed"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/car/locations/pickup":{"post":{"tags":["Car"],"summary":"Find rental branches to pick a car up from","description":"\nLists the rental branches around a point, nearest first. Each entry is one counter of one vendor,\nso an airport with six rental companies comes back as six entries.\n\nA car search runs on branch ids, not on coordinates: pick the branches you want from this list\nand send their `id`s as `pickup_location_ids` to `POST /api/v1/car/search`. Ids are opaque, so\nnever build or parse them yourself.\n\n### Defaults applied when a field is omitted\n\n| Field | Default |\n|---|---|\n| `radius_km` | `40` (kilometres), at most `100` |\n| `max_results` | `200`, at most `200` |\n\n### Choosing branches\n\nThe more branches a car search is sent, the slower it answers. Send the nearest handful, and use `airport` to favour airport counters when\nthe traveller arrives by plane.\n\nA point with no branch in range is not an error: it answers `200` with an empty `locations` array.\n","operationId":"searchCarPickupLocations","requestBody":{"description":"The point to search around.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarLocationSearchRequest"},"example":{"latitude":33.4352,"longitude":-112.0101,"radius_km":20.0}}},"required":true},"responses":{"200":{"description":"Branches in range, nearest first.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarLocationSearchResult"},"example":{"locations":[{"address":{"city":"Phoenix","country":"US","postal_code":"85034","street":"1805 E Sky Harbor Circle S"},"airport":true,"distance_km":0.4,"geo":{"latitude":33.4352,"longitude":-112.0101},"id":"ZIPHXPHX","name":"Phoenix Sky Harbor Intl Airport","provider":"acme","vendor":{"code":"ZI","logo_url":null,"name":"Avis"}}]}}}},"400":{"description":"The coordinates, radius or result limit are out of range.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"latitude must be between -90 and 90"}}}},"401":{"description":"The `X-App-Id` header is missing or malformed, or the bearer token is missing, invalid or expired. The response carries no body."},"403":{"description":"The app id is known but disabled. The response carries no body."},"500":{"description":"The lookup could not be run.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Car location search failed"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/car/offer/{offer_id}/select":{"post":{"tags":["Car"],"summary":"Put a shopped car offer in the cart","description":"\nHolds one rental for the authenticated traveller and puts it in their cart, where it waits until\nit is removed. Nothing is booked and nothing is charged by this call.\n\n### Which offers can be selected\n\nAny `offer_id` this traveller was given by `POST /api/v1/car/search`. Offers stay resolvable for\n**15 minutes**. A `404` means the offer is gone rather than that it never existed: re-run the\nsearch and select the fresh id. It is also a `404` when the offer belongs to somebody else - an id\nis only selectable by the traveller it was shopped for.\n\n### What comes back\n\nA cart item. Its `id` is a **booking id, not the offer id** - that is the handle the rest of the\nfunnel uses, and the offer id stops mattering the moment the item exists.\n\n### Selecting twice\n\nThe call is idempotent per rental. Selecting an offer for a car class, pickup and dropoff branch and\nrental period the cart already holds returns the existing item with `200` instead of a second one\nwith `201`, so a retried request cannot quietly duplicate it. Two requests racing each other - a\ndouble click - settle the same way rather than both inserting; one that arrives while another is\nstill being processed answers `409`.\n\n### Which cart it lands in\n\nWithout `cart_id` the offer goes into the traveller's **current** cart, and one is opened for them\nif they have none. Send `cart_id` to put it in a particular cart instead.\n\nA `cart_id` that is not this traveller's answers `404`, like an offer that never existed. One that\nhas already started checking out answers `409`: a cart being paid for takes no new items.\n\nRead the whole cart back with `GET /api/v1/cart`, and list them all with `GET /api/v1/carts`.\n","operationId":"selectCarOffer","parameters":[{"name":"cart_id","in":"query","required":false,"schema":{"type":["string","null"],"format":"uuid"}},{"name":"offer_id","in":"path","description":"`offer_id` of an entry in a car search's `offers`.","required":true,"schema":{"type":"string"},"example":"0f8e6a3c-6b1e-4f2a-9f1d-1c2b3a4d5e6f"}],"responses":{"200":{"description":"The cart already held this rental; the existing item is returned untouched.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarCartItem"}}}},"201":{"description":"The offer is now in the cart.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarCartItem"},"example":{"created_at":"2026-09-01T10:15:00Z","currency":"USD","dropoff_at":"2026-11-08T10:00:00","dropoff_location_id":"ZIPHXPHX","id":"c3a9f1e2-7d45-4b8a-9e0c-5f2d1b6a8c34","pickup_at":"2026-11-05T10:00:00","pickup_location_id":"ZIPHXPHX","provider":"acme","rental_days":3,"status":"pending","total_amount":"187.41","updated_at":"2026-09-01T10:15:00Z","vehicle_code":"ECAR","vehicle_name":"Kia Rio or similar","vendor_code":"ZI","vendor_name":"Avis"}}}},"401":{"description":"The `X-App-Id` header is missing or malformed, or the bearer token is missing, invalid or expired. The response carries no body."},"403":{"description":"The app id is known but disabled. The response carries no body."},"404":{"description":"The offer has expired, was never shopped, or belongs to another traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Offer not found or expired"}}}},"409":{"description":"Another selection for this traveller is still being processed, or the named cart is checking out.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Another selection for this traveller is in progress"}}}},"500":{"description":"The offer could not be put in the cart.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Failed to select car offer"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/car/search":{"post":{"tags":["Car"],"summary":"Search car rental availability","description":"\nShops live availability for one rental at the branches you name and returns every bookable car,\ncheapest first.\n\n### Where the search runs\n\nCars are shopped per branch, so the search takes branch ids rather than a point. Get them from\n`POST /api/v1/car/locations/pickup` and send the ones to shop as `pickup_location_ids`.\n\nLeave `dropoff_location_ids` empty to return the car where it was picked up. For a one-way rental,\nsend branches from `POST /api/v1/car/locations/dropoff`: each pickup branch is paired with the\nfirst dropoff branch of the same vendor in the order sent, and a pickup branch whose vendor has\nno dropoff branch in the list is not shopped at all.\n\n### Times\n\n`pickup_at` and `dropoff_at` are local times at their branches, without an offset, as\n`YYYY-MM-DDTHH:MM:SS`. `dropoff_at` must be after `pickup_at`. `rental_days` on each offer is\nthe number of days the vendor bills, which can be one more than the calendar dates suggest when\nthe car goes back later in the day than it was picked up.\n\n### Currency\n\n`currency` is the ISO 4217 currency you would like prices in, not a requirement. Every offer is\npriced in the currency the rental company charges: that is `currency` when the company charges in\nit, and the company's own currency otherwise, never a conversion. Read `pricing.currency` off each\noffer.\n\n### Reading the response\n\n* `offers` holds one entry per car class per pickup and dropoff branch pair: when several rates\n  quote the same car, only the cheapest is kept.\n* `pricing.total` is the vendor's approximate total for the whole rental, in `pricing.currency`,\n  and `pricing.per_day` is that total spread evenly over `rental_days`. `drop_off_charge` is the\n  one-way fee, when the vendor quotes one separately.\n* `pricing.taxes` is the mandatory taxes and fees already inside `pricing.total`, and\n  `pricing.base_rate` is what is left of it. Both are `null` when the vendor quoted no estimate,\n  which is not the same as a tax-free rental - `pricing.total` is what the traveller pays either\n  way.\n* `vehicle.classification` decodes the four-letter ACRISS code (`ECAR`, `IFAR`, ...). A letter\n  outside the ACRISS tables decodes to `null` rather than failing the whole code.\n* `vehicle.make_model` is a representative model: vendors rent a class, not a car.\n* `mileage` is `\"Unlimited\"`, or `{ \"Limited\": { \"allowance\", \"unit\", \"extra_charge\" } }` with the\n  allowance for the rental and the charge per extra `unit`. `null` means the vendor did not say.\n* `offer_id` stays resolvable for **15 minutes**; after that the search has to be re-run.\n\n### Limits and failure modes\n\n* A call can take several seconds. Send at most 20 pickup branches, fewer for a faster answer,\n  and allow a generous client timeout.\n* Results are **not** paginated.\n* A search that matches nothing is a success: it answers `200` with an empty `offers` array.\n  A `500` means the search itself could not be run, and is worth retrying.\n","operationId":"searchCars","requestBody":{"description":"The branches to shop and the rental period.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarSearchRequest"},"examples":{"One way":{"summary":"Pick up at Phoenix airport, return in Tucson","description":"Each pickup branch is shopped against the dropoff branch of its own vendor.","value":{"dropoff_at":"2026-11-08T18:00:00","dropoff_location_ids":["ZITUSTUS","ZETUSTUS"],"pickup_at":"2026-11-05T10:00:00","pickup_location_ids":["ZIPHXPHX","ZEPHXPHX"]}},"Round trip":{"summary":"Return the car where it was picked up","value":{"currency":"USD","dropoff_at":"2026-11-08T10:00:00","dropoff_location_ids":[],"pickup_at":"2026-11-05T10:00:00","pickup_location_ids":["ZIPHXPHX","ZEPHXPHX","ZRPHXPHX"]}}}}},"required":true},"responses":{"200":{"description":"Bookable cars, cheapest first. `offers` is empty when nothing is available.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarSearchResult"},"example":{"offers":[{"dropoff_at":"2026-11-08T10:00:00","dropoff_location":{"address":{"city":"Phoenix","country":"US","postal_code":null,"street":null},"airport":true,"distance_km":null,"geo":null,"id":"ZIPHXPHX","name":"Phoenix Sky Harbor Intl Airport","provider":"acme","vendor":{"code":"ZI","logo_url":null,"name":"Avis"}},"mileage":"Unlimited","offer_id":"0f8e6a3c-6b1e-4f2a-9f1d-1c2b3a4d5e6f","pickup_at":"2026-11-05T10:00:00","pickup_location":{"address":{"city":"Phoenix","country":"US","postal_code":null,"street":null},"airport":true,"distance_km":null,"geo":null,"id":"ZIPHXPHX","name":"Phoenix Sky Harbor Intl Airport","provider":"acme","vendor":{"code":"ZI","logo_url":null,"name":"Avis"}},"pricing":{"base_rate":"137.01","currency":"USD","drop_off_charge":null,"per_day":"62.47","taxes":"50.40","total":"187.41"},"provider":"acme","rate_code":"BEST","rental_days":3,"vehicle":{"bags_large":1,"bags_small":1,"classification":{"air_conditioning":true,"body_type":"TwoFourDoor","category":"Economy","code":"ECAR","drive":"Unspecified","fuel":"Unspecified","transmission":"Automatic"},"doors":"4","image_url":null,"make_model":"Kia Rio or similar","seats":5},"vendor":{"code":"ZI","logo_url":null,"name":"Avis"}}]}}}},"400":{"description":"No pickup branch was sent or too many were, the rental period is not a valid range or has passed, or the currency is malformed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"dropoff_at must be after pickup_at"}}}},"401":{"description":"The `X-App-Id` header is missing or malformed, or the bearer token is missing, invalid or expired. The response carries no body."},"403":{"description":"The app id is known but disabled. The response carries no body."},"500":{"description":"Shopping could not be run. An empty result is not an error; it comes back as `200` with no offers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Car search failed"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/car/search/nearby":{"post":{"tags":["Car"],"summary":"Search car rental availability around a place","description":"\nShops live availability for one rental at the branches around the places you name, in a single\ncall, and returns every bookable car, cheapest first.\n\n### Where the search runs\n\nThe rental branches nearest to `pickup` are shopped, the same ones\n`POST /api/v1/car/locations/pickup` lists first.\n\nLeave `dropoff` out to return the car where it was picked up. For a one-way rental, each pickup\nbranch is shopped against the branch of its own vendor nearest to `dropoff`, and a vendor with no\nbranch near `dropoff` is not shopped at all.\n\n`name` on each place is only echoed back in messages; the search runs on `latitude` and\n`longitude`.\n\n### Times\n\n`pickup_at` and `dropoff_at` are local times at their branches, without an offset, as\n`YYYY-MM-DDTHH:MM:SS`. `dropoff_at` must be after `pickup_at`.\n\n### Currency\n\n`currency` is the ISO 4217 currency you would like prices in, not a requirement. Every offer is\npriced in the currency the rental company charges: that is `currency` when the company charges in\nit, and the company's own currency otherwise, never a conversion. Read `pricing.currency` off each\noffer.\n\n### Reading the response\n\n`offers` reads exactly like the `offers` of `POST /api/v1/car/search`, except that each pickup and\ndropoff location carries the branch details and `distance_km` from the place searched. Offers are\nselected through `POST /api/v1/car/offer/{offer_id}/select` within **15 minutes**.\n\nWhen `offers` is empty, `empty_reason` says why:\n\n| `empty_reason` | meaning |\n|---|---|\n| `no_pickup_branches` | no rental branch near `pickup` |\n| `no_dropoff_branches` | none of the vendors near `pickup` has a branch near `dropoff` |\n| `no_availability` | branches were found, but none has a car for these times |\n\n### Limits and failure modes\n\n* A call can take several seconds. Allow a generous client timeout.\n* Results are **not** paginated.\n* A `500` means the search itself could not be run, and is worth retrying.\n","operationId":"searchCarsNearby","requestBody":{"description":"The places to shop around and the rental period.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarNearbySearchRequest"},"examples":{"One way":{"summary":"Pick up at Phoenix airport, return in Tucson","value":{"currency":"USD","dropoff":{"latitude":32.1161,"longitude":-110.941,"name":"Tucson International Airport"},"dropoff_at":"2026-11-08T18:00:00","pickup":{"latitude":33.4352,"longitude":-112.0101,"name":"Phoenix Sky Harbor International Airport"},"pickup_at":"2026-11-05T10:00:00"}},"Round trip":{"summary":"Return the car where it was picked up","value":{"currency":"USD","dropoff_at":"2026-11-08T10:00:00","pickup":{"latitude":33.4352,"longitude":-112.0101,"name":"Phoenix Sky Harbor International Airport"},"pickup_at":"2026-11-05T10:00:00"}}}}},"required":true},"responses":{"200":{"description":"Bookable cars, cheapest first. When `offers` is empty, `empty_reason` says why.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarNearbySearchResult"},"example":{"empty_reason":"no_pickup_branches","offers":[]}}}},"400":{"description":"A place's coordinates are out of range, the rental period is not a valid range or has passed, or the currency is malformed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"dropoff_at must be after pickup_at"}}}},"401":{"description":"The `X-App-Id` header is missing or malformed, or the bearer token is missing, invalid or expired. The response carries no body."},"403":{"description":"The app id is known but disabled. The response carries no body."},"500":{"description":"Shopping could not be run. An empty result is not an error; it comes back as `200` with no offers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Car search failed"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/cart":{"get":{"tags":["Cart"],"summary":"Read the traveller's current cart","description":"\nEverything the authenticated traveller is holding in their **current** cart but has not yet paid\nfor — hotels, flights, events and cars in one list.\n\nA traveller can keep several carts at once, one per trip they are putting together; this endpoint\nalways answers with the current one, and a traveller who has none gets a fresh empty cart opened\nfor them rather than an error. `GET /api/v1/carts` lists them all, and\n`GET /api/v1/carts/{cart_id}` reads any one of them in exactly this shape.\n\n### What is in it\n\nAn item enters the cart when an offer is selected, and leaves it when it is paid for, removed or\nabandoned. So a cart holds exactly its bookings in two states:\n\n| `status` | |\n|---|---|\n| `pending` | held, nothing charged |\n| `prepared` | checkout has started and a payment is outstanding |\n\nEverything else — booked, cancelled, abandoned — has left the cart and does not appear here.\n\n### The cart itself\n\nAlongside the items, the response carries the cart's own `id`, `status` and optional `title`, plus\n`is_current` — always `true` here, and the field that tells the other cart endpoints apart. A\ncart's `status` is `open` while it is being filled; it becomes `checking_out` once a payment is\noutstanding and takes no new offers until that settles.\n\n### Reading the items\n\n`items` is one list of four shapes, told apart by `type` (`hotel`, `flight`, `event`, `car`); the\nremaining fields of each entry are that shape's own. Every entry carries an `id`, and that `id` is\nthe **booking id** — the handle for removing or checking the item out, not the offer id it came\nfrom. Items are ordered oldest first.\n\n### Prices\n\n`total.by_currency` sums the cart per currency, one entry each, ordered by code. There is\ndeliberately no single grand total: a cart can hold a hotel priced in EUR beside a flight priced\nin USD, and adding those up would mean picking an exchange rate and quoting a number nobody will\nbe charged. Show the currencies side by side, or convert them yourself with a rate you are\nwilling to stand behind.\n\n### `unavailable_item_ids`\n\nItems whose checkout is known to be blocked: the provider reported the inventory gone, or a\npayment went through and the booking behind it failed and is awaiting manual review. They stay in\nthe cart and stay counted in `total`.\n\nRender these as unavailable and keep them out of any \"check out everything\" action. An id being\nabsent is not a promise: availability is only ever confirmed at checkout, so an item can still\nfail there.\n","operationId":"getCart","responses":{"200":{"description":"The cart, empty or not.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartResponseEnriched"},"example":{"id":"3f1a9c22-8d4e-4f70-9b21-5c8e7a0d1b34","is_current":true,"items":[{"checkin":"2026-11-05","checkout":"2026-11-08","created_at":"2026-09-01T10:15:00Z","currency":"USD","hotel_id":"acme:lp1f2a9","hotel_name":"Grand Luxury Hotel & Spa","id":"b7c1e2a4-5f60-4d31-9a8e-2c4b6d8f0a12","provider":"acme","room_types":"1 × Deluxe King","status":"pending","total_amount":"1284.00","type":"hotel","updated_at":"2026-09-01T10:15:00Z"},{"created_at":"2026-09-01T10:22:00Z","currency":"USD","id":"9d2f4c81-3ab7-4e05-8c19-6f7a0b3d5e21","owner_name":"British Airways","passengers_count":1,"slices":[],"status":"pending","total_amount":"350.00","type":"flight","updated_at":"2026-09-01T10:22:00Z"}],"status":"open","title":"Rome in May","total":{"by_currency":[{"amount":"1634.00","currency":"USD"}],"car_count":0,"event_count":0,"flight_count":1,"hotel_count":1,"item_count":2},"unavailable_item_ids":[]}}}},"500":{"description":"The cart could not be read.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Failed to load cart"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/cart/items/{item_type}/{item_id}/payment":{"get":{"tags":["Cart Processing"],"summary":"Payment SDK details for a cart item","description":"\nFor an item whose provider takes the card in its own payment SDK (`payment_method: provider_sdk`):\nwhat the SDK needs to charge it. Available once cart processing has prebooked the item, which is\nwhen the run pauses on it with `hosted_payment`.\n\nliteAPI (`nuitee`, `nuitee_air`) charges the card itself and then calls `return_url`. Duffel's card\nform only takes and authenticates the card, and `stripe` holds it with `confirmCardPayment`: then call\n`POST /api/v1/cart/items/flight/{item_id}/payment` (with the session id for Duffel), which books the flight.\n","operationId":"getItemPayment","parameters":[{"name":"item_type","in":"path","description":"`hotel` or `flight`","required":true,"schema":{"$ref":"#/components/schemas/CartItemType"}},{"name":"item_id","in":"path","description":"The booking id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"What the SDK needs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemPaymentResponse"}}}},"404":{"description":"No such item of this traveller's.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"The item is not paid through an SDK, or is not prebooked yet.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]},"post":{"tags":["Cart Processing"],"summary":"Book a cart item the page took the payment for","description":"\nFor a Duffel flight (`provider: duffel` in `getItemPayment`): once `createThreeDSecureSession`\nanswers `ready_for_payment`, send its id here; the airline charges the card. For `provider: stripe`:\nonce `confirmCardPayment` holds the money, call this with no session id. The flight is booked in the\nbackground; follow the item in the cart processing as with any other payment.\n","operationId":"submitItemPayment","parameters":[{"name":"item_type","in":"path","description":"`flight`","required":true,"schema":{"$ref":"#/components/schemas/CartItemType"}},{"name":"item_id","in":"path","description":"The booking id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemPaymentRequest"}}},"required":true},"responses":{"202":{"description":"Booking started."},"400":{"description":"A session id that can't be one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No such item of this traveller's.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"The item is not paid on the page, is not prebooked, is not paid yet, or is being booked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/cart/items/{item_type}/{item_id}/travelers":{"get":{"tags":["Travelers"],"summary":"List travelers assigned to a cart item","operationId":"getItemTravelers","parameters":[{"name":"item_type","in":"path","description":"`hotel`, `flight`, `event` or `car` - a car takes one driver","required":true,"schema":{"$ref":"#/components/schemas/CartItemType"}},{"name":"item_id","in":"path","description":"The booking id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Assigned travelers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartTravelersResponse"}}}},"404":{"description":"Item not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]},"put":{"tags":["Travelers"],"summary":"Assign travelers to a cart item","operationId":"assignItemTravelers","parameters":[{"name":"item_type","in":"path","description":"`hotel`, `flight`, `event` or `car` - a car takes one driver","required":true,"schema":{"$ref":"#/components/schemas/CartItemType"}},{"name":"item_id","in":"path","description":"The booking id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignTravelersRequest"}}},"required":true},"responses":{"200":{"description":"Travelers assigned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]},"post":{"tags":["Travelers"],"summary":"Add a traveler to a cart item without saving them","description":"\nPuts a new traveler on the booking alone. Nothing is written to the caller's saved travelers, so the\ntraveler exists only for this reservation. Edit them with `updateItemTraveler` and drop them with `removeItemTraveler`.\n\nUse `createCompanion` followed by `assignItemTravelers` instead when the traveler should be kept for\nlater trips.\n\nThe traveler still gets an id, returned as `companion_id`, which is what the other traveler\nendpoints address them by.\n","operationId":"createItemTraveler","parameters":[{"name":"item_type","in":"path","description":"`hotel`, `flight`, `event` or `car` - a car takes one driver","required":true,"schema":{"$ref":"#/components/schemas/CartItemType"}},{"name":"item_id","in":"path","description":"The booking id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCompanionRequest"}}},"required":true},"responses":{"201":{"description":"Traveler added to the booking.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedTravelerResponse"}}}},"400":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/cart/items/{item_type}/{item_id}/travelers/{companion_id}":{"delete":{"tags":["Travelers"],"summary":"Remove a traveler from a cart item","operationId":"removeItemTraveler","parameters":[{"name":"item_type","in":"path","description":"`hotel`, `flight`, `event` or `car` - a car takes one driver","required":true,"schema":{"$ref":"#/components/schemas/CartItemType"}},{"name":"item_id","in":"path","description":"The booking id","required":true,"schema":{"type":"string"}},{"name":"companion_id","in":"path","description":"The traveler's companion id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Traveler removed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"404":{"description":"Not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]},"patch":{"tags":["Travelers"],"summary":"Edit a traveler on a cart item","description":"\nRewrites one traveler's details on the booking itself, leaving the saved companion untouched. This\nis what edits a traveler whose saved profile was deleted: the booking keeps its own copy, so it can\nstill be corrected before checkout.\n\nFields follow the same omitted/null/set rules as `updateCompanion`. Fields the item cannot hold are\nignored - only flights carry a middle name, gender, nationality and travel document.\n","operationId":"updateItemTraveler","parameters":[{"name":"item_type","in":"path","description":"`hotel`, `flight`, `event` or `car` - a car takes one driver","required":true,"schema":{"$ref":"#/components/schemas/CartItemType"}},{"name":"item_id","in":"path","description":"The booking id","required":true,"schema":{"type":"string"}},{"name":"companion_id","in":"path","description":"The traveler's companion id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCompanionRequest"}}},"required":true},"responses":{"200":{"description":"Traveler updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/cart/items/{item_type}/{item_id}/travelers/{companion_id}/loyalty":{"put":{"tags":["Travelers"],"summary":"Choose a traveler's loyalty memberships on a cart item","description":"\nReplaces the loyalty memberships a traveler's booking carries. Assigning a traveler attaches the\nmemberships that fit the item by itself; this is for choosing another one, or none.\n\n`loyalty_ids` are picked from the traveler's `eligible_loyalty` in\n`GET /api/v1/cart/items/{item_type}/{item_id}/travelers`, most preferred first. On a flight each\nairline gets the first chosen membership it credits, its own program before an alliance partner's.\nA hotel stay or a rental takes at most one. An empty list attaches none.\n","operationId":"setItemTravelerLoyalty","parameters":[{"name":"item_type","in":"path","description":"`hotel`, `flight` or `car`; events carry no memberships","required":true,"schema":{"$ref":"#/components/schemas/CartItemType"}},{"name":"item_id","in":"path","description":"The booking id","required":true,"schema":{"type":"string"}},{"name":"companion_id","in":"path","description":"The traveler's companion id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetTravelerLoyaltyRequest"},"example":{"loyalty_ids":["8c2e1d4f-3b5a-4e6c-9d7f-1a2b3c4d5e6f"]}}},"required":true},"responses":{"200":{"description":"Memberships saved on the booking.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"description":"A membership can't be used on this booking, or the booking is no longer editable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Loyalty membership 8c2e1d4f-3b5a-4e6c-9d7f-1a2b3c4d5e6f can't be used on this booking"}}}},"404":{"description":"No such booking, or the traveler isn't on it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Traveler not found on this booking"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/cart/{item_type}/{item_id}":{"delete":{"tags":["Cart"],"summary":"Remove cart item","description":"\nDrops one held item. Nothing is cancelled with the provider and no money moves, because a cart\nitem was never confirmed with them in the first place.\n\n### Addressing the item\n\nBoth parts of the path come straight off the entry in `GET /api/v1/cart`: `item_type` is its\n`type`, `item_id` its `id`. The cart the item belongs to is not part of the path.\n\nAn id belonging to another traveller answers `404`, exactly like one that never existed.\n\n### What comes back\n\nThe traveller's **current** cart as it now stands, in the same shape `GET /api/v1/cart` returns —\nso a UI can redraw from this response instead of fetching again. Note that when the removed item\nsat in some other cart, the body is still the current one; re-read that cart directly with\n`GET /api/v1/carts/{cart_id}` if it is the one on screen.\n\nRemoval is idempotent in effect but not in status: the item is gone after the first call, and a\nsecond call for the same id answers `404` because it is no longer in the cart.\n\n### When it refuses\n\nAn item whose payment went through but whose booking then failed is held for manual review and\nanswers `409` until that review resolves. Those ids are exactly the ones\n`GET /api/v1/cart` reports in `unavailable_item_ids`.\n","operationId":"removeCartItem","parameters":[{"name":"item_type","in":"path","description":"`hotel`, `flight`, `event` or `car` - the item's `type`.","required":true,"schema":{"$ref":"#/components/schemas/CartItemType"},"example":"hotel"},{"name":"item_id","in":"path","description":"The item's `id`.","required":true,"schema":{"type":"string"},"example":"b7c1e2a4-5f60-4d31-9a8e-2c4b6d8f0a12"}],"responses":{"200":{"description":"Removed. The body is the remaining cart.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartResponseEnriched"}}}},"400":{"description":"`item_type` is not one of `hotel`, `flight`, `event` or `car`, or `item_id` is not a UUID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"item_type must be hotel, flight, event or car"}}}},"404":{"description":"No such item in this traveller's cart.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Item not found in cart"}}}},"409":{"description":"The item is under post-payment review and cannot be removed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Item is under review after a payment and cannot be removed"}}}},"500":{"description":"The item could not be removed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Failed to remove cart item"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/carts":{"get":{"tags":["Cart"],"summary":"List the traveller's carts","description":"\nThe authenticated traveller's carts, newest first, each with everything in it - the same shape\n`GET /api/v1/carts/{cart_id}` returns for one, so a page showing several carts needs one request.\n\n### `status`\n\n| | |\n|---|---|\n| `open` | accepting offers |\n| `checking_out` | a payment is outstanding; the cart takes no new items until it settles |\n| `under_review` | what is left was charged without a confirmation; the agency settles it, and the cart takes no new items |\n| `completed` | everything in it was booked |\n| `abandoned` | deleted by the traveller |\n\n### `is_current`\n\nExactly one open cart is the **current** one: where a selected offer lands when\n`POST .../select` is called without a `cart_id`. It is the most recently created or explicitly\nchosen open cart, so starting a checkout hands the role to the next open cart on its own. Switch\nit deliberately with `PATCH /api/v1/carts/{cart_id}` and `{\"current\": true}`.\n\nA traveller with no open cart has none current, and the first selection makes one.\n","operationId":"listCarts","parameters":[{"name":"status","in":"query","description":"Comma-separated statuses to keep. Every cart when omitted.","required":false,"schema":{"type":"string"},"example":"open,checking_out"}],"responses":{"200":{"description":"The traveller's carts, newest first. Empty when none match.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CartResponseEnriched"}}}}},"400":{"description":"`status` names an unknown status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Unknown cart status: shipped"}}}},"500":{"description":"The carts could not be read.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Failed to load carts"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]},"post":{"tags":["Cart"],"summary":"Start a new cart","description":"\nOpens an empty cart for the authenticated traveller and makes it the current one, so the next\noffer selected without an explicit `cart_id` lands in it.\n\nCarts are not exclusive: a traveller can hold several at once and fill them in any order. Use\nthis when they are planning a second trip while the first is still unpaid, or when a set of\nselections belongs together and should be paid for as one.\n\nSend a `title` to name it. Untitled carts are fine — the field exists so a traveller can tell two\nof them apart, not because anything depends on it.\n","operationId":"createCart","requestBody":{"description":"The cart to open.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCartRequest"},"example":{"title":"Rome in May"}}},"required":true},"responses":{"201":{"description":"The new cart, empty and current.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartSummary"},"example":{"created_at":"2026-09-01T10:15:00Z","id":"3f1a9c22-8d4e-4f70-9b21-5c8e7a0d1b34","is_current":true,"status":"open","title":"Rome in May","total":{"by_currency":[],"car_count":0,"event_count":0,"flight_count":0,"hotel_count":0,"item_count":0},"updated_at":"2026-09-01T10:15:00Z"}}}},"400":{"description":"The title is longer than 256 characters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"title must be at most 256 characters"}}}},"500":{"description":"The cart could not be created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Failed to create the cart"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/carts/{cart_id}":{"get":{"tags":["Cart"],"summary":"Get cart by id","description":"\nOne cart with everything in it, in the same shape `GET /api/v1/cart` returns for the current one —\nso a UI can render either from the same code.\n\nA cart belonging to another traveller answers `404`, exactly like one that never existed.\n\nItems are ordered oldest first and each `id` is a **booking id**, the handle for removing or\nchecking that item out. See `GET /api/v1/cart` for how to read the items and\n`unavailable_item_ids`.\n\nOnce something is booked it leaves the cart. Pass `include=booked` to keep it in, with\n`status: \"booked\"`, for showing a trip as a whole after checkout — a proposal's options, say.\n","operationId":"getCartById","parameters":[{"name":"cart_id","in":"path","description":"The cart's `id`.","required":true,"schema":{"type":"string"},"example":"3f1a9c22-8d4e-4f70-9b21-5c8e7a0d1b34"},{"name":"include","in":"query","description":"`booked` keeps what was already booked from the cart in it.","required":false,"schema":{"type":"string"},"example":"booked"}],"responses":{"200":{"description":"The cart, empty or not.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartResponseEnriched"}}}},"400":{"description":"`cart_id` is not a UUID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"cart_id must be a UUID"}}}},"404":{"description":"No such cart for this traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Cart not found"}}}},"500":{"description":"The cart could not be read.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Failed to load cart"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]},"delete":{"tags":["Cart"],"summary":"Abandon a cart","description":"\nReleases every hold in the cart and closes it. Nothing is cancelled with any provider and no money\nmoves — the items were never confirmed with them.\n\nThe cart stays in `GET /api/v1/carts` as `abandoned`, so a traveller can still see what they had\nshortlisted and decided against.\n\n### When it refuses\n\nA cart that is `checking_out` answers `409`: a payment is outstanding, and dropping the items it\nis waiting on would strand it. Wait for that checkout to settle or fail first. A cart that is\n`under_review` answers `409` too: what is left in it was charged without a confirmation, and the\nagency settles it.\n\nAn item already charged and held for manual review is kept even when the rest of the cart goes —\nthe same rule `DELETE /api/v1/cart/{item_type}/{item_id}` applies. Such a cart moves to\n`under_review` with that item still in it.\n","operationId":"deleteCart","parameters":[{"name":"cart_id","in":"path","description":"The cart's `id`.","required":true,"schema":{"type":"string"},"example":"3f1a9c22-8d4e-4f70-9b21-5c8e7a0d1b34"}],"responses":{"200":{"description":"Abandoned. The body is the cart as it now stands.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartResponseEnriched"}}}},"400":{"description":"`cart_id` is not a UUID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"cart_id must be a UUID"}}}},"404":{"description":"No such cart for this traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Cart not found"}}}},"409":{"description":"The cart is checking out or under review.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Cart is checking out and cannot be abandoned"}}}},"500":{"description":"The cart could not be abandoned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Failed to abandon the cart"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]},"patch":{"tags":["Cart"],"summary":"Update a cart","description":"\nChanges what a cart *is* rather than what it holds. Both fields are optional and independent;\nsend either, both, or neither.\n\n### `title`\n\nA string renames the cart. An explicit `null` clears the name. Omitting the field leaves the\nexisting title untouched — that is the difference between `{\"title\": null}` and `{}`.\n\n### `current`\n\n`true` makes this the cart that selections land in when no `cart_id` is given. There is no\n`false`: a cart stops being current when another one takes over, or when it leaves `open`.\n\nOnly an open cart can be made current, so this answers `409` for one that is checking out or has\nsettled. Renaming such a cart is still allowed.\n","operationId":"updateCart","parameters":[{"name":"cart_id","in":"path","description":"The cart's `id`.","required":true,"schema":{"type":"string"},"example":"3f1a9c22-8d4e-4f70-9b21-5c8e7a0d1b34"}],"requestBody":{"description":"The fields to change.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCartRequest"},"example":{"current":true,"title":"Rome in May"}}},"required":true},"responses":{"200":{"description":"The cart as it now stands.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartResponseEnriched"}}}},"400":{"description":"`cart_id` is not a UUID, or the title is too long.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"title must be at most 256 characters"}}}},"404":{"description":"No such cart for this traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Cart not found"}}}},"409":{"description":"`current` was requested for a cart that is no longer open.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Cart is checking out and cannot be made current"}}}},"500":{"description":"The cart could not be updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Failed to update the cart"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/carts/{cart_id}/days":{"get":{"tags":["Day Plan"],"summary":"Get the days of a trip","description":"\nEvery day spent at a hotel in the cart, with what is already set for it and its plan, if any.\n\nA plan being made reads `generating`; poll until it is `ready` or `failed`.\n","operationId":"getTripDays","parameters":[{"name":"cart_id","in":"path","description":"The cart's `id`.","required":true,"schema":{"type":"string"},"example":"3f1a9c22-8d4e-4f70-9b21-5c8e7a0d1b34"}],"responses":{"200":{"description":"The trip's days, first to last.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripDays"}}}},"400":{"description":"`cart_id` is not a UUID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"cart_id must be a UUID"}}}},"404":{"description":"No such cart for this traveller, or day planning is not available.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Cart not found"}}}},"500":{"description":"The days could not be read.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Day planning failed"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]},"post":{"tags":["Day Plan"],"summary":"Plan days of a trip","description":"\nStarts making a plan for each of `dates`, replacing any plan they had. Only days marked\n`plannable` can be planned.\n\nPlaces already in the trip's other plans are not suggested again.\n","operationId":"planTripDays","parameters":[{"name":"cart_id","in":"path","description":"The cart's `id`.","required":true,"schema":{"type":"string"},"example":"3f1a9c22-8d4e-4f70-9b21-5c8e7a0d1b34"}],"requestBody":{"description":"The days to plan.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanDaysRequest"},"example":{"dates":["2026-11-03"],"exclude_place_ids":["516428"]}}},"required":true},"responses":{"202":{"description":"Planning has started. The body is every day of the trip.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripDays"}}}},"400":{"description":"`cart_id` is not a UUID, `dates` is empty or too long, or a date cannot be planned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"2026-11-05 cannot be planned"}}}},"404":{"description":"No such cart for this traveller, or day planning is not available.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Cart not found"}}}},"500":{"description":"Planning could not be started.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Day planning failed"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/carts/{cart_id}/days/{date}":{"delete":{"tags":["Day Plan"],"summary":"Remove a day's plan","operationId":"deleteDayPlan","parameters":[{"name":"cart_id","in":"path","description":"The cart's `id`.","required":true,"schema":{"type":"string"},"example":"3f1a9c22-8d4e-4f70-9b21-5c8e7a0d1b34"},{"name":"date","in":"path","description":"The day, `YYYY-MM-DD`.","required":true,"schema":{"type":"string"},"example":"2026-11-03"}],"responses":{"204":{"description":"The plan is gone."},"400":{"description":"`cart_id` is not a UUID or `date` is not a date.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"date must be YYYY-MM-DD"}}}},"404":{"description":"No such cart for this traveller, the day has no plan, or day planning is not available.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Day plan not found"}}}},"500":{"description":"The plan could not be removed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Day planning failed"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/carts/{cart_id}/days/{date}/order":{"put":{"tags":["Day Plan"],"summary":"Reorder a day's places","description":"\nVisits the places of a `ready` plan in a new order. Each place keeps its length of stay; the day is\nre-timed from its first visit and the way between places is worked out again.\n","operationId":"reorderDayPlan","parameters":[{"name":"cart_id","in":"path","description":"The cart's `id`.","required":true,"schema":{"type":"string"},"example":"3f1a9c22-8d4e-4f70-9b21-5c8e7a0d1b34"},{"name":"date","in":"path","description":"The day, `YYYY-MM-DD`.","required":true,"schema":{"type":"string"},"example":"2026-11-03"}],"requestBody":{"description":"The new order.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReorderDayRequest"},"example":{"place_ids":["517515","516428","517712"]}}},"required":true},"responses":{"200":{"description":"The trip's days, the reordered one included.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripDays"}}}},"400":{"description":"`cart_id` or `date` is malformed, or `place_ids` is not the plan's places in some order.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"place_ids must list every place of the plan exactly once"}}}},"404":{"description":"No such cart for this traveller, the day has no finished plan, or day planning is not available.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"2026-11-03 has no finished plan"}}}},"500":{"description":"The day could not be re-timed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Day planning failed"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/carts/{cart_id}/help":{"get":{"tags":["Cart"],"summary":"Read the agency's thread about a trip","description":"\nWhen a payment for an item went out and its provider never confirmed it, the cart turns\n`under_review` and the agency opens a thread about the trip. It starts with a line the system wrote:\nits `note` is `payment_unconfirmed` and its `body` names the item, for the app to word in the\ntraveller's language.\n\n`status` is `open` while the agency owes an answer, `answered` once it replied and waits on the\ntraveller, and `closed` when the trip is settled. The newest thread is returned, closed or not;\n`null` when the trip never had one.\n","operationId":"getCartHelp","parameters":[{"name":"cart_id","in":"path","description":"The cart's `id`.","required":true,"schema":{"type":"string"},"example":"3f1a9c22-8d4e-4f70-9b21-5c8e7a0d1b34"}],"responses":{"200":{"description":"The thread, or `null`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripHelp"}}}},"404":{"description":"No such cart for this traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Cart not found"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/carts/{cart_id}/help/messages":{"post":{"tags":["Cart"],"summary":"Write to the agency about a trip","description":"\nAdds the traveller's message to the trip's open thread and hands it back to the agency, which hears\nabout it by email. Returns the thread as it now stands.\n","operationId":"replyCartHelp","parameters":[{"name":"cart_id","in":"path","description":"The cart's `id`.","required":true,"schema":{"type":"string"},"example":"3f1a9c22-8d4e-4f70-9b21-5c8e7a0d1b34"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartHelpReply"}}},"required":true},"responses":{"200":{"description":"Written.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripHelp"}}}},"400":{"description":"The message is empty or too long.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Write a message of up to 4000 characters"}}}},"404":{"description":"No such cart for this traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Cart not found"}}}},"409":{"description":"Nothing is open about this trip.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Nothing is open about this trip"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/carts/{cart_id}/processing":{"get":{"tags":["Cart Processing"],"summary":"Get cart processing state","description":"\nWhere the run stands, item by item. Poll it to follow a run: it is the only way to learn that a paused\nrun's blocker is cleared or that the run has finished.\n\n`status` is `running` while it works, `paused` when it needs something, and `completed` or\n`cancelled` when it is over. A paused run names the item in `blocked_on` and what it wants in\n`blocked_by`:\n\n- `traveller_details` - passengers or guests are missing. Fill them in through the booking's own\n  endpoint, then resume.\n- `price_confirmation` - the provider repriced. Resume with `confirmed_price` set to the new total.\n- `hosted_payment` - the provider takes payment on its own page. Send the traveller to\n  `payment_url`; once they pay, the item shows as `booked` here on the next poll.\n- `payment_method` - an item ahead has to be charged and the run holds no card. Resume with one.\n\nAn item marked `post_payment_review` had a payment attempted whose outcome is not known. Do not\noffer to retry it and do not tell the traveller either that they were or were not charged.\n","operationId":"getCartProcessing","parameters":[{"name":"cart_id","in":"path","description":"Cart id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The run as it stands","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartProcessingSnapshot"}}}},"404":{"description":"No such cart, or it has never been processed"}},"security":[{"app_id":[],"bearer_auth":[]}]},"post":{"tags":["Cart Processing"],"summary":"Start cart processing","description":"\nStarts booking every reservation in the cart and answers immediately, before any of them has been\nbooked. Poll `GET /api/v1/carts/{cart_id}/processing` to follow it.\n\nThe payment method is used for the items whose provider accepts a card directly and is never\nstored. To split the cart across cards, send `payments` with a card per group of items;\n`payment_method` then covers the rest. Items whose provider takes payment on its own page do not\nuse a card: the run pauses on them with a `hosted_payment` URL for the traveller to open, and picks\nup again once that booking settles.\n\nWhere 3-D Secure is on, the run pauses with `card_authentication` before the first card is charged:\nrun each session with the named provider's browser SDK, then resume with the same cards.\n\nThe run stops at the first item that fails or needs something, so a cart is never part-charged\nwithout the traveller hearing about it. Resume once you have answered what it asked for.\n\nSend `insurance` to ask for travel insurance as well, where the site offers it (`insurance` in\n`GET /api/v1/client-config`). Once the cart is booked, an agent prepares insurance offers for what it\nbooked; the traveller follows them, and pays for the one they choose, under\n`GET /api/v1/quote-requests`.\n","operationId":"startCartProcessing","parameters":[{"name":"cart_id","in":"path","description":"Cart id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartProcessingRequest"}}},"required":true},"responses":{"202":{"description":"The run has started","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartProcessingSnapshot"}}}},"400":{"description":"A card was sent in the clear where card vault tokens are expected, or `insurance` is incomplete"},"404":{"description":"No such cart"},"409":{"description":"The cart is empty, already checking out, or has settled; `too_soon` when a trip in it starts sooner than this site lets travellers book, `bookings_paused` when the site takes no bookings, `insurance_unavailable` when the site offers no insurance"}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/carts/{cart_id}/processing/cancel":{"post":{"tags":["Cart Processing"],"summary":"Cancel cart processing","description":"\nStops the run at its next item. Anything already booked stays booked - there is nothing to undo -\nand the cart goes back to the traveller with whatever is left in it.\n","operationId":"cancelCartProcessing","parameters":[{"name":"cart_id","in":"path","description":"Cart id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelProcessingRequest"}}},"required":true},"responses":{"202":{"description":"The run is stopping","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartProcessingSnapshot"}}}},"404":{"description":"No such cart, or no run to cancel"},"409":{"description":"The run id is stale"}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/carts/{cart_id}/processing/resume":{"post":{"tags":["Cart Processing"],"summary":"Resume cart processing","description":"\nAnswers whatever the run stopped on and starts it again from that item.\n\nSend `payment_method` (and `payments`, for a split cart) again whenever an item ahead still has to\nbe charged: cards are dropped when a run pauses, and the run will pause right back with\n`payment_method` if it needs one it does not have - or if the bank refused the card it had for the\nblocking item. Send `confirmed_price` to accept a repricing, or `skip_item` to abandon the blocking item\nand carry on with the rest.\n\n### Replacing a flight, hotel or car that failed\n\nWhen the run stopped on a flight, hotel or car that failed before anything was charged - sold out,\nexpired, repriced, or refused by the provider - send `replace_with` with an offer from the\nsimilar-offers search for that booking:\n\n* a flight: `POST /api/v1/flight/bookings/{booking_id}/similar-offers`, sending its `search_id` and\n  the offer's `id`;\n* a hotel: `POST /api/v1/hotel/bookings/{booking_id}/similar-offers`, sending only the offer's\n  `offer_id`;\n* a car: `POST /api/v1/car/bookings/{booking_id}/similar-offers`, sending only the offer's\n  `offer_id`.\n\nThe offer is booked in the same checkout, with the failed item's travellers, guests or driver, and the run\ncarries on with the rest of the cart. The failed item then reads `replaced`, naming its\n`replacement_item_id`.\n\nAn item whose charge may already have gone through (`post_payment_review`) is never replaced:\nbooking another one could sell the trip twice. That, a replacement of another kind than the failed\nitem, a hotel offer for a different party and a car offer for other rental times answer `400`; an expired search or offer answers\n`404`.\n\nAlso restarts a run that stopped responding. A run that is still working answers `409`.\n","operationId":"resumeCartProcessing","parameters":[{"name":"cart_id","in":"path","description":"Cart id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResumeProcessingRequest"}}},"required":true},"responses":{"202":{"description":"The run has started again","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartProcessingSnapshot"}}}},"400":{"description":"`replace_with` was sent for an item that cannot be replaced, or a card came in the clear where card vault tokens are expected"},"404":{"description":"No such cart, no run to resume, or the replacement offer has expired"},"409":{"description":"The run is still working, or the run id is stale"}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/chat/messages":{"get":{"tags":["Chat"],"summary":"Read the conversation with the travel assistant","description":"\nThe traveller's conversation, oldest first - the same one they have in any messenger they have\ntalked to us on.\n\nPoll this after sending a message. `replying` is true while the assistant is working, and the\nmessages it produces appear here as they are stored. A message the traveller just sent may only\nappear together with the answer, so show it optimistically.\n\n`since_ts` keeps a poll cheap: pass the `ts` of the last message you already have.\n\nAn `action` appears once, on the first read after the assistant searched something: it carries\nthe criteria it searched, for the client to open its own results on. It is cleared as it is read.\n","operationId":"getChatMessages","parameters":[{"name":"since_ts","in":"query","description":"Return only what was stored after this Unix epoch second. Omit it for the whole\nconversation.","required":false,"schema":{"type":["integer","null"],"format":"int64"}}],"responses":{"200":{"description":"The conversation, oldest first.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatHistoryResponse"},"example":{"messages":[{"role":"user","text":"Find me a hotel in Lisbon","ts":1757419200},{"role":"agent","text":"For which nights?","ts":1757419207}],"replying":false}}}},"500":{"description":"The conversation could not be read.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Failed to load the conversation"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]},"post":{"tags":["Chat"],"summary":"Send a message to the travel assistant","description":"\nHands a message to the assistant and returns immediately.\n\nThe answer is not part of this response: the assistant works in the background, and both the\nmessage and everything it replies land in the conversation read with\n`GET /api/v1/chat/messages`. Poll that while `replying` is true.\n\nThe conversation is the traveller's, not this client's - the same history is what they see in\nany messenger they have talked to us on, and an answer that ends up somewhere else in the\nproduct (a search result, an offer in the cart) still belongs to it.\n","operationId":"sendChatMessage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendChatMessageRequest"}}},"required":true},"responses":{"202":{"description":"The message was accepted and is being worked on."},"400":{"description":"The message is empty or too long.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"text must not be empty"}}}},"500":{"description":"The message could not be accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Failed to accept the message"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]},"delete":{"tags":["Chat"],"summary":"Start the conversation over","description":"\nCloses the current conversation and opens an empty one.\n\nWhat the assistant remembers about the traveller - who they are, what they prefer, the trip they\nare planning - is not part of the conversation and survives this. So does everything already in\ntheir cart: this clears what was said, not what was done.\n\nThe conversation is the traveller's across every channel, so clearing it here clears the one they\nalso see in any messenger they have talked to us on.\n","operationId":"clearChatMessages","responses":{"204":{"description":"The conversation was cleared."},"500":{"description":"The conversation could not be cleared.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Failed to clear the conversation"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/companions":{"get":{"tags":["Companion"],"summary":"List the traveller's saved companions","description":"\nEveryone the authenticated traveller has saved to travel with, oldest first.\n\nA companion is a reusable set of traveller details - the name, date of birth and, where it was\ncollected, the contact details and travel document. Saving them once means a booking can name a\ncompanion instead of asking for the same passport number on every trip.\n\n### What is filled in\n\nOnly `first_name`, `last_name` and `dob` are ever present. Everything else was optional when the\ncompanion was saved and is left out of the payload when it was never collected, so a companion\nwith no `document` cannot yet be used as a flight passenger - fill it in with\n`PATCH /api/v1/companions/{companion_id}` before checkout.\n","operationId":"listCompanions","responses":{"200":{"description":"The traveller's companions, oldest first. Empty when they have none.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CompanionResponse"}},"example":[{"created_at":"2026-09-01T10:15:00Z","dob":"1990-12-10","email":"ada@example.com","first_name":"Ada","id":"0b6f5a41-2c7d-4e18-9a03-77c2b1e4d905","is_self":true,"last_name":"Lovelace","loyalty":[{"companion_id":"0b6f5a41-2c7d-4e18-9a03-77c2b1e4d905","id":"8c2e1d4f-3b5a-4e6c-9d7f-1a2b3c4d5e6f","kind":"air","number":"AB123456","priority":0,"program_code":"flying_blue","program_id":"5d1f0c3e-8a2b-4c7d-9e10-2f3a4b5c6d7e","program_name":"Flying Blue"}],"nationality":"GB","updated_at":"2026-09-01T10:15:00Z"}]}}},"500":{"description":"The companions could not be read.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Failed to load companions"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]},"post":{"tags":["Companion"],"summary":"Save a companion","description":"\nSaves someone the authenticated traveller travels with, so their details need not be typed again\non the next booking.\n\n### What is required\n\n`first_name`, `last_name` and `dob` identify the person and are always required. Everything else\ncan be supplied now or filled in later with `PATCH /api/v1/companions/{companion_id}`; a blank\nstring counts as not supplied.\n\n### Before they can fly\n\nA flight passenger needs `gender`, `nationality` and a `document`. A companion saved without them\nis still perfectly usable for a hotel booking - only checkout of a flight will ask for the rest.\n\nCompanions are not deduplicated: saving the same person twice creates two of them.\n","operationId":"createCompanion","requestBody":{"description":"The companion to save.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCompanionRequest"},"example":{"dob":"1990-12-10","document":{"document_expiry":"2032-04-18","document_issue_country":"GB","document_number":"X1234567","document_type":"passport"},"email":"ada@example.com","first_name":"Ada","gender":"female","last_name":"Lovelace","nationality":"GB","phone":"+1 415 555 0134"}}},"required":true},"responses":{"201":{"description":"The companion as saved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanionResponse"}}}},"400":{"description":"A field did not pass validation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"email is not a valid email address"}}}},"500":{"description":"The companion could not be saved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Failed to save the companion"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/companions/{companion_id}":{"delete":{"tags":["Companion"],"summary":"Forget a companion","description":"\nRemoves one companion of the authenticated traveller for good. Nothing else is touched: bookings\nalready made for that person keep the details they were made with.\n\nDeleting a companion that is not the caller's, or one that never existed, answers `404` alike - a\nguessed id cannot confirm that someone else has it.\n","operationId":"deleteCompanion","parameters":[{"name":"companion_id","in":"path","description":"The companion's `id`.","required":true,"schema":{"type":"string"},"example":"0b6f5a41-2c7d-4e18-9a03-77c2b1e4d905"}],"responses":{"204":{"description":"Deleted. The response has no body."},"400":{"description":"`companion_id` is not a UUID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"companion_id must be a UUID"}}}},"404":{"description":"No such companion for this traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Companion not found"}}}},"500":{"description":"The companion could not be deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Failed to delete the companion"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]},"patch":{"tags":["Companion"],"summary":"Change a saved companion","description":"\nEdits one companion of the authenticated traveller. Every field is optional and independent, so a\nform that collects only a passport can send only the `document`.\n\n### Omitted, null, and set\n\n| sent | effect |\n|---|---|\n| field omitted | left exactly as stored |\n| field sent as `null` | cleared |\n| field sent with a value | replaced |\n\nThat is the difference between `{\"phone\": null}` and `{}`. `first_name`, `last_name` and `dob`\nidentify the person and cannot be cleared - send a value or leave them out.\n\nA blank string is read as `null`, so a form that submits its empty fields clears them rather than\nsaving whitespace.\n","operationId":"updateCompanion","parameters":[{"name":"companion_id","in":"path","description":"The companion's `id`.","required":true,"schema":{"type":"string"},"example":"0b6f5a41-2c7d-4e18-9a03-77c2b1e4d905"}],"requestBody":{"description":"The fields to change.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCompanionRequest"},"example":{"document":{"document_expiry":"2032-04-18","document_issue_country":"GB","document_number":"X1234567","document_type":"passport"},"phone":"+1 415 555 0134"}}},"required":true},"responses":{"200":{"description":"The companion as it now stands.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanionResponse"}}}},"400":{"description":"`companion_id` is not a UUID, or a field did not pass validation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"email is not a valid email address"}}}},"404":{"description":"No such companion for this traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Companion not found"}}}},"500":{"description":"The companion could not be updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Failed to update the companion"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/companions/{companion_id}/loyalty":{"get":{"tags":["Loyalty"],"summary":"List a companion's loyalty memberships","description":"\nThe frequent flyer, hotel and car rental memberships saved for one of the authenticated traveller's\ncompanions, by `priority` and then program name.\n\nWhen the companion is assigned to a flight, hotel or car, the memberships that fit it are attached\nautomatically and can be changed at checkout.\n","operationId":"listLoyalty","parameters":[{"name":"companion_id","in":"path","description":"The companion's `id`.","required":true,"schema":{"type":"string"},"example":"0b6f5a41-2c7d-4e18-9a03-77c2b1e4d905"}],"responses":{"200":{"description":"The memberships. Empty when there are none.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LoyaltyMembershipResponse"}}}}},"400":{"description":"`companion_id` is not a UUID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"companion_id must be a UUID"}}}},"404":{"description":"No such companion for this traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Companion not found"}}}},"500":{"description":"The memberships could not be read.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Failed to load loyalty memberships"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]},"post":{"tags":["Loyalty"],"summary":"Add a loyalty membership to a companion","description":"\nSaves a frequent flyer, hotel or car rental membership for one of the authenticated traveller's\ncompanions. It is attached to the companion's later bookings that the program credits.\n\n### The number\n\nSpaces are dropped and letters upper-cased, so a number can be pasted as it is printed on the card.\nIt may hold up to 25 letters and digits.\n\n### One per program\n\nA companion holds at most one membership in each program; change the number of an existing one with\n`PATCH /api/v1/companions/{companion_id}/loyalty/{loyalty_id}`.\n","operationId":"createLoyalty","parameters":[{"name":"companion_id","in":"path","description":"The companion's `id`.","required":true,"schema":{"type":"string"},"example":"0b6f5a41-2c7d-4e18-9a03-77c2b1e4d905"}],"requestBody":{"description":"The membership to save.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLoyaltyRequest"},"example":{"number":"AB 123 456","program_id":"5d1f0c3e-8a2b-4c7d-9e10-2f3a4b5c6d7e"}}},"required":true},"responses":{"201":{"description":"The membership as saved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoyaltyMembershipResponse"}}}},"400":{"description":"A field did not pass validation, or the program is unknown.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"number must not be empty"}}}},"404":{"description":"No such companion for this traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Companion not found"}}}},"409":{"description":"The companion already has a membership in this program.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"The companion already has a Flying Blue membership"}}}},"500":{"description":"The membership could not be saved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Failed to save the loyalty membership"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/companions/{companion_id}/loyalty/{loyalty_id}":{"delete":{"tags":["Loyalty"],"summary":"Remove a loyalty membership","description":"\nRemoves one of a companion's memberships. Bookings already made keep the number they were made with.\n\nA membership that is not the caller's, or one that never existed, answers `404` alike.\n","operationId":"deleteLoyalty","parameters":[{"name":"companion_id","in":"path","description":"The companion's `id`.","required":true,"schema":{"type":"string"},"example":"0b6f5a41-2c7d-4e18-9a03-77c2b1e4d905"},{"name":"loyalty_id","in":"path","description":"The membership's `id`.","required":true,"schema":{"type":"string"},"example":"8c2e1d4f-3b5a-4e6c-9d7f-1a2b3c4d5e6f"}],"responses":{"204":{"description":"Deleted. The response has no body."},"400":{"description":"An id is not a UUID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"loyalty_id must be a UUID"}}}},"404":{"description":"No such companion or membership for this traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Loyalty membership not found"}}}},"500":{"description":"The membership could not be deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Failed to delete the loyalty membership"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]},"patch":{"tags":["Loyalty"],"summary":"Change a loyalty membership","description":"\nChanges the number or priority of one of a companion's memberships. Fields left out keep\ntheir value. The program itself cannot change: delete the membership and add another instead.\n\nBookings already made keep the number they were made with.\n","operationId":"updateLoyalty","parameters":[{"name":"companion_id","in":"path","description":"The companion's `id`.","required":true,"schema":{"type":"string"},"example":"0b6f5a41-2c7d-4e18-9a03-77c2b1e4d905"},{"name":"loyalty_id","in":"path","description":"The membership's `id`.","required":true,"schema":{"type":"string"},"example":"8c2e1d4f-3b5a-4e6c-9d7f-1a2b3c4d5e6f"}],"requestBody":{"description":"The fields to change.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLoyaltyRequest"},"example":{"number":"AB123457"}}},"required":true},"responses":{"200":{"description":"The membership as saved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoyaltyMembershipResponse"}}}},"400":{"description":"An id is not a UUID, or a field did not pass validation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"number must not be empty"}}}},"404":{"description":"No such companion or membership for this traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Loyalty membership not found"}}}},"500":{"description":"The membership could not be saved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Failed to save the loyalty membership"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/event/bookings/{booking_id}/delivery":{"get":{"tags":["Event"],"summary":"Read how the tickets of an event booking are delivered","description":"\nReturns the delivery method chosen for an event booking, every method its seller offers, and the\npostal address when the chosen method ships the tickets.\n\nSelection picks the first method that needs no postal address, or the first method at all when\nevery one of them ships the tickets. In that case `address` stays `null` until it is set with\n`PUT` on this path, so set it before checkout.\n\n`booking_id` is the `id` of the cart item `POST /api/v1/event/offer/{offer_id}/select` returned.\n","operationId":"getEventDelivery","parameters":[{"name":"booking_id","in":"path","description":"`id` of the event booking.","required":true,"schema":{"type":"string","format":"uuid"},"example":"c3a9f1e2-7d45-4b8a-9e0c-5f2d1b6a8c34"}],"responses":{"200":{"description":"The delivery of the booking.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventDelivery"},"example":{"address":null,"available":[{"address_required":true,"code":"1","name":"FedEx Intl Priority"},{"address_required":true,"code":"2","name":"FedEx Priority Overnight"},{"address_required":true,"code":"3","name":"UPS"}],"delivery_method_code":"1"}}}},"401":{"description":"The `X-App-Id` header is missing or malformed, or the bearer token is missing, invalid or expired. The response carries no body."},"403":{"description":"The app id is known but disabled. The response carries no body."},"404":{"description":"No such event booking for this traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Event booking not found"}}}},"500":{"description":"The booking could not be read.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Failed to load booking"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]},"put":{"tags":["Event"],"summary":"Choose how the tickets of an event booking are delivered","description":"\nSets the delivery method of an event booking still in the cart. Nothing is charged by this call;\nthe method is used when the cart is checked out.\n\nCodes are only meaningful for this booking: read them from `available` on\n`GET /api/v1/event/bookings/{booking_id}/delivery`.\n\n### Shipped tickets\n\nA method with `address_required` ships the tickets, so `address` is required with it. The address\nis kept with the ticket holder, so assign the lead traveller first through\n`PUT /api/v1/cart/items/event/{item_id}/travelers`; changing the traveller later keeps the address.\nChoosing a method without `address_required` drops a stored address.\n\n`country_code` is the two-letter ISO 3166 code. `city`, `address1` and `country_code` are required,\nand no field may be longer than 100 characters.\n\n### When it can be changed\n\nOnly while the booking is `pending`. Once checkout has started, or the tickets are bought, the\ncall answers `400`.\n","operationId":"updateEventDelivery","parameters":[{"name":"booking_id","in":"path","description":"`id` of the event booking.","required":true,"schema":{"type":"string","format":"uuid"},"example":"c3a9f1e2-7d45-4b8a-9e0c-5f2d1b6a8c34"}],"requestBody":{"description":"The method to use, and where to ship the tickets when it needs an address.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventDeliveryUpdate"},"example":{"address":{"address1":"350 5th Ave","address2":"Apt 12","city":"New York","country_code":"US","postal_code":"10118","state":"NY"},"delivery_method_code":"2"}}},"required":true},"responses":{"200":{"description":"The delivery as it is now stored.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventDelivery"}}}},"400":{"description":"The method is not offered for these tickets, the address is missing or invalid, no traveller is assigned yet, or the booking is no longer editable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"address is required for this delivery method"}}}},"401":{"description":"The `X-App-Id` header is missing or malformed, or the bearer token is missing, invalid or expired. The response carries no body."},"403":{"description":"The app id is known but disabled. The response carries no body."},"404":{"description":"No such event booking for this traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Event booking not found"}}}},"500":{"description":"The delivery could not be saved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Failed to save delivery"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/event/bookings/{booking_id}/similar-offers":{"post":{"tags":["Event"],"summary":"Shop offers similar to an event booking","description":"\nShops the tickets of an existing event booking again - every listing still on sale for the booked\nevent, for the booked number of tickets - and ranks them by how close they come to the seats booked.\n\n### Reading the response\n\n`event` is the booked event and `offers` its listings, closest first, at most 50 of them, each\ncarrying a `similarity`. Offers stay selectable for 15 minutes, like those of the event details.\n\n### Reading `offers[].similarity`\n\n`score` runs from 0 to 100, higher is closer, and is `100` for the booked listing.\n\n`match_level` names the kind of match:\n\n| `match_level` | meaning |\n|---|---|\n| `identical` | the booked listing, possibly relisted by the seller |\n| `same_row` | the booked section and row, other seats or other terms |\n| `same_section` | the booked section, another row |\n| `same_level` | another section on the booked level |\n| `similar` | another level, or one that cannot be told |\n\n`same_reservation` flags the booked listing, which is exactly `identical`. Its `price_difference`\ntells whether the tickets got dearer or cheaper since, for the whole party, fees included.\n`row_difference` counts rows back from the booked one on the same level. `differences` lists what\ndeparts from the booking, only where both sides are known.\n","operationId":"searchSimilarEventOffers","parameters":[{"name":"booking_id","in":"path","description":"`id` of the event booking to compare against.","required":true,"schema":{"type":"string","format":"uuid"},"example":"4b7e1d02-8c3f-4a91-b6d5-2e0f9a7c3b18"}],"responses":{"200":{"description":"Listings found, closest first, each with a `similarity`. An empty `offers` means nothing is available.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventDetails"}}}},"400":{"description":"The event has already started, or the booking carries no offer to compare against.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Event has already started"}}}},"401":{"description":"The `X-App-Id` header is missing or malformed, or the bearer token is missing, invalid or expired. The response carries no body."},"403":{"description":"The app id is known but disabled. The response carries no body."},"404":{"description":"No such event booking for this traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Event booking not found"}}}},"500":{"description":"Shopping could not be run.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Event search failed"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/event/offer/{offer_id}/select":{"post":{"tags":["Event"],"summary":"Put a ticket listing in the cart","description":"\nHolds one listing for the authenticated traveller and puts it in their cart, where it waits until\nit is checked out or removed. Nothing is bought and nothing is charged by this call.\n\n### Which offers can be selected\n\nAny `offer_id` this traveller was given by `GET /api/v1/event/{event_id}/offers` or\n`POST /api/v1/event/bookings/{booking_id}/similar-offers`. Offers stay resolvable for\n**15 minutes**. A `404` means the offer is gone rather than that it never existed: open the event\nagain and select the fresh id. It is also a `404` when the offer belongs to somebody else - an id\nis only selectable by the traveller it was shopped for.\n\n### What comes back\n\nA cart item. Its `id` is a **booking id, not the offer id** - that is the handle the rest of the\nfunnel uses, and the offer id stops mattering the moment the item exists. The item holds the\nnumber of tickets the event was searched for.\n\n### Before checkout\n\nThe ticket holder is the lead traveller assigned through\n`PUT /api/v1/cart/items/event/{item_id}/travelers`. The delivery method defaults to the first one\nthat needs no postal address, else the first one, which may ship the tickets; read and change it,\nand give a shipping address, with `/api/v1/event/bookings/{booking_id}/delivery`.\n\n### Selecting twice\n\nThe call is idempotent per offer. Selecting an offer the cart already holds returns the existing\nitem with `200` instead of a second one with `201`, so a retried request cannot quietly duplicate\nit. Two requests racing each other - a double click - settle the same way rather than both\ninserting; one that arrives while another is still being processed answers `409`.\n\n### Which cart it lands in\n\nWithout `cart_id` the offer goes into the traveller's **current** cart, and one is opened for them\nif they have none. Send `cart_id` to put it in a particular cart instead.\n\nA `cart_id` that is not this traveller's answers `404`, like an offer that never existed. One that\nhas already started checking out answers `409`: a cart being paid for takes no new items.\n","operationId":"selectEventOffer","parameters":[{"name":"cart_id","in":"query","required":false,"schema":{"type":["string","null"],"format":"uuid"}},{"name":"offer_id","in":"path","description":"`offer_id` of an entry in an event's `offers`.","required":true,"schema":{"type":"string"},"example":"2c7b9e4a-1d3f-4e8a-b5c6-0f9e8d7c6b5a"}],"responses":{"200":{"description":"The cart already held this offer; the existing item is returned untouched.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventCartItem"}}}},"201":{"description":"The offer is now in the cart.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventCartItem"},"example":{"created_at":"2026-09-01T10:15:00Z","currency":"USD","event_name":"Asmik Grigorian In Concert","event_start":"2026-11-18T19:30:00","id":"c3a9f1e2-7d45-4b8a-9e0c-5f2d1b6a8c34","provider":"acme","quantity":2,"status":"pending","ticket_price":"118.00","total_amount":"271.40","tz":"","updated_at":"2026-09-01T10:15:00Z"}}}},"401":{"description":"The `X-App-Id` header is missing or malformed, or the bearer token is missing, invalid or expired. The response carries no body."},"403":{"description":"The app id is known but disabled. The response carries no body."},"404":{"description":"The offer has expired, was never shopped, or belongs to another traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Offer not found or expired"}}}},"409":{"description":"Another selection for this traveller is still being processed, or the named cart is checking out.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Another selection for this traveller is in progress"}}}},"500":{"description":"The offer could not be put in the cart.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Failed to select event offer"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/event/search":{"post":{"tags":["Event"],"summary":"Search events with tickets on sale","description":"\nFinds events - concerts, sports, theatre - with at least `quantity` tickets on sale that can be\nbought together, and returns them with the price range of a single ticket.\n\n### Filters\n\n* `keyword` is a proper name: an artist, a team, a show. Leave it out to list everything matching\n  the other filters; genres (\"jazz\", \"football\") belong in `category`, not here.\n* `city` is a city name in English, e.g. `Las Vegas`.\n* `date_from` and `date_to` are calendar days local to the venue, both inclusive, at most 366 days\n  apart.\n* `quantity` defaults to `1`, at most `20`. It is carried by every event returned and by every\n  listing of it, so re-run the search to shop for another number of tickets.\n\n### Reading the response\n\n* `events` holds at most 50 events, most relevant first.\n* `pricing` is the cheapest and dearest single ticket on sale, service fees included, taxes not,\n  in `pricing.currency`: the currency the tickets are charged in, never a conversion. One response\n  can mix currencies, so read it off each event.\n* `images`, `video_ids`, `description` and `url` may come from a third-party source;\n  `images_source` says which.\n* `event_start` is local to the venue and carries its offset. `tz` names the zone when known and\n  is empty otherwise.\n* `category` is a finer label than the search's `category` filter, e.g. `OPERA`.\n* `event_id` stays resolvable for **15 minutes**: open its listings with\n  `GET /api/v1/event/{event_id}/offers` within that time.\n\nA search that matches nothing is a success: it answers `200` with an empty `events` array.\n","operationId":"searchEvents","requestBody":{"description":"What to look for and when.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventSearchQuery"},"example":{"category":"theatre","city":"New York","date_from":"2026-11-01","date_to":"2026-11-30","keyword":"Asmik Grigorian","quantity":2}}},"required":true},"responses":{"200":{"description":"Events with tickets on sale. `events` is empty when nothing matches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventSearchResult"},"example":{"events":[{"address":{"city":"New York","country":"US","postal_code":"10023","street":"30 Lincoln Center Plaza"},"category":"OPERA","description":"","event_id":"8d1f0c2e-3b4a-4c5d-9e6f-7a8b9c0d1e2f","event_start":"2026-11-18T19:30:00-05:00","images":[],"images_source":null,"location":{"latitude":40.77167,"longitude":-73.9833},"name":"Asmik Grigorian In Concert","pricing":{"currency":"USD","max_price":"1890.00","min_price":"142.50"},"provider":"acme","quantity":2,"tz":"","url":null,"venue":"Metropolitan Opera at Lincoln Center","video_ids":[]}]}}}},"400":{"description":"The date range is inverted, too long or has passed, or the quantity or keyword is out of range.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"date_to must not be before date_from"}}}},"401":{"description":"The `X-App-Id` header is missing or malformed, or the bearer token is missing, invalid or expired. The response carries no body."},"403":{"description":"The app id is known but disabled. The response carries no body."},"500":{"description":"The search could not be run. An empty result is not an error; it comes back as `200` with no events.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Event search failed"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/event/{event_id}/offers":{"get":{"tags":["Event"],"summary":"List the ticket listings of a searched event","description":"\nReturns the event together with every listing on sale for it, cheapest first. A listing is one\nseller's block of seats; its `offer_id` is what `POST /api/v1/event/offer/{offer_id}/select` takes.\n\n### Which events can be opened\n\nAny `event_id` this traveller was given by `POST /api/v1/event/search`, for **15 minutes** after\nthe search. A `404` means the event is gone rather than that it never existed: re-run the search.\nIt is also a `404` when the event was searched by somebody else.\n\n### Reading the response\n\n* Every listing is for the `quantity` the search was run for, and listings that cannot sell that\n  many tickets together are left out. Re-run the search to shop for another number.\n* `price` is one ticket before fees, `fees` the service fee per ticket. The whole party pays\n  `(price.amount + fees.amount) * quantity`, which is what the listings are ordered by. Both are\n  in `currency`, the one the tickets are charged in.\n* `seats` names the section, row and seat range as far as the seller discloses them.\n* `available` is how many tickets the seller holds in the block, which can be more than `quantity`.\n* `delivery_methods` are the ways the seller can hand the tickets over. Selection picks the first\n  one that needs no postal address, else the first one; change it with `PUT /api/v1/event/bookings/{booking_id}/delivery`.\n  A method with `address_required` ships the tickets and needs a postal address.\n* `on_hand_date` is set when the seller will only have the tickets on that day, later than today.\n* Every `offer_id` stays selectable for **15 minutes**; opening the event again issues new ones.\n","operationId":"getEventOffers","parameters":[{"name":"event_id","in":"path","description":"`event_id` of an entry in an event search's `events`.","required":true,"schema":{"type":"string"},"example":"8d1f0c2e-3b4a-4c5d-9e6f-7a8b9c0d1e2f"}],"responses":{"200":{"description":"The event and its listings, cheapest first. An empty `offers` means nothing is on sale for the searched quantity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventDetails"}}}},"401":{"description":"The `X-App-Id` header is missing or malformed, or the bearer token is missing, invalid or expired. The response carries no body."},"403":{"description":"The app id is known but disabled. The response carries no body."},"404":{"description":"The event has expired, was never searched, or was searched by another traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Event not found or expired"}}}},"500":{"description":"The listings could not be loaded from the ticket exchange.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Failed to load event offers"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/flight/bookings/{booking_id}/seat-maps":{"get":{"tags":["Flight"],"summary":"Seat maps of a flight booking","description":"\nFetches the live seat map of every upcoming segment of a flight booking from the airline, before\nor after payment. Segments that have already departed are left out.\n\nEach map points back at its segment through `segment.slice_index` and `segment.segment_index`.\nA cabin lists its `columns` left to right; an aisle runs between two neighbouring `aisle` columns.\nA seat's `prices` holds one entry per passenger (`passenger_index` is the passenger's position in\nthe booking). A passenger can pick an `available` seat only if it has a price for them; free seats\nhave an `amount` of `0`.\n\nEach price carries an `offer_id`: a signed handle naming that seat for that passenger at that\nprice, which is what seat assignment takes. Treat it as opaque. It does not expire, but the airline\ncan still turn it down if the seat has been taken or repriced since.\n\nFor a corporate's traveller whose travel policy has seat rules, each price also carries `policy`:\nwhat that policy makes of the seat at that price. Seats the policy hides are not offered, and seats\nit blocks are refused by seat assignment.\n","operationId":"getFlightSeatMaps","parameters":[{"name":"booking_id","in":"path","description":"`id` of the flight booking.","required":true,"schema":{"type":"string","format":"uuid"},"example":"9d2f4c81-3ab7-4e05-8c19-6f7a0b3d5e21"}],"responses":{"200":{"description":"Seat maps of the upcoming segments. An empty `segments` means the airline offers no seat map.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlightSeatMapsResponse"}}}},"400":{"description":"The booking is cancelled or abandoned, or its provider offers no seat maps.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Seat maps are not available for this booking"}}}},"401":{"description":"The `X-App-Id` header is missing or malformed, or the bearer token is missing, invalid or expired. The response carries no body."},"403":{"description":"The app id is known but disabled. The response carries no body."},"404":{"description":"No such flight booking for this traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Flight booking not found"}}}},"502":{"description":"The airline could not return seat maps.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Seat maps could not be loaded"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/flight/bookings/{booking_id}/seats":{"put":{"tags":["Flight"],"summary":"Pick seats on a flight booking","description":"\nEach entry is the `offer_id` of a seat map price, which names the seat, the flight, the passenger\nand the price. The passenger gets that seat on that flight, replacing any seat they held there.\nPassengers and flights not listed keep what they have.\n\nAn `offer_id` is signed for this booking and its current flights. One from another booking, for a\nflight that has since changed or departed, or altered in any way is refused. Seat availability\nis confirmed by the airline when the seat is booked.\n\nSeats can be changed only while the booking is `pending`, before checkout prepares it. They are\n`selected` until they go to the airline, at checkout or once the flight is ticketed depending on\nthe airline, and come back `confirmed`, `requested` or `rejected`.\n`total_amount` is the fare plus every seat not `rejected`.\n","operationId":"assignFlightSeats","parameters":[{"name":"booking_id","in":"path","description":"`id` of the flight booking.","required":true,"schema":{"type":"string","format":"uuid"},"example":"9d2f4c81-3ab7-4e05-8c19-6f7a0b3d5e21"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignFlightSeatsRequest"},"example":{"seats":[{"offer_id":"k1.eyJiIjoiOWQyZjRjODEtM2FiNy00ZTA1LThjMTktNmY3YTBiM2Q1ZTIxIiwiaSI6WzAsMCwwXX0"},{"offer_id":"k1.eyJiIjoiOWQyZjRjODEtM2FiNy00ZTA1LThjMTktNmY3YTBiM2Q1ZTIxIiwiaSI6WzEsMCwwXX0"}]}}},"required":true},"responses":{"200":{"description":"The flight booking after the change, with its `seats`, `fare_amount` and `total_amount`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlightCartItem"}}}},"400":{"description":"An `offer_id` is not valid for this booking, two passengers of the booking would share a seat, or the booking is already in checkout or no longer active.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid seat: the seat offer is not valid"}}}},"401":{"description":"The `X-App-Id` header is missing or malformed, or the bearer token is missing, invalid or expired. The response carries no body."},"403":{"description":"The traveller's travel policy doesn't allow one of the seats at its price.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Your travel policy doesn't allow this: Seat 12C costs $40.00, above $30.00"}}}},"404":{"description":"No such flight booking for this traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Flight booking not found"}}}},"409":{"description":"The booking is being processed; retry shortly.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Flight booking is being processed"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/flight/bookings/{booking_id}/seats/{slice_index}/{segment_index}/{passenger_index}":{"delete":{"tags":["Flight"],"summary":"Give up a seat on a flight booking","operationId":"releaseFlightSeat","parameters":[{"name":"booking_id","in":"path","description":"`id` of the flight booking.","required":true,"schema":{"type":"string","format":"uuid"},"example":"9d2f4c81-3ab7-4e05-8c19-6f7a0b3d5e21"},{"name":"slice_index","in":"path","description":"Zero-based slice of the flight.","required":true,"schema":{"type":"integer","minimum":0}},{"name":"segment_index","in":"path","description":"Zero-based segment within the slice.","required":true,"schema":{"type":"integer","minimum":0}},{"name":"passenger_index","in":"path","description":"Zero-based position of the passenger in the booking.","required":true,"schema":{"type":"integer","minimum":0}}],"responses":{"200":{"description":"The flight booking after the change, with its `seats`, `fare_amount` and `total_amount`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlightCartItem"}}}},"400":{"description":"The passenger holds no seat on that flight, or the booking is already in checkout or no longer active.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Invalid seat: No seat is assigned"}}}},"401":{"description":"The `X-App-Id` header is missing or malformed, or the bearer token is missing, invalid or expired. The response carries no body."},"403":{"description":"The app id is known but disabled. The response carries no body."},"404":{"description":"No such flight booking for this traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Flight booking not found"}}}},"409":{"description":"The booking is being processed; retry shortly.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Flight booking is being processed"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/flight/bookings/{booking_id}/similar-offers":{"post":{"tags":["Flight"],"summary":"Shop offers similar to a flight booking","description":"\nShops the trip of an existing flight booking again - the same legs on the same days, for the same\ntravellers, in the same cabin and currency, from any airline - and ranks every offer found by how\nclose it comes to what was booked.\n\nThe response is the one `POST /api/v1/flight/search` returns, with two differences: `offers` come\nclosest first, and each carries a `similarity`. Offers are selected exactly like search results,\nthrough `POST /api/v1/flight/search/{search_id}/offer/{offer_id}/select`.\n\n### Reading `similarity`\n\n`score` runs from 0 to 100, higher is closer, for the offer as a whole and for each leg in `slices`.\n\n`match_level` names the kind of match:\n\n| `match_level` | meaning |\n|---|---|\n| `identical` | the same flights sold as the same fare |\n| `same_flights` | the same flights sold as another fare (cabin, brand, fare basis, baggage) or under another airline's code |\n| `similar` | other flights |\n\nA flight is recognised under either its marketing or its operating number, so a codeshare of the\nbooked flight counts as the same flight, though never as `identical`. A retimed flight still counts as well; the move shows in\n`departure_shift_minutes` and `arrival_shift_minutes`.\n\n`same_reservation` flags the very product that was booked: every leg `identical` and the same fare\nconditions. Its `price_difference` tells whether that product got dearer or cheaper since.\n","operationId":"searchSimilarFlightOffers","parameters":[{"name":"booking_id","in":"path","description":"`id` of the flight booking to compare against.","required":true,"schema":{"type":"string","format":"uuid"},"example":"9d2f4c81-3ab7-4e05-8c19-6f7a0b3d5e21"}],"responses":{"200":{"description":"Offers found, closest first, each with its `similarity`. An empty `offers` means nothing is available.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlightSearchResultExt"}}}},"400":{"description":"The booking has already departed, or carries no itinerary to compare against.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Flight has already departed"}}}},"401":{"description":"The `X-App-Id` header is missing or malformed, or the bearer token is missing, invalid or expired. The response carries no body."},"403":{"description":"The app id is known but disabled. The response carries no body."},"404":{"description":"No such flight booking for this traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Flight booking not found"}}}},"500":{"description":"Shopping could not be run.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Flight search failed"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/flight/search":{"post":{"tags":["Flight"],"summary":"Search flight availability","description":"\nShops live availability for one itinerary and returns every priceable option, each with its full\nflight detail, all-in price and fare conditions.\n\n### Describing the trip\n\n`slices` is the trip, one entry per leg, in the order they are flown. The count is the trip type —\nthere is no separate field for it:\n\n| `slices` | trip |\n|---|---|\n| 1 | one-way |\n| 2 | return |\n| 3+ | multi-city |\n\nEvery leg is priced together as one ticket, which is not the same as buying them separately and\nusually cheaper. Legs must be ordered by `departure_date`.\n\n`origin` and `destination` are IATA codes — either one airport (`LHR`) or a metro code standing for\nall the airports of a city (`LON`, `NYC`, `PAR`). Metro codes shop every airport they cover at once,\nso use them where the traveller does not care which one they fly from.\n`GET /api/v1/airport/autocomplete` turns what a traveller types into exactly these codes; its\n`codes` field is what to send here.\n\nDates are local to the origin, and a date in the past is rejected rather than rolled forward.\n\n### Occupancy\n\n`passengers` has one entry per traveller, so three adults are three entries. `age` is what drives\nchild and infant fares and is required for both — an `infant` is a lap infant, a `child` occupies a\nseat. Adults need no age.\n\n### Defaults applied when a field is omitted\n\n`slices` and `passengers` are the only required fields. Everything else can be left out:\n\n| Field | Default |\n|---|---|\n| `cabin_class` | `economy` |\n| `max_connections` | connections are not capped |\n| `currency` | whatever currency each airline sells in |\n| `airline_filter` | every airline |\n\n### Narrowing the search\n\n* `cabin_class` shops one cabin for the whole trip. Where an airline cannot sell that cabin on a\n  leg it prices the nearest one it can, so read `slices[].segments[].cabin_class` off the result\n  rather than assuming the request was honoured on every flight.\n* `max_connections` is per leg. `0` means direct flights only.\n* `airline_filter` narrows the results to, or away from, named airlines. Both of its lists are\n  optional — send `include_only` to shop nothing else, `exclude` to drop a few carriers, and\n  `include_only` wins if you send both. Airlines are named by their **two-letter IATA code**\n  (`BA`, `AF`, `LH`, `F9`), never by name, and the code is matched against the marketing carrier —\n  the airline whose code is on the ticket, which on a codeshare is not the one operating the\n  flight.\nThere is no price, duration or baggage filter: shop first, then narrow what came back on\n`total_amount`, `slices[].duration` and `slices[].baggages`.\n\n### Currency\n\n`currency` is the ISO 4217 currency you would like prices in, not a requirement. Every offer is\npriced in the currency the ticket is charged in: that is `currency` when the provider sells in it,\nand the airline's own sale currency otherwise, never a conversion. One response can therefore mix\ncurrencies, so read `currency` off each offer.\n\n### Reading the response\n\n* `search_id` plus an `offers[].id` is the handle for the rest of the funnel — pass both to\n  `POST /api/v1/flight/search/{search_id}/offer/{offer_id}/select` to move an offer into booking. The pair stays resolvable for\n  **15 minutes**; after that the search has to be re-run.\n* `total_amount` is the all-in price for every traveller and every leg, in the offer's `currency`.\n  `base_amount` is the fare before tax and `tax_amount` the part broken out as tax, when the\n  airline breaks it out at all.\n* `expires_at` is when the airline stops honouring the price; a booking attempted after it will be\n  re-priced.\n* `slices[]` are the legs in the order requested, and `slices[].segments[]` the individual flights\n  within one. More than one segment means the leg connects; `stops[]` inside a segment is a\n  technical stop, where the aircraft lands under the same flight number and nobody changes planes.\n* `departing_at` and `arriving_at` are local times without an offset, so an arrival can read as\n  earlier than its departure on a westbound flight. Use `duration` (minutes) for elapsed time.\n* `marketing_carrier` is the code on the ticket, `operating_carrier` who actually flies it. They\n  differ on a codeshare, and it is the marketing carrier a traveller booked with.\n* `airports` resolves every IATA code appearing anywhere in the response to a name; a code missing\n  from it has no reference data, so render the bare code.\n* `conditions.refund_before_departure` / `change_before_departure` carry the fare rules. An\n  absent one means the airline told us nothing — which is not the same as \"not allowed\". The same\n  goes for `segments[].aircraft`.\n* `baggages` is what the fare includes per traveller on that leg. An absent `bag_type` means none\n  of that kind is included, so a leg with no `checked` entry is a hand-baggage-only fare.\n\n### Limits and failure modes\n\n* Results are **not** paginated and are returned in no particular order — sort them yourself.\n* A call can take several seconds. Allow a generous client timeout.\n* A search that matches nothing is a success: it answers `200` with an empty `offers` array.\n  A `500` means the search itself could not be run and is worth retrying.\n","operationId":"searchFlights","requestBody":{"description":"The legs to price, who is travelling and any filters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlightSearchRequest"},"examples":{"Multi-city, one airline":{"summary":"Three legs on a single ticket","description":"`airline_filter.include_only` keeps the whole trip on one carrier, which is what makes the legs protected against each other.","value":{"airline_filter":{"include_only":["BA"]},"cabin_class":"business","passengers":[{"passenger_type":"adult"}],"slices":[{"departure_date":"2026-11-05","destination":"CDG","origin":"LHR"},{"departure_date":"2026-11-09","destination":"FCO","origin":"CDG"},{"departure_date":"2026-11-14","destination":"LHR","origin":"FCO"}]}},"One-way, one adult":{"summary":"Minimal request — required fields only","description":"Economy, unlimited connections, priced in whatever currency the airline sells in.","value":{"passengers":[{"passenger_type":"adult"}],"slices":[{"departure_date":"2026-11-05","destination":"JFK","origin":"LHR"}]}},"Return, family, direct only":{"summary":"Return trip with children, filtered","description":"Two adults and a child, direct flights in premium economy, priced in EUR.","value":{"cabin_class":"premium_economy","currency":"EUR","max_connections":0,"passengers":[{"passenger_type":"adult"},{"passenger_type":"adult"},{"age":9,"passenger_type":"child"}],"slices":[{"departure_date":"2026-11-05","departure_time_after":"08:00:00","destination":"JFK","origin":"LON"},{"departure_date":"2026-11-12","destination":"LON","origin":"JFK"}]}}}}},"required":true},"responses":{"200":{"description":"Priceable itineraries for the requested trip. `offers` is empty when nothing is available.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlightSearchResultExt"},"example":{"airlines_available":["BA"],"airports":{"JFK":{"city_name":"New York","name":"John F. Kennedy International Airport"},"LHR":{"city_name":"London","name":"London Heathrow Airport"}},"offers":[{"base_amount":"300.00","conditions":{"change_before_departure":{"allowed":true,"penalty_amount":"50.00","penalty_currency":"USD"},"refund_before_departure":{"allowed":true,"penalty_amount":"100.00","penalty_currency":"USD"}},"currency":"USD","expires_at":"2026-11-01T10:00:00Z","id":"6d4b1c77-2f90-4a11-b0c8-7e5a9d3f1002","owner":{"iata_code":"BA","logo_url":"https://cdn.example.com/airlines/ba.png","name":"British Airways"},"passenger_identity_documents_required":false,"passengers":[{"age":null,"passenger_type":"adult"}],"slices":[{"baggages":[{"bag_type":"carry_on","quantity":1}],"conditions":{"advance_seat_selection":null,"priority_boarding":null,"priority_check_in":null},"destination":"JFK","duration":465,"fare_brand_name":"Economy","origin":"LHR","segments":[{"aircraft":{"iata_code":"777","name":"Boeing 777"},"arriving_at":"2026-11-05T13:45:00","cabin_class":"economy","departing_at":"2026-11-05T10:00:00","destination":"JFK","destination_terminal":"7","duration":465,"fare_basis_code":null,"marketing_carrier":{"iata_code":"BA","logo_url":null,"name":"British Airways"},"marketing_carrier_flight_number":"117","operating_carrier":{"iata_code":"BA","logo_url":null,"name":"British Airways"},"operating_carrier_flight_number":"117","origin":"LHR","origin_terminal":"5","stops":[]}]}],"tax_amount":"50.00","total_amount":"350.00"}],"search_id":"0f8e6a3c-6b1e-4f2a-9f1d-1c2b3a4d5e6f"}}}},"400":{"description":"The request body is malformed, a leg is missing or misordered, a departure date has passed, or nobody is travelling.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"departure_date must not be in the past"}}}},"401":{"description":"The `X-App-Id` header is missing or malformed, or the bearer token is missing, invalid or expired. The response carries no body."},"403":{"description":"The app id is known but disabled. The response carries no body."},"500":{"description":"Shopping could not be run. An empty result is not an error — it comes back as `200` with no offers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Flight search failed"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/flight/search/{search_id}/offer/{offer_id}/select":{"post":{"tags":["Flight"],"summary":"Put a shopped flight offer in the cart","description":"\nHolds one itinerary for the authenticated traveller and puts it in their cart, where it waits\nuntil it is checked out or removed. Nothing is booked and nothing is charged by this call.\n\n### Which offers can be selected\n\nA flight offer is identified by its search: send the `search_id` from `POST /api/v1/flight/search`\ntogether with the `id` of the entry in its `offers` array.\n\nSearches are kept for **15 minutes**. After that both ids mean nothing and the call answers `404`:\nre-shop and select from the fresh result. It is also a `404` when the search belongs to somebody\nelse — a search is only selectable by the traveller it was run for.\n\n### What comes back\n\nA cart item. Its `id` is a **booking id, not the offer id** — that is the handle the rest of the\nfunnel uses, and the offer id stops mattering the moment the item exists.\n\n`status` is `pending`: held, unpaid and not ticketed. Selecting reserves nothing with the airline,\nand the fare is revalidated only at checkout — `expires_at` on the offer says how long the airline\nstood behind the price.\n\n### Selecting twice\n\nThe call is idempotent per itinerary. Selecting an offer whose flights and departure times the cart\nalready holds returns the existing item with `200` instead of a second one with `201`, so a retried\nrequest cannot quietly duplicate a booking. Two requests racing each other — a double click — settle\nthe same way rather than both inserting; one that arrives while another is still being processed\nanswers `409`.\n\nOffers that fly the same route at different times are two items.\n\n### Which cart it lands in\n\nWithout `cart_id` the offer goes into the traveller's **current** cart, and one is opened for them\nif they have none. Send `cart_id` to put it in a particular cart instead — that is how several\nselections are made to belong to one trip.\n\nA `cart_id` that is not this traveller's answers `404`, like an offer that never existed. One that\nhas already started checking out answers `409`: a cart being paid for takes no new items, so open\na new cart or wait for that payment to settle.\n\nRead the whole cart back with `GET /api/v1/cart`, list them all with `GET /api/v1/carts`, and drop\nan item with `DELETE /api/v1/cart/{item_type}/{item_id}`.\n","operationId":"selectFlightOffer","parameters":[{"name":"cart_id","in":"query","required":false,"schema":{"type":["string","null"],"format":"uuid"}},{"name":"search_id","in":"path","description":"`search_id` of the flight search the offer came from.","required":true,"schema":{"type":"string"},"example":"0f8e6a3c-6b1e-4f2a-9f1d-1c2b3a4d5e6f"},{"name":"offer_id","in":"path","description":"`id` of the entry in that search's `offers`.","required":true,"schema":{"type":"string"},"example":"6d4b1c77-2f90-4a11-b0c8-7e5a9d3f1002"}],"responses":{"200":{"description":"The cart already held this itinerary; the existing item is returned untouched.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlightCartItem"}}}},"201":{"description":"The offer is now in the cart.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlightCartItem"},"example":{"created_at":"2026-09-01T10:22:00Z","currency":"USD","id":"9d2f4c81-3ab7-4e05-8c19-6f7a0b3d5e21","owner_name":"British Airways","passengers_count":1,"slices":[{"baggages":[{"bag_type":"carry_on","quantity":1}],"conditions":{"advance_seat_selection":null,"priority_boarding":null,"priority_check_in":null},"destination":"JFK","duration":465,"fare_brand_name":"Economy","origin":"LHR","segments":[{"arriving_at":"2026-11-05T13:45:00","cabin_class":"economy","departing_at":"2026-11-05T10:00:00","destination":"JFK","duration":465,"marketing_carrier":{"iata_code":"BA","logo_url":null,"name":"British Airways"},"marketing_carrier_flight_number":"117","operating_carrier":{"iata_code":"BA","logo_url":null,"name":"British Airways"},"operating_carrier_flight_number":"117","origin":"LHR","stops":[]}]}],"status":"pending","total_amount":"350.00","updated_at":"2026-09-01T10:22:00Z"}}}},"404":{"description":"The search has expired, the offer is not in it, or the search belongs to another traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Offer not found or expired"}}}},"409":{"description":"Another selection for this traveller is still being processed, or the named cart is checking out.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Another selection for this traveller is in progress"}}}},"500":{"description":"The offer could not be put in the cart.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Failed to select flight offer"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/fx-rate":{"get":{"tags":["Currency"],"summary":"Get a reference exchange rate","description":"\nReturns a reference rate for showing an amount approximately in another currency - typically a\ncar rental, which is priced in the currency the rental company charges, next to the traveller's\nown currency.\n\n### Only a reference\n\nThe rate is the day's published reference rate. It never prices anything: the provider charges\nin its own currency, and the traveller's card issuer converts at its own rate on the day, so\npresent a converted amount as approximate (for example `≈ 432.57 CAD`) and never as the price.\n\n### Currencies\n\nBoth codes are ISO 4217 and case-insensitive. Only currencies with a published reference rate\nare supported; any other code is rejected with `400`. Asking for the same currency on both\nsides returns `1`.\n","operationId":"getFxRate","parameters":[{"name":"from","in":"query","description":"ISO 4217 code of the currency the amount is in, e.g. the `currency` of a car offer.","required":true,"schema":{"type":"string"}},{"name":"to","in":"query","description":"ISO 4217 code of the currency to show the amount in.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The reference rate from `from` to `to`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxRateResponse"},"example":{"from":"USD","rate":"1.3705","to":"CAD"}}}},"400":{"description":"A code is not three letters, or there is no reference rate for that currency.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"No exchange rates for currency XYZ"}}}},"401":{"description":"The `X-App-Id` header is missing or malformed, or the bearer token is missing, invalid or expired. The response carries no body."},"403":{"description":"The app id is known but disabled. The response carries no body."},"502":{"description":"The rate source could not be reached.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Exchange rate unavailable"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/hotel/bookings/{booking_id}/similar-offers":{"post":{"tags":["Hotel"],"summary":"Shop offers similar to a hotel booking","description":"\nShops the stay of an existing hotel booking again - the same dates, rooms and guests, in the same\ncurrency and language, around the booked property - and ranks what it finds by how close it comes\nto what was booked.\n\nThe response is the one `POST /api/v1/hotel/search` returns, with these differences:\n\n* `hotels` holds at most the 10 properties closest to the booked one, closest first. The booked\n  property itself comes first whenever it is still on sale, from whichever provider sells it.\n* Every property carries its full list of offers, so `more_rates_available` is `false` except where\n  a provider failed to return more than its lead rate.\n* Each property carries a `similarity`, and so does each of its offers, which come closest first.\n\nOffers are selected exactly like search results, through\n`POST /api/v1/hotel/offer/{offer_id}/select`.\n\n### Reading `hotels[].similarity`\n\n`score` runs from 0 to 100, higher is closer, and is `100` for the booked property.\n`distance_meters` and `star_rating_difference` give the raw figures.\n\n### Reading `hotels[].offers[].similarity`\n\n`score` runs from 0 to 100, higher is closer. Beds compare by type and count, not by wording; beds\nor a view one side does not state are neither a match nor a mismatch.\n\n`match_level` names the kind of match:\n\n| `match_level` | meaning |\n|---|---|\n| `identical` | the booked room, beds and view, board, rate plan and cancellation terms |\n| `same_room` | the booked room, beds and view on other terms |\n| `same_hotel` | another room at the booked property, or the booked room with other beds or another view |\n| `similar` | another property |\n\n`same_reservation` flags the very product that was booked, which is exactly `identical`. Its\n`price_difference` tells whether that product got dearer or cheaper since. Cancellation terms count\nas the same when refundability and the free-cancellation deadline match, whatever the penalty amounts.\n","operationId":"searchSimilarHotelOffers","parameters":[{"name":"booking_id","in":"path","description":"`id` of the hotel booking to compare against.","required":true,"schema":{"type":"string","format":"uuid"},"example":"4b7e1d02-8c3f-4a91-b6d5-2e0f9a7c3b18"}],"responses":{"200":{"description":"Properties found, closest first, each with its offers closest first and a `similarity` on both. An empty `hotels` means nothing is available.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HotelSearchResultExt"}}}},"400":{"description":"The stay has already started, or the booking carries no offer to compare against.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Hotel stay has already started"}}}},"401":{"description":"The `X-App-Id` header is missing or malformed, or the bearer token is missing, invalid or expired. The response carries no body."},"403":{"description":"The app id is known but disabled. The response carries no body."},"404":{"description":"No such hotel booking for this traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Hotel booking not found"}}}},"500":{"description":"Shopping could not be run.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Hotel search failed"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/hotel/offer/{offer_id}/select":{"post":{"tags":["Hotel"],"summary":"Put a shopped hotel offer in the cart","description":"\nHolds one offer for the authenticated traveller and puts it in their cart, where it waits until it\nis checked out or removed. Nothing is booked and nothing is charged by this call.\n\n### Which offers can be selected\n\nAny `offer_id` this traveller was given by `POST /api/v1/hotel/search` or\n`GET /api/v1/hotel/rates/{offer_id}` — the two return ids from the same pool, so a rate opened\nfrom a property listing is selectable exactly like the lead rate that surfaced it.\n\nOffers are search-scoped and expire with the search that produced them. A `404` means the offer is\ngone rather than that it never existed: re-shop and select the fresh id. It is also a `404` when\nthe offer belongs to somebody else — an id is only selectable by the traveller it was shopped for.\n\n### What comes back\n\nA cart item. Its `id` is a **booking id, not the offer id** — that is the handle the rest of the\nfunnel uses, and the offer id stops mattering the moment the item exists.\n\n`status` is `pending`: held, unpaid, not confirmed with the property. Selecting does not hold\ninventory at the provider either, so an offer can still be gone at checkout.\n\n### Selecting twice\n\nThe call is idempotent per offer. Selecting an offer the cart already holds returns the existing\nitem with `200` instead of a second one with `201`, so a retried request cannot quietly duplicate a\nbooking. Two requests racing each other — a double click — settle the same way rather than both\ninserting; one that arrives while another is still being processed answers `409`.\n\nDifferent offers are different items, even at the same property over the same nights: that is how\nseveral rooms are booked for a group, each shopped with its own occupancy. Selecting the same room\nagain from a fresh search therefore adds it again — remove the old item first if the intent is to\nreplace it.\n\n### Which cart it lands in\n\nWithout `cart_id` the offer goes into the traveller's **current** cart, and one is opened for them\nif they have none. Send `cart_id` to put it in a particular cart instead — that is how several\nselections are made to belong to one trip.\n\nA `cart_id` that is not this traveller's answers `404`, like an offer that never existed. One that\nhas already started checking out answers `409`: a cart being paid for takes no new items, so open\na new cart or wait for that payment to settle.\n\nRead the whole cart back with `GET /api/v1/cart`, and list them all with `GET /api/v1/carts`.\n","operationId":"selectHotelOffer","parameters":[{"name":"cart_id","in":"query","required":false,"schema":{"type":["string","null"],"format":"uuid"}},{"name":"offer_id","in":"path","description":"Offer id from hotel search or hotel rates.","required":true,"schema":{"type":"string"},"example":"0f8e6a3c-6b1e-4f2a-9f1d-1c2b3a4d5e6f"}],"responses":{"200":{"description":"The cart already held this offer; the existing item is returned untouched.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HotelCartItem"}}}},"201":{"description":"The offer is now in the cart.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HotelCartItem"},"example":{"checkin":"2026-11-05","checkout":"2026-11-08","created_at":"2026-09-01T10:15:00Z","currency":"USD","hotel_id":"acme:lp1f2a9","hotel_name":"Grand Luxury Hotel & Spa","id":"b7c1e2a4-5f60-4d31-9a8e-2c4b6d8f0a12","provider":"acme","room_types":"1 × Deluxe King","status":"pending","total_amount":"1284.00","updated_at":"2026-09-01T10:15:00Z"}}}},"404":{"description":"The offer has expired, was never shopped, or belongs to another traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Offer not found or expired"}}}},"409":{"description":"Another selection for this traveller is still being processed, or the named cart is checking out.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Another selection for this traveller is in progress"}}}},"500":{"description":"The offer could not be put in the cart.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Failed to select hotel offer"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/hotel/rates/{offer_id}":{"get":{"tags":["Hotel"],"summary":"List every rate of a shopped property","description":"\nReturns the property behind an offer together with **all** of its bookable rates, not just the\nlead one that search returned.\n\n### When to call it\n\nSearch may return a single rate for some properties. Those come back with `more_rates_available: true` — that flag is the signal to call\nthis endpoint, typically when the guest opens the property to compare rooms.\n\nProperties with `more_rates_available: false` already carried every rate, and this endpoint answers `404` for them. Calling it blindly for every property in a result set just\nbuys you a page of 404s.\n\n### Identifying the property\n\nThere is no property id in the path: pass any `offer_id` from that property's `offers` array and\nthe rates for the property behind it come back. The stay dates, occupancy, currency and guest\nnationality of the original search are carried by the offer, so nothing needs restating — which\nalso means you cannot change them here. To search a different stay, shop again.\n\nOffer ids are search-scoped and go stale as availability moves. A `404` on an id that worked\nminutes ago means the search behind it has expired; re-shop rather than retrying.\n\n### What comes back\n\nOne property, shaped exactly like a single entry of the `hotels` array from search: the same\n`hotel` object and a longer `offers` list. Pricing, cancellation rules, `flags` and\n`free_cancellation` all read the same way as they do there, so the same rendering code handles\nboth. `more_rates_available` is `false` in this response — this *is* the full list.\n\n### Language\n\n`?language=` sets the language of what we render ourselves: the `cancellation_policy_description`\nsummary and the normalised `amenity_keys`. Supported values are `de`, `en`, `es`, `fr`, `it`,\n`ru`, `uk` and `zh`; anything else falls back to English instead of failing.\n\nProperty and room texts are not re-translated here — they stay in the language the original\nsearch ran in, so pass `language` to the search itself if you need those localised.\n","operationId":"getHotelRates","parameters":[{"name":"offer_id","in":"path","description":"Any `offer_id` from the property's `offers` array in a search response.","required":true,"schema":{"type":"string"},"example":"0f8e6a3c-6b1e-4f2a-9f1d-1c2b3a4d5e6f"},{"name":"language","in":"query","description":"Language of the text rendered on our side: one of `de`, `en`, `es`, `fr`, `it`, `ru`,\n`uk`, `zh`. Anything else, including an absent value, is served in English.","required":false,"schema":{"type":"string"},"example":"en"}],"responses":{"200":{"description":"The property with its complete list of bookable rates.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HotelOffersExt"},"example":{"hotel":{"address":{"city":"New York","country":"United States","postal_code":"10001","street":"123 5th Avenue"},"amenities":["Free WiFi","Swimming Pool","Spa & Wellness Center"],"amenity_keys":["free_wifi","pool","spa"],"description":"Five-star property on 5th Avenue, a block from Madison Square Park.","geo_location":{"latitude":40.7127837,"longitude":-74.0059413},"id":"acme:100234","images":["https://cdn.example.com/hotels/100234/1.jpg"],"name":"Grand Luxury Hotel & Spa","rating":"8.2","rating_cnt":300,"star_rating":5,"tz":"America/New_York"},"more_rates_available":false,"offers":[{"cancellation_policy":{"rules":[{"from":"2026-10-01T00:00:00-04:00","penalty":{"type":"free"}}],"timezone":"America/New_York"},"cancellation_policy_description":"Free cancellation until 3 Nov, 14:00","checkin":"2026-11-05","checkout":"2026-11-08","flags":1,"free_cancellation":true,"offer_id":"0f8e6a3c-6b1e-4f2a-9f1d-1c2b3a4d5e6f","pricing":{"currency":"USD","taxes":[],"total":"1284.00"},"rooms":[{"adults":2,"area_sqft":344,"bedding":"1 king bed","cancellation_policy":{"rules":[{"from":"2026-10-01T00:00:00-04:00","penalty":{"type":"free"}}],"timezone":"America/New_York"},"capacity":2,"children_ages":null,"flags":1,"pricing":{"currency":"USD","taxes":[],"total":"1284.00"},"rate_plan":"Bed & Breakfast","room_amenities":["Free WiFi","Minibar"],"room_id":"DLX-K","room_images":[],"room_type":"Deluxe King","view":"Park view"}]},{"cancellation_policy":{"rules":[{"from":null,"penalty":{"type":"full"}}],"timezone":"America/New_York"},"cancellation_policy_description":"Non-refundable","checkin":"2026-11-05","checkout":"2026-11-08","flags":9,"free_cancellation":false,"offer_id":"b71c0e94-0f52-4a6d-9a2f-3d8e5c1b7a44","pricing":{"currency":"USD","taxes":[],"total":"1980.00"},"rooms":[{"adults":2,"area_sqft":592,"bedding":"1 king bed and 1 sofa bed","cancellation_policy":{"rules":[{"from":null,"penalty":{"type":"full"}}],"timezone":"America/New_York"},"capacity":3,"children_ages":null,"flags":9,"pricing":{"currency":"USD","taxes":[],"total":"1980.00"},"rate_plan":"All Inclusive, Non-refundable","room_amenities":["Free WiFi","Minibar","Lounge access"],"room_id":"EXE-STE","room_images":[],"room_type":"Executive Suite","view":null}]}]}}}},"401":{"description":"The `X-App-Id` header is missing or malformed, or the bearer token is missing, invalid or expired. The response carries no body."},"403":{"description":"The app id is known but disabled. The response carries no body."},"404":{"description":"The search behind this offer has expired (`This search has expired. Search again to see current rates.`), or the property has no rates beyond the ones search already returned (`No additional rates for this offer`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"This search has expired. Search again to see current rates."}}}},"500":{"description":"Rates could not be fetched.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Failed to load hotel rates"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/hotel/search":{"post":{"tags":["Hotel"],"summary":"Search hotel availability","description":"\nShops live availability for one stay and returns every matching property together with its\nbookable room offers, all-in pricing and cancellation terms.\n\n### Where the search runs\n\n`latitude` / `longitude` are the centre of the search, and only properties within `radius_km` of\nthat point are considered. Resolve the place in your own UI — a map pin, a geocoded search box —\nand send the point.\n\nThe one exception is `requested_hotel_name`: because a property name is not a coordinate, it is\ngeocoded, and the point it resolves to wins over the one you sent. Your coordinates remain the\nfallback for when that lookup finds nothing, so keep sending a sensible pair.\n\n### Defaults applied when a field is omitted\n\n| Field | Default |\n|---|---|\n| `radius_km` | `5` (kilometres) |\n| `guest_nationality` | `US` |\n| `currency` | `USD` |\n| `language` | `en` |\n\n`language` is fully supported for `de`, `en`, `es`, `fr`, `it`, `ru`, `uk` and `zh`. Other ISO\n639-1 codes may localise property texts while cancellation summaries and amenity keys stay\nEnglish. Nothing unsupported fails the request; it falls back to English.\n\n`guest_nationality` matters for pricing: many rates are nationality-restricted.\n\n### Currency\n\n`currency` is the ISO 4217 currency you would like prices in, not a requirement. Every offer is\npriced in the currency the stay is charged in: that is `currency` when the provider sells in it,\nand the hotel's own currency otherwise, never a conversion. One response can therefore mix\ncurrencies, so read `pricing.currency` off each offer.\n\n### Occupancy\n\n`rooms` describes the physical rooms you need — one entry per room. Every returned offer is\npriced for the whole party, so a two-entry `rooms` array yields offers that already contain two\nrooms in `offers[].rooms[]`. `children_ages` must list one age per child; ages drive both\neligibility and price, and an empty array means no children.\n\n### Reading the response\n\n* `hotels[].offers[].offer_id` is the handle for the rest of the funnel. Pass it to\n  `GET /api/v1/hotel/rates/{offer_id}` for the property's full rate list and to\n  `POST /api/v1/hotel/offer/{offer_id}/select` to move the offer into booking. Offer ids are search-scoped —\n  re-shop instead of storing them long term.\n* `pricing.total` is the all-in amount for the entire stay and all requested rooms, in\n  `pricing.currency`. `taxes[]` breaks that down; check `included_in_price` on each entry to see\n  whether it is already inside `total` or payable at the property.\n* `suggested_selling_price` is only present when it is above `total`, i.e. when the rate leaves\n  a margin to display as a strike-through price.\n* `cancellation_policy.rules[]` is ordered by `from` in the property's `timezone`. `free_cancellation`\n  and the ready-to-render `cancellation_policy_description` are derived from those rules in the\n  requested language.\n* `flags` carries the board and lounge benefits — see *Board and benefits* below.\n* `amenity_keys` are the normalised, language-independent counterparts of the free-text\n  `amenities` list — match on those (`free_wifi`, `pool`, `gym`, …), not on the display strings.\n* `more_rates_available` marks properties that came back with only a lead rate. For those,\n  `GET /api/v1/hotel/rates/{offer_id}` returns the property with its full list of offers,\n  shaped like one entry of `hotels`; for the rest that call answers `404`, because search already\n  carried everything.\n\n### Filtering\n\n`hotel_star_ratings` matches half steps, so `4` also returns 4.5-star properties.\n\n`amenities` is an AND: a property has to offer every amenity you list. The accepted values are enumerated on the field itself — they are\ncase-sensitive identifiers such as `FreeWiFi` or `SwimmingPool`, not free text.\n\nBoth filters narrow real inventory, so an over-constrained search comes back empty rather than\nmerely short.\n\nBoard and refundability are not request filters: shop first, then narrow what came back using\n`offers[].flags` and `offers[].free_cancellation`, both of which are returned for exactly that.\n\n### Board and benefits\n\n`offers[].flags` is a bitmask. Each room carries its own `flags` too, which matter when an offer\ncovers several rooms on different rate plans.\n\n| Bit | Value | Meaning |\n|---|---|---|\n| 0 | `1` | Breakfast |\n| 1 | `2` | Lunch |\n| 2 | `4` | Dinner |\n| 3 | `8` | All inclusive |\n| 4 | `16` | Lounge access |\n\nThree things to know before you filter on it:\n\n* **Test bits, never equality.** Benefits combine: a rate with breakfast and lounge access is\n  `17`, so `flags === 1` silently drops it.\n* **All-inclusive does not set the meal bits.** It is mapped to `8` on its own, so a \"breakfast\n  included\" filter has to accept `1` *or* `8` — otherwise the most generous rates disappear from\n  your results.\n* **`null` is not `0`.** `0` means the rate explicitly includes no meals (room only); `null` means\n  the provider told us nothing about board. Treat `null` as unknown, not as \"no breakfast\".\n\n```js\nconst BREAKFAST = 1, ALL_INCLUSIVE = 8;\nconst withBreakfast = result.hotels\n  .flatMap((h) => h.offers)\n  .filter((offer) => (offer.flags ?? 0) & (BREAKFAST | ALL_INCLUSIVE));\n```\n\nRefundable rates work the same way, minus the arithmetic: keep the offers whose\n`free_cancellation` is `true`, and show `cancellation_policy_description` for the rendered terms.\n\n### Limits and failure modes\n\n* Results are capped and are **not** paginated. Tighten `radius_km` or the filters to get the\n  most relevant properties.\n* A call can take several seconds. Allow a generous client timeout.\n* A search that matches nothing is a success: it answers `200` with an empty `hotels` array.\n  A `500` means the search itself could not be run and is worth retrying.\n","operationId":"searchHotels","requestBody":{"description":"Stay dates, occupancy and optional filters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HotelSearchRequest"},"examples":{"Couple, one room":{"summary":"Minimal request — required fields only","description":"Everything else falls back to the documented defaults: 5 km radius, US nationality, USD, English.","value":{"check_in":"2026-11-05","check_out":"2026-11-08","latitude":40.7075,"longitude":-74.0113,"rooms":[{"adults":2,"children":0,"children_ages":[]}]}},"Family, two rooms, filtered":{"summary":"Two rooms with children, filters and localisation","description":"Four-star-and-up properties with a pool and free WiFi, priced in EUR and described in German.","value":{"amenities":["SwimmingPool","FreeWiFi"],"check_in":"2026-11-05","check_out":"2026-11-08","currency":"EUR","guest_nationality":"DE","hotel_star_ratings":[4,5],"language":"de","latitude":41.3874,"longitude":2.1686,"radius_km":3.0,"rooms":[{"adults":2,"children":2,"children_ages":[5,9]},{"adults":1,"children":0,"children_ages":[]}]}},"One named property":{"summary":"Availability for a specific hotel","description":"`requested_hotel_name` is matched leniently, which narrows the search onto that property.","value":{"check_in":"2026-11-05","check_out":"2026-11-06","latitude":48.8566,"longitude":2.3522,"radius_km":1.0,"requested_hotel_name":"Hotel Lutetia","rooms":[{"adults":1,"children":0,"children_ages":[]}]}}}}},"required":true},"responses":{"200":{"description":"Matching properties with their bookable offers. `hotels` is empty when nothing is available for the requested stay.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HotelSearchResultExt"},"example":{"hotels":[{"hotel":{"address":{"city":"New York","country":"United States","postal_code":"10001","street":"123 5th Avenue"},"amenities":["Free WiFi","Swimming Pool","Spa & Wellness Center","Fitness Center"],"amenity_keys":["free_wifi","pool","spa","gym"],"description":"Five-star property on 5th Avenue, a block from Madison Square Park.","geo_location":{"latitude":40.7127837,"longitude":-74.0059413},"id":"acme:lp1f2a9","images":["https://cdn.example.com/hotels/lp1f2a9/1.jpg"],"name":"Grand Luxury Hotel & Spa","rating":"8.2","rating_cnt":300,"star_rating":5,"tz":"America/New_York"},"more_rates_available":true,"offers":[{"cancellation_policy":{"rules":[{"from":"2026-10-01T00:00:00-04:00","penalty":{"type":"free"}},{"from":"2026-11-03T14:00:00-05:00","penalty":{"currency":"USD","type":"amount","value":"428.00"}},{"from":"2026-11-05T00:00:00-05:00","penalty":{"type":"full"}}],"timezone":"America/New_York"},"cancellation_policy_description":"Free cancellation until 3 Nov, 14:00","checkin":"2026-11-05","checkout":"2026-11-08","flags":1,"free_cancellation":true,"offer_id":"0f8e6a3c-6b1e-4f2a-9f1d-1c2b3a4d5e6f","pricing":{"currency":"USD","suggested_selling_price":"1420.00","taxes":[{"amount":"112.35","description":"Sales tax","included_in_price":true,"mandatory":true,"percentage":"8.875","tax_type":"VAT"},{"amount":"24.00","description":"City tax, payable at the property","included_in_price":false,"mandatory":true,"percentage":null,"tax_type":"CITY_TAX"}],"total":"1284.00"},"rooms":[{"adults":2,"area_sqft":344,"bedding":"1 king bed","cancellation_policy":{"rules":[{"from":"2026-10-01T00:00:00-04:00","penalty":{"type":"free"}}],"timezone":"America/New_York"},"capacity":2,"children_ages":null,"description":"32 m² room with a king bed and park view.","flags":1,"pricing":{"currency":"USD","taxes":[],"total":"1284.00"},"rate_plan":"Bed & Breakfast","room_amenities":["Free WiFi","Minibar","Safe"],"room_id":"DLX-K","room_images":["https://cdn.example.com/hotels/lp1f2a9/rooms/deluxe-king.jpg"],"room_type":"Deluxe King","view":"Park view"}]},{"cancellation_policy":{"rules":[{"from":null,"penalty":{"type":"full"}}],"timezone":"America/New_York"},"cancellation_policy_description":"Non-refundable","checkin":"2026-11-05","checkout":"2026-11-08","flags":0,"free_cancellation":false,"offer_id":"6d4b1c77-2f90-4a11-b0c8-7e5a9d3f1002","pricing":{"currency":"USD","taxes":[],"total":"1098.00"},"rooms":[{"adults":2,"area_sqft":344,"bedding":"1 king bed","cancellation_policy":{"rules":[{"from":null,"penalty":{"type":"full"}}],"timezone":"America/New_York"},"capacity":2,"children_ages":null,"flags":0,"pricing":{"currency":"USD","taxes":[],"total":"1098.00"},"rate_plan":"Room Only, Non-refundable","room_amenities":["Free WiFi","Minibar","Safe"],"room_id":"DLX-K","room_images":[],"room_type":"Deluxe King","view":null}]}]}]}}}},"400":{"description":"The request body is malformed, the stay dates are not a valid range, no room was requested, or the coordinates are out of range.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"check_in must be before check_out"}}}},"401":{"description":"The `X-App-Id` header is missing or malformed, or the bearer token is missing, invalid or expired. The response carries no body."},"403":{"description":"The app id is known but disabled. The response carries no body."},"500":{"description":"Shopping could not be run. An empty result is not an error — it comes back as `200` with no hotels.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Hotel search failed"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/insurance/quote":{"post":{"tags":["Insurance"],"summary":"Price travel insurance for a trip","description":"\nPrices one trip with every insurer available and returns their plans, cheapest first. Nothing is\nbought or held by this call.\n\n### The trip\n\n* `start_date` and `end_date` are the first and last day of cover.\n* `residence_country` is where the travellers live, not their nationality: it decides which\n  insurers may sell to them. US residents also need `residence_region`, their state, because\n  products and prices differ by state.\n* Each traveller is an `age`, or a `dob` the age on `start_date` is taken from.\n* `trip_cost` is what the whole party paid, in `currency`. It is required with\n  `cover.cancellation`, since cancellation cover pays it back.\n\n### Reading the response\n\n* `pricing.total` is what the traveller pays for the whole party, in `pricing.currency`. Offers\n  are priced in `currency` wherever the insurer allows; one that is not goes after those that are.\n  `pricing.is_starting_price` marks a \"from\" price; the insurer sets the exact premium.\n* `coverages` lists each benefit with its `limit`, e.g. `{ \"type\": \"amount\", \"value\": \"1000000\",\n  \"currency\": \"EUR\" }`, `{ \"type\": \"included\" }` or `{ \"type\": \"not_covered\" }`.\n* `documents` holds the policy terms and, where regulators require one, the product summary.\n  Show them, the `insurer` and the `disclaimer` wherever the offer is shown.\n\n### Failure modes\n\nA trip no insurer covers is a success: it answers `200` with an empty `offers` array. A `500`\nmeans the quote itself could not be run, and is worth retrying.\n","operationId":"quoteInsurance","requestBody":{"description":"The trip to cover.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsuranceQuoteRequest"},"example":{"cover":{"annual":false,"cancellation":true,"extreme_sports":false},"currency":"CAD","destinations":["MX"],"end_date":"2026-12-17","language":"en","purpose":"leisure","residence_country":"CA","start_date":"2026-12-10","travellers":[{"age":41},{"dob":"1988-04-02"}],"trip_cost":"4200.00"}}},"required":true},"responses":{"200":{"description":"Plans covering the trip, cheapest first. `offers` is empty when no insurer covers it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsuranceQuoteResult"}}}},"400":{"description":"The trip is incomplete or malformed: dates out of order or past, a code that is not ISO, a traveller without an age, or cancellation cover without a trip cost.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"trip_cost is required for cancellation cover"}}}},"401":{"description":"The `X-App-Id` header is missing or malformed, or the bearer token is missing, invalid or expired. The response carries no body."},"403":{"description":"The app id is known but disabled. The response carries no body."},"500":{"description":"The quote could not be run. A trip no insurer covers is not an error; it comes back as `200` with no offers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Insurance quote failed"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/loyalty-programs":{"get":{"tags":["Loyalty"],"summary":"List the loyalty programs a traveller can add","description":"\nThe airline, hotel and car rental programs a saved traveller can hold a membership in, by kind and\nthen name.\n\n`supplier_codes` are the airlines, GDS hotel chain codes or car vendor codes whose bookings credit\nthe program directly. An airline program is also applied to flights of its alliance partners.\n","operationId":"listLoyaltyPrograms","parameters":[{"name":"kind","in":"query","description":"Only programs of this kind; every kind when omitted.","required":false,"schema":{"$ref":"#/components/schemas/LoyaltyKind"}}],"responses":{"200":{"description":"The programs.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LoyaltyProgram"}},"example":[{"code":"flying_blue","id":"5d1f0c3e-8a2b-4c7d-9e10-2f3a4b5c6d7e","kind":"air","name":"Flying Blue","supplier_codes":["AF","KL"]}]}}},"500":{"description":"The programs could not be read.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Failed to load loyalty programs"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/place/autocomplete":{"get":{"tags":["Place"],"summary":"Suggest places to search hotels in","description":"\nResolves what a traveller is typing into places they can shop — towns, islands and regions.\nEach suggestion carries a ready-to-use hotel search: pass `latitude`, `longitude` and\n`search_radius_km` straight into `POST /api/v1/hotel/search`.\n\n### What it searches\n\nPlaces of three kinds, told apart by `kind`:\n\n| `kind` | what it is |\n|---|---|\n| `city` | towns and cities, small resorts included |\n| `region` | regions and first-order divisions — Tuscany, Algarve, Bavaria |\n| `island` | islands people book by name — Santorini, Bali, Crete, Malta |\n\nCountries are not offered as suggestions. Typing one returns its leading cities instead.\n\n### The point and the radius\n\n`latitude`, `longitude` and `search_radius_km` are the recommended hotel search for the place,\nwhich is not necessarily its geometric centre. The radius is a recommendation, not a constraint —\nnarrow it for a tighter search, widen it to shop a whole area. It is capped at 150 km.\n\n### Matching\n\nNames are matched in every supported language and in common transliterations, independent of\n`language`: `Munich`, `München`, `Мюнхен` and `慕尼黑` all resolve to the same city. Case, accents\nand punctuation are ignored, so `val d isere` finds `Val-d'Isère`.\n\nMatching is by prefix, and small typos are tolerated. Terms shorter than three characters are\nrejected with `400`. Results are ordered by how well the name matched and how prominent the place\nis.\n\n### Airports\n\nWith `include=airport`, airports join the results, with `kind` set to `airport`, an `iata_code`,\nand neither `id` nor `population`. An airport ranks below the city it serves.\n\n### Localisation\n\n`language` only decides how suggestions are **labelled**. Where there is no translation, `name`\nand `label` fall back to the local spelling. `region` and `country_name` are always in English.\n\n### Using the result\n\n`label` is ready to render as-is (`Paris, Île-de-France, France`); build your own from\n`name`, `region` and `country_name` if you want it differently. `id` is stable, so it is safe to\nstore as a user's saved destination. `iata_city_code` is present where the place has one.\n","operationId":"autocompletePlaces","parameters":[{"name":"q","in":"query","description":"What the user has typed so far.","required":true,"schema":{"type":"string"}},{"name":"language","in":"query","description":"ISO 639-1 code deciding the language of `name` and `label`. Defaults to the\n`Accept-Language` header, then English.","required":false,"schema":{"type":["string","null"]}},{"name":"limit","in":"query","description":"How many suggestions to return, 1–25.","required":false,"schema":{"type":["integer","null"],"format":"int64"}},{"name":"country","in":"query","description":"ISO 3166-1 alpha-2 code to restrict the search to one country.","required":false,"schema":{"type":["string","null"]}},{"name":"include","in":"query","description":"`airport` to rank airports in with the places. Places only by default.","required":false,"schema":{"type":["string","null"]}}],"responses":{"200":{"description":"Matching places, best first. `results` is empty when nothing matched.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlaceAutocompleteResponse"},"example":{"results":[{"country_code":"FR","country_name":"France","iata_city_code":"PAR","iata_code":null,"id":2988507,"kind":"city","label":"Paris, Île-de-France, France","latitude":48.85341,"longitude":2.3488,"name":"Paris","population":2138551,"region":"Île-de-France","search_radius_km":19.9,"timezone":"Europe/Paris"},{"country_code":"SR","country_name":"Suriname","iata_city_code":"PBM","iata_code":null,"id":3703358,"kind":"city","label":"Paramaribo, Paramaribo District, Suriname","latitude":5.86638,"longitude":-55.16682,"name":"Paramaribo","population":223757,"region":"Paramaribo District","search_radius_km":15.9,"timezone":"America/Paramaribo"},{"country_code":"ID","country_name":"Indonesia","iata_city_code":null,"iata_code":null,"id":1650534,"kind":"island","label":"Bali, Indonesia","latitude":-8.52,"longitude":115.18,"name":"Bali","population":4225384,"region":null,"search_radius_km":46.5,"timezone":"Asia/Makassar"}]}}}},"400":{"description":"The term is shorter than three characters, or `include` is not `airport`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"q must be at least 3 characters"}}}},"401":{"description":"The `X-App-Id` header is missing or malformed, or the bearer token is missing, invalid or expired. The response carries no body."},"403":{"description":"The app id is known but disabled. The response carries no body."},"500":{"description":"The place catalog could not be queried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"Place autocomplete failed"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/quote-requests":{"get":{"tags":["Quote Requests"],"summary":"The traveller's group and custom requests","operationId":"listQuoteRequests","responses":{"200":{"description":"Newest first, each with how many offers it has.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteRequestsResponse"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]},"post":{"tags":["Quote Requests"],"summary":"File a group or custom request","description":"\nFiles a request no instant booking covers - a hotel room block, a group excursion, a private dinner -\nwith the agency's agents. They answer with offers over hours or days, which show up in\n`GET /api/v1/quote-requests/{id}`; the traveller is told by email, and in the chat when the request\nwas filed there.\n\n`kind` decides what `details` holds: nothing for `custom`, the room mix and preferences for\n`hotel_block`.\n","operationId":"createQuoteRequest","requestBody":{"description":"The brief.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewQuoteRequest"},"example":{"budget_amount":18000,"currency":"EUR","details":{"board":"breakfast","kind":"hotel_block","min_stars":4,"rooms":[{"count":16,"room_type":"double"},{"count":8,"room_type":"single"}]},"end_date":"2027-06-14","kind":"hotel_block","location_text":"Lisbon","party_size":40,"requirements":"Sea view if possible, close to the venue in Belem.","start_date":"2027-06-11","title":"Wedding room block in Lisbon"}}},"required":true},"responses":{"200":{"description":"The request as filed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerQuoteRequest"}}}},"400":{"description":"The brief did not pass validation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error":"The end date is before the start date"}}}},"409":{"description":"The agency takes no new group or custom requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/quote-requests/{request_id}":{"get":{"tags":["Quote Requests"],"summary":"One request with its offers and timeline","description":"\nThe request, every offer the agents published on it (never their drafts), the conversation with the\nagent oldest first, and the booking once an offer was accepted.\n","operationId":"getQuoteRequest","parameters":[{"name":"request_id","in":"path","description":"The request's `id`.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerQuoteRequest"}}}},"404":{"description":"No such request for this traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/quote-requests/{request_id}/balance":{"post":{"tags":["Quote Requests"],"summary":"Start paying the balance","description":"\nAfter a deposit, answers with the page that takes the rest of the total, and the `client_secret` for\na portal that takes the card on its own form; it then records the payment with\n`POST /api/v1/quote-requests/{request_id}/offers/{offer_id}/confirm-payment`. The booking's\n`balance_open` on `GET /api/v1/quote-requests/{request_id}` says whether there is one to pay.\n","operationId":"payQuoteBalance","parameters":[{"name":"request_id","in":"path","description":"The request's `id`.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptQuoteOfferRequest"},"example":{"lang":"en"}}},"required":true},"responses":{"200":{"description":"How to pay.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuotePayment"}}}},"404":{"description":"No such request for this traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"Nothing is left to pay, or payments aren't set up.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/quote-requests/{request_id}/cancel":{"post":{"tags":["Quote Requests"],"summary":"Cancel a request before paying","description":"Cancels the request and drops an accepted offer that isn't paid yet. Once paid, only the agent can cancel it.","operationId":"cancelQuoteRequest","parameters":[{"name":"request_id","in":"path","description":"The request's `id`.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelQuoteRequest"},"example":{"reason":"We booked the venue's own hotel."}}},"required":true},"responses":{"200":{"description":"The cancelled request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerQuoteRequest"}}}},"404":{"description":"No such request for this traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"It's paid or already finished.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/quote-requests/{request_id}/insurance-documents/{document_id}":{"get":{"tags":["Quote Requests"],"summary":"A file on an insurance request","description":"\nOne of the files listed in an insurance request's `insurance.documents`: an offer's terms, or the\ncertificate of the issued policy. Answers with the file itself, a PDF or an image.\n","operationId":"getInsuranceDocument","parameters":[{"name":"request_id","in":"path","description":"The request's `id`.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"document_id","in":"path","description":"The document's `id`.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The file.","content":{"application/pdf":{}}},"404":{"description":"No such document on this traveller's request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/quote-requests/{request_id}/messages":{"post":{"tags":["Quote Requests"],"summary":"Write to the agent","description":"Adds the traveller's message to the request's timeline and tells the agent. An answer to the agent's question puts the request back in their hands.","operationId":"postQuoteMessage","parameters":[{"name":"request_id","in":"path","description":"The request's `id`.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteMessageRequest"},"example":{"body":"Two of the doubles should be twin rooms."}}},"required":true},"responses":{"200":{"description":"The request as it now stands.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerQuoteRequest"}}}},"400":{"description":"The message is empty or too long.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"No such request for this traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"The request is closed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/quote-requests/{request_id}/offers/{offer_id}/accept":{"post":{"tags":["Quote Requests"],"summary":"Accept an offer and get the payment page","description":"\nAccepts one published offer, declining the others, and answers with the page that takes what is due\nnow: the offer's deposit, or its total. An offer with nothing due now has no page: accepting it hands\nit to the agent to book straight away. Once paid, the agent books it with the supplier and confirms\non the request's timeline.\n\nAccepting the same offer again answers with the same booking and page, so a traveller who closed the\npage can come back to it.\n","operationId":"acceptQuoteOffer","parameters":[{"name":"request_id","in":"path","description":"The request's `id`.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"offer_id","in":"path","description":"The offer's `id`.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptQuoteOfferRequest"},"example":{"lang":"en"}}},"required":true},"responses":{"200":{"description":"Where to pay.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuotePayment"}}}},"404":{"description":"No such request or offer for this traveller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"The offer ran out or was withdrawn, another one was accepted, or payments aren't set up.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}},"/api/v1/quote-requests/{request_id}/offers/{offer_id}/confirm-payment":{"post":{"tags":["Quote Requests"],"summary":"Record the payment taken on the portal's own card form","description":"\nFor a portal that confirms the accepted offer's Stripe payment itself, with the `client_secret` the\naccept call (or, after a deposit, the balance call) answered with, instead of sending the traveller\nto the payment page. Checks the payment\nwith Stripe and, once it went through, hands the booking to the agent to book with the supplier.\n\nAnswers with the request as it stands: the booking's `paid_at` stays empty while Stripe hasn't\nsettled the payment yet. Confirming again changes nothing.\n","operationId":"confirmQuoteOfferPayment","parameters":[{"name":"request_id","in":"path","description":"The request's `id`.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"offer_id","in":"path","description":"The accepted offer's `id`.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerQuoteRequest"}}}},"404":{"description":"No such request for this traveller, or no booking of this offer.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"No payment was started for the booking.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"app_id":[],"bearer_auth":[]}]}}},"components":{"schemas":{"AcceptQuoteOfferRequest":{"type":"object","properties":{"lang":{"type":["string","null"],"description":"The payment page's language, `en` when absent."}}},"Address":{"type":"object","description":"Postal address of a property.","required":["city","country"],"properties":{"city":{"type":"string","example":"New York"},"country":{"type":"string","example":"United States"},"postal_code":{"type":["string","null"],"example":"10001"},"street":{"type":["string","null"],"example":"123 5th Avenue"}}},"Aircraft":{"type":"object","required":["name","iata_code"],"properties":{"iata_code":{"type":"string","example":"777"},"name":{"type":"string","example":"Boeing 777"}}},"Airline":{"type":"object","description":"An airline, resolved against our reference data where we have it.","required":["iata_code","name"],"properties":{"iata_code":{"type":"string","example":"BA"},"logo_url":{"type":["string","null"]},"name":{"type":"string","description":"Falls back to the IATA code when the carrier is not in our reference data.","example":"British Airways"}}},"AirlineAutocompleteResponse":{"type":"object","required":["results"],"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/AirlineSuggestion"}}}},"AirlineFilter":{"type":"object","description":"Airlines to keep or drop, given as two-letter IATA airline codes — `BA`, `AF`, `LH` — and\nmatched against the marketing carrier, the code on the ticket. Both lists are optional; send\nwhichever one you need. `include_only` wins when both are filled.","properties":{"exclude":{"type":"array","items":{"type":"string"},"description":"Optional. Leave these carriers out. Ignored while `include_only` is non-empty.","example":["F9","NK"]},"include_only":{"type":"array","items":{"type":"string"},"description":"Optional. Shop these carriers only. Omitted or empty means every airline.","example":["BA","AF"]}}},"AirlineSuggestion":{"type":"object","description":"One autocomplete result: an airline a flight can be sold under.","required":["iata","name"],"properties":{"alliance":{"type":["string","null"]},"country":{"type":["string","null"]},"iata":{"type":"string","description":"The two-character IATA designator, as `marketing_carrier.iata_code` of a flight offer carries it."},"logo_url":{"type":["string","null"]},"name":{"type":"string"}}},"AirportAutocompleteResponse":{"type":"object","required":["results"],"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/AirportSuggestion"}}}},"AirportDisplayInfo":{"type":"object","description":"Airport display info for enriching IATA codes with readable names.","required":["name","city_name"],"properties":{"city_name":{"type":"string"},"country_code":{"type":["string","null"],"description":"ISO country the airport sits in, which is what makes an itinerary domestic or not."},"name":{"type":"string"}}},"AirportInfo":{"type":"object","description":"What to call an IATA code.","required":["name"],"properties":{"city_name":{"type":["string","null"],"description":"The city it serves, when known — usually the more recognisable of the two."},"name":{"type":"string","description":"Airport name as the reference data has it, e.g. `John F. Kennedy Intl`."}}},"AirportSuggestion":{"type":"object","description":"One autocomplete result: somewhere a flight can depart from or arrive at.","required":["code","kind","codes","name","label","country_code","country_name","airport_count"],"properties":{"airport_count":{"type":"integer","format":"int32","description":"How many airports `codes` holds.","example":1},"city_name":{"type":["string","null"],"description":"The city served, in the requested language.","example":"London"},"code":{"type":"string","description":"IATA code. For a `city` this is the metro code — `LON`, `NYC`, `PAR`.","example":"LHR"},"codes":{"type":"array","items":{"type":"string"},"description":"What to send as `origin` or `destination`. One code for an airport, its whole\nmetro area for a city, best first.","example":["LHR"]},"country_code":{"type":"string","description":"ISO 3166-1 alpha-2.","example":"GB"},"country_name":{"type":"string","example":"United Kingdom"},"icao_code":{"type":["string","null"],"example":"EGLL"},"kind":{"type":"string","description":"`airport`, or `city` for a metro code standing for several airports at once.","example":"airport"},"label":{"type":"string","description":"Ready to render in a dropdown.","example":"Heathrow Airport (LHR), London, United Kingdom"},"latitude":{"type":["number","null"],"format":"double","example":51.4706},"longitude":{"type":["number","null"],"format":"double","example":-0.461941},"name":{"type":"string","description":"The airport's name in the requested language, falling back to its own name rather\nthan to the city's, so an airport is never labelled with the name of its city.","example":"Heathrow Airport"},"timezone":{"type":["string","null"],"description":"IANA time zone.","example":"Europe/London"},"via":{"$ref":"#/components/schemas/ViaPlace","description":"Set when the term matched a place rather than the airport: the traveller typed\n`Ischgl` and this is Innsbruck, 85 km away. Absent for a direct match."}}},"ApiError":{"type":"object","description":"Error payload returned with every non-2xx response of the public API.","required":["error"],"properties":{"error":{"type":"string","description":"Human readable reason the request was rejected or could not be served.","example":"check_in must be before check_out"}},"example":{"error":"check_in must be before check_out"}},"AppliedLoyalty":{"type":"object","description":"A membership as it was attached to one booking, kept on the passenger, guest or driver so the booking shows what\nwas sent even after the traveller edits their memberships.","required":["membership_id","kind","program_code","program_name","supplier_code","number"],"properties":{"kind":{"$ref":"#/components/schemas/LoyaltyKind"},"membership_id":{"type":"string","format":"uuid"},"number":{"type":"string","example":"AB123456"},"program_code":{"type":"string","example":"united_mileageplus"},"program_name":{"type":"string","example":"United MileagePlus"},"receiver_code":{"type":["string","null"],"description":"Air only: the airline the number is sent to, which for an alliance partner is not the issuer.","example":"LH"},"supplier_code":{"type":"string","description":"Air: the airline that issued the number. Hotel and car: the chain or vendor the booking is with.","example":"UA"}}},"AssignFlightSeatsRequest":{"type":"object","required":["seats"],"properties":{"seats":{"type":"array","items":{"$ref":"#/components/schemas/SeatRequest"}}}},"AssignTravelersRequest":{"type":"object","required":["companion_ids"],"properties":{"companion_ids":{"type":"array","items":{"type":"string","format":"uuid"}},"lead_companion_id":{"type":["string","null"],"format":"uuid"}}},"BagType":{"type":"string","enum":["carry_on","checked"]},"Baggage":{"type":"object","description":"Baggage of one kind included per traveller.","required":["bag_type","quantity"],"properties":{"bag_type":{"$ref":"#/components/schemas/BagType"},"quantity":{"type":"integer","format":"int64"}}},"BookingEntry":{"allOf":[{"$ref":"#/components/schemas/CartItemEnriched"},{"type":"object","required":["booked_at"],"properties":{"booked_at":{"type":"string","format":"date-time"},"confirmation":{"type":["string","null"],"description":"Airline record locator, hotel confirmation code, or the provider's own booking id -\nwhichever this provider issues. Absent while the provider is still settling it."}}}],"description":"One settled reservation: the item exactly as the cart publishes it, plus what only a booking\nhas - the reference the traveller quotes at the desk, and when it was made."},"BookingsResponse":{"type":"object","required":["bookings","quote_bookings"],"properties":{"bookings":{"type":"array","items":{"$ref":"#/components/schemas/BookingEntry"},"description":"Newest first."},"quote_bookings":{"type":"array","items":{"$ref":"#/components/schemas/QuoteBookingEntry"},"description":"Group and custom requests booked by an agent, newest first. Their own shape: no cart ever held them."}}},"CabinClass":{"type":"string","description":"Cabin a fare is sold in.","enum":["economy","premium_economy","business","first"]},"CancelProcessingRequest":{"type":"object","properties":{"run_id":{"type":["string","null"],"format":"uuid"}}},"CancelQuoteRequest":{"type":"object","properties":{"reason":{"type":"string","description":"Passed on to the agent."}}},"CancellationPenaltySchema":{"type":"object","description":"What cancelling costs under one rule.","required":["type"],"properties":{"currency":{"type":["string","null"],"description":"Currency code (only when type = \"amount\")"},"type":{"type":"string","description":"One of: \"free\", \"full\", \"amount\""},"value":{"type":["string","null"],"description":"Penalty amount (only when type = \"amount\")"}},"example":{"type":"free"}},"CancellationPolicy":{"type":"object","description":"When an offer can still be cancelled, and at what cost.","required":["timezone","rules"],"properties":{"rules":{"type":"array","items":{"$ref":"#/components/schemas/CancellationRule"},"description":"Rules ordered by `from`; the one in force is the last whose `from` has passed."},"timezone":{"type":"string","description":"IANA timezone every rule boundary is expressed in.","example":"America/New_York"}}},"CancellationQuote":{"type":"object","description":"What cancelling costs, in one shape for every kind of booking.","required":["refundability","cancellable","lines"],"properties":{"cancellable":{"type":"boolean","description":"Whether this booking can be cancelled here at all."},"currency":{"type":["string","null"]},"free_until":{"type":["string","null"],"format":"date-time","description":"Cancel before this and nothing is charged."},"lines":{"type":"array","items":{"type":"string"},"description":"The policy in the traveller's own words, one line per rule."},"note":{"type":["string","null"],"description":"Why it cannot be cancelled, when it cannot."},"penalty_amount":{"type":["string","null"]},"refund_amount":{"type":["string","null"]},"refundability":{"type":"string","description":"`full`, `partial`, `none`, or `unknown` when the provider would not say."}}},"CancellationRule":{"type":"object","description":"What cancelling costs from a point in time onwards.","required":["penalty"],"properties":{"from":{"type":["string","null"],"format":"date-time","description":"RFC 3339 instant this rule takes effect. `null` means it applies from the moment of booking."},"penalty":{"$ref":"#/components/schemas/CancellationPenaltySchema","description":"Charge incurred while this rule is in force."}}},"CancelledResponse":{"type":"object","required":["status"],"properties":{"status":{"type":"string","example":"cancelled"}}},"CarBodyType":{"type":"string","enum":["TwoThreeDoor","TwoFourDoor","FourFiveDoor","Wagon","PassengerVan","Limousine","Sport","Convertible","Suv","OpenAirAllTerrain","Special","PickupRegularCab","PickupExtendedCab","SpecialOffer","Coupe","Monospace","RecreationalVehicle","MotorHome","TwoWheelVehicle","Roadster","Crossover","CommercialVan"]},"CarCartItem":{"type":"object","description":"A car rental in the cart.","required":["id","provider","vendor_code","vehicle_code","vehicle_name","pickup_location_id","dropoff_location_id","pickup_at","dropoff_at","rental_days","total_amount","currency","status","created_at","updated_at"],"properties":{"created_at":{"type":"string","format":"date-time"},"currency":{"type":"string","example":"USD"},"dropoff_at":{"type":"string","format":"date-time","description":"Local time at the dropoff branch."},"dropoff_location_id":{"type":"string"},"id":{"type":"string","format":"uuid","description":"Handle for this item - what removing it takes. Not the offer id."},"payment_policy":{"type":["string","null"],"description":"How the rental is paid for, once the rate has been re-priced.","enum":["guarantee","deposit",null]},"pickup_at":{"type":"string","format":"date-time","description":"Local time at the pickup branch."},"pickup_location_id":{"type":"string"},"provider":{"type":"string"},"rental_days":{"type":"integer","format":"int32"},"status":{"$ref":"#/components/schemas/ReservationStatus"},"total_amount":{"type":"string","example":"187.41"},"updated_at":{"type":"string","format":"date-time"},"vehicle_code":{"type":"string","description":"ACRISS code of the car class.","example":"ECAR"},"vehicle_name":{"type":"string","description":"Representative model, or the ACRISS code when the vendor names none.","example":"Kia Rio or similar"},"vendor_code":{"type":"string","example":"ZI"},"vendor_name":{"type":["string","null"],"example":"Avis"}}},"CarCartItemEnriched":{"type":"object","description":"Enriched car cart item with the offer's vendor, vehicle and branches.","required":["id","provider","vendor","vehicle_code","vehicle_name","pickup_at","dropoff_at","rental_days","total_amount","currency","status","travelers","created_at","updated_at","young_driver"],"properties":{"base_amount":{"type":["string","null"],"description":"Rental cost before the mandatory taxes and fees."},"created_at":{"type":"string","format":"date-time"},"currency":{"type":"string"},"drop_off_charge":{"type":["string","null"],"description":"One-way fee, when the vendor quotes it separately."},"dropoff_at":{"type":"string","format":"date-time"},"dropoff_location":{"$ref":"#/components/schemas/CarLocation"},"id":{"type":"string","format":"uuid"},"mileage":{"oneOf":[{"type":"string","enum":["Unlimited"]},{"type":"object","required":["Limited"],"properties":{"Limited":{"type":"object","required":["allowance","unit"],"properties":{"allowance":{"type":"integer","format":"int32","minimum":0},"extra_charge":{"type":["string","null"]},"unit":{"$ref":"#/components/schemas/DistanceUnit"}}}}}]},"payment_method":{"type":["string","null"],"description":"How the traveller pays for it. Absent when nothing can book it.","enum":["card","stripe","provider_sdk","hosted",null]},"payment_policy":{"type":["string","null"],"description":"How the rental is paid for, once the rate has been re-priced.","enum":["guarantee","deposit",null]},"pickup_at":{"type":"string","format":"date-time"},"pickup_location":{"$ref":"#/components/schemas/CarLocation"},"provider":{"type":"string"},"rental_days":{"type":"integer","format":"int32"},"status":{"$ref":"#/components/schemas/ReservationStatus"},"tax_amount":{"type":["string","null"],"description":"Mandatory taxes and fees already inside `total_amount`."},"total_amount":{"type":"string"},"travelers":{"type":"array","items":{"$ref":"#/components/schemas/CartTraveler"},"description":"The driver, as a single-entry list so every item type reads the same."},"travelers_required":{"type":["integer","null"],"minimum":0},"updated_at":{"type":"string","format":"date-time"},"vehicle":{"$ref":"#/components/schemas/CarVehicle"},"vehicle_code":{"type":"string"},"vehicle_name":{"type":"string"},"vendor":{"$ref":"#/components/schemas/CarVendor"},"young_driver":{"type":"boolean","description":"The driver is younger than 25 at pickup, so the rental company may refuse the rental or\ncharge a young-driver fee."}}},"CarCategory":{"type":"string","enum":["Mini","MiniElite","Economy","EconomyElite","Compact","CompactElite","Intermediate","IntermediateElite","Standard","StandardElite","Fullsize","FullsizeElite","Premium","PremiumElite","Luxury","LuxuryElite","Oversize","Special"]},"CarDifference":{"type":"string","description":"One way a car offer departs from the one it is compared with.","enum":["vendor","pickup_location","dropoff_location","category","body_type","transmission","drive","fuel","air_conditioning","capacity","mileage"]},"CarDropoffLocationSearchRequest":{"type":"object","required":["pickup_location_ids","search"],"properties":{"pickup_location_ids":{"type":"array","items":{"type":"string"},"description":"Locations already chosen for pickup; dropoff branches are limited to the same vendors."},"search":{"$ref":"#/components/schemas/CarLocationSearchRequest"}}},"CarLocation":{"type":"object","description":"A single rental branch of one vendor.","required":["id","provider","vendor","name","address","airport"],"properties":{"address":{"$ref":"#/components/schemas/Address"},"airport":{"type":"boolean"},"distance_km":{"type":["number","null"],"format":"double","description":"Distance from the search point; only set for location search results."},"geo":{"$ref":"#/components/schemas/GeoLocation"},"id":{"type":"string","description":"Opaque identifier; pass it back into car searches.","example":"ZIPHXPHX"},"name":{"type":"string","example":"Phoenix Sky Harbor Intl Airport"},"provider":{"type":"string"},"vendor":{"$ref":"#/components/schemas/CarVendor"}}},"CarLocationSearchRequest":{"type":"object","required":["latitude","longitude"],"properties":{"latitude":{"type":"number","format":"double","example":33.4352},"longitude":{"type":"number","format":"double","example":-112.0101},"max_results":{"type":["integer","null"],"format":"int32","minimum":0},"radius_km":{"type":["number","null"],"format":"double"}}},"CarLocationSearchResult":{"type":"object","required":["locations"],"properties":{"locations":{"type":"array","items":{"$ref":"#/components/schemas/CarLocation"},"description":"Nearest first. Empty when no branch is within the radius."}}},"CarMatchLevel":{"type":"string","description":"How close a car offer comes to the one it is compared with. Ordered weakest first.","enum":["similar","same_branch","same_car","identical"]},"CarNearbySearchRequest":{"type":"object","description":"A rental shopped at the branches around the places the traveller named.","required":["pickup","pickup_at","dropoff_at"],"properties":{"currency":{"type":["string","null"],"description":"The currency prices are wanted in. Offers keep the currency the rental company charges\nwhenever it is another one.","example":"USD"},"dropoff":{"$ref":"#/components/schemas/CarSearchPlace","description":"Omitted, the car is returned where it was picked up."},"dropoff_at":{"type":"string","format":"date-time","description":"Local time at the dropoff location."},"pickup":{"$ref":"#/components/schemas/CarSearchPlace"},"pickup_at":{"type":"string","format":"date-time","description":"Local time at the pickup location."}}},"CarNearbySearchResult":{"type":"object","required":["offers"],"properties":{"empty_reason":{"type":["string","null"],"enum":["no_pickup_branches","no_dropoff_branches","no_availability",null]},"offers":{"type":"array","items":{"$ref":"#/components/schemas/CarOffer"},"description":"Cheapest first. Empty when nothing is available, and then `empty_reason` says why."}}},"CarOffer":{"type":"object","required":["offer_id","provider","vendor","vehicle","pickup_location","dropoff_location","pickup_at","dropoff_at","rental_days","pricing"],"properties":{"dropoff_at":{"type":"string","format":"date-time"},"dropoff_location":{"$ref":"#/components/schemas/CarLocation"},"ext":{"type":["object","null"],"description":"Opaque; do not parse."},"mileage":{"oneOf":[{"type":"string","enum":["Unlimited"]},{"type":"object","required":["Limited"],"properties":{"Limited":{"type":"object","required":["allowance","unit"],"properties":{"allowance":{"type":"integer","format":"int32","minimum":0},"extra_charge":{"type":["string","null"]},"unit":{"$ref":"#/components/schemas/DistanceUnit"}}}}}]},"offer_id":{"type":"string","format":"uuid"},"pickup_at":{"type":"string","format":"date-time"},"pickup_location":{"$ref":"#/components/schemas/CarLocation"},"pricing":{"$ref":"#/components/schemas/CarPricing"},"provider":{"type":"string"},"rate_code":{"type":["string","null"]},"rental_days":{"type":"integer","format":"int32","minimum":0},"similarity":{"$ref":"#/components/schemas/CarOfferSimilarity","description":"How close this offer comes to a reservation. Only set when shopping for offers similar to one."},"vehicle":{"$ref":"#/components/schemas/CarVehicle"},"vendor":{"$ref":"#/components/schemas/CarVendor"}}},"CarOfferSimilarity":{"type":"object","description":"How a car offer compares with a reference offer, typically the one a reservation was booked on.","required":["score","match_level","same_reservation","same_vendor","differences"],"properties":{"category_difference":{"type":["integer","null"],"format":"int32","description":"Size classes up from the booked car, negative when smaller. `null` when either class is\nunknown or off the size ladder (oversize, special).","example":1},"differences":{"type":"array","items":{"$ref":"#/components/schemas/CarDifference"},"description":"Empty when identical."},"match_level":{"$ref":"#/components/schemas/CarMatchLevel"},"pickup_distance_meters":{"type":["integer","null"],"format":"int32","description":"Straight-line distance from the booked pickup branch. `null` when a branch has no coordinates.","example":850,"minimum":0},"price_difference":{"type":["string","null"],"description":"`pricing.total` minus the reference's, positive when dearer. `null` when priced in another currency.","example":"25.00"},"same_reservation":{"type":"boolean","description":"The very car that was booked: same vendor, branches, car class and mileage terms. The\nprice may still differ."},"same_vendor":{"type":"boolean"},"score":{"type":"integer","format":"int32","description":"0 to 100, higher is closer.","example":84,"minimum":0}}},"CarPaymentPolicy":{"type":"string","description":"How the rental is paid for. A guaranteed rental is paid at the counter; the card only holds it.","enum":["guarantee","deposit"]},"CarPricing":{"type":"object","required":["total","per_day","currency"],"properties":{"base_rate":{"type":["string","null"],"description":"Rental cost before the mandatory taxes and fees.","example":"504.65"},"currency":{"type":"string","description":"The currency the rental company charges in, whatever currency the search asked for.","example":"USD"},"drop_off_charge":{"type":["string","null"]},"per_day":{"type":"string"},"taxes":{"type":["string","null"],"description":"Mandatory taxes and fees already inside `total`. `None` when the vendor quoted none.","example":"168.22"},"total":{"type":"string","description":"Approximate total for the whole rental, as quoted by the vendor.","example":"672.87"}}},"CarSearchAction":{"type":"object","description":"The rental the assistant shopped for.","required":["pickup","pickup_at","dropoff_at"],"properties":{"dropoff":{"$ref":"#/components/schemas/CarSearchPlace","description":"Absent when the car goes back where it was picked up."},"dropoff_at":{"type":"string","format":"date-time","example":"2026-11-08T10:00:00"},"pickup":{"$ref":"#/components/schemas/CarSearchPlace"},"pickup_at":{"type":"string","format":"date-time","description":"Branch-local.","example":"2026-11-05T10:00:00"}}},"CarSearchEmptyReason":{"type":"string","enum":["no_pickup_branches","no_dropoff_branches","no_availability"]},"CarSearchPlace":{"type":"object","description":"A place the traveller named, as the portal's car search form takes it.","required":["name","latitude","longitude"],"properties":{"latitude":{"type":"number","format":"double"},"longitude":{"type":"number","format":"double"},"name":{"type":"string","example":"Los Angeles International Airport"}}},"CarSearchRequest":{"type":"object","required":["pickup_location_ids","dropoff_location_ids","pickup_at","dropoff_at"],"properties":{"currency":{"type":["string","null"],"description":"The currency prices are wanted in. Offers keep the currency the rental company charges\nwhenever it is another one.","example":"USD"},"dropoff_at":{"type":"string","format":"date-time","description":"Local time at the dropoff location."},"dropoff_location_ids":{"type":"array","items":{"type":"string"},"description":"Empty means the car is returned where it was picked up."},"pickup_at":{"type":"string","format":"date-time","description":"Local time at the pickup location."},"pickup_location_ids":{"type":"array","items":{"type":"string"}}}},"CarSearchResult":{"type":"object","required":["offers"],"properties":{"offers":{"type":"array","items":{"$ref":"#/components/schemas/CarOffer"},"description":"Cheapest first - except when shopping for offers similar to a reservation, where they come\nclosest first. Empty when nothing is available."}}},"CarVehicle":{"type":"object","required":["classification"],"properties":{"bags_large":{"type":["integer","null"],"format":"int32","minimum":0},"bags_small":{"type":["integer","null"],"format":"int32","minimum":0},"classification":{"$ref":"#/components/schemas/VehicleClassification"},"doors":{"type":["string","null"],"example":"2-4"},"image_url":{"type":["string","null"]},"make_model":{"type":["string","null"],"example":"Toyota Corolla or similar"},"seats":{"type":["integer","null"],"format":"int32","minimum":0}}},"CarVendor":{"type":"object","required":["code"],"properties":{"code":{"type":"string","example":"ZI"},"logo_url":{"type":["string","null"]},"name":{"type":["string","null"],"example":"Avis"}}},"CardAuthenticationSession":{"type":"object","required":["item_id","session_id"],"properties":{"item_id":{"type":"string","format":"uuid"},"session_id":{"type":"string"}}},"CartHelpReply":{"type":"object","required":["body"],"properties":{"body":{"type":"string","description":"Up to 4000 characters."}}},"CartItemEnriched":{"oneOf":[{"allOf":[{"$ref":"#/components/schemas/HotelCartItemEnriched"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["hotel"]}}}],"title":"hotel"},{"allOf":[{"$ref":"#/components/schemas/FlightCartItemEnriched"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["flight"]}}}],"title":"flight"},{"allOf":[{"$ref":"#/components/schemas/EventCartItemEnriched"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["event"]}}}],"title":"event"},{"allOf":[{"$ref":"#/components/schemas/CarCartItemEnriched"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["car"]}}}],"title":"car"}],"description":"Enriched cart item - wraps every item type with a type discriminator.","discriminator":{"propertyName":"type","mapping":{"car":"#/components/schemas/CarCartItemEnriched","event":"#/components/schemas/EventCartItemEnriched","flight":"#/components/schemas/FlightCartItemEnriched","hotel":"#/components/schemas/HotelCartItemEnriched"}}},"CartItemType":{"type":"string","enum":["hotel","event","flight","car"]},"CartProcessingItem":{"allOf":[{"$ref":"#/components/schemas/ItemState"},{"type":"object","required":["item_id","item_type","name"],"properties":{"item_id":{"type":"string","format":"uuid"},"item_type":{"$ref":"#/components/schemas/CartItemType"},"name":{"type":"string"}}}]},"CartProcessingSnapshot":{"type":"object","description":"What `GET /api/v1/carts/{cart_id}/processing` answers with.","required":["cart_id","run_id","status","cart_status","items","started_at","updated_at"],"properties":{"blocked_by":{"oneOf":[{"type":"object","description":"The provider repriced the item. Resume with `confirmed_price` set to `new` to accept it.","required":["old","new","currency","type"],"properties":{"currency":{"type":"string"},"new":{"type":"string"},"old":{"type":"string"},"old_currency":{"type":["string","null"],"description":"Set when `old` was quoted in another currency than `currency`."},"type":{"type":"string","enum":["price_confirmation"]}}},{"type":"object","description":"Passenger or guest details are missing. Fill them in through the booking's own endpoint,\nthen resume.","required":["missing","type"],"properties":{"missing":{"type":"array","items":{"type":"string"}},"type":{"type":"string","enum":["traveller_details"]}}},{"type":"object","description":"The provider takes payment on its own page. Open this, pay, then poll again.","required":["payment_url","type"],"properties":{"payment_url":{"type":"string"},"type":{"type":"string","enum":["hosted_payment"]}}},{"type":"object","description":"The item is charged from a card and the run holds none for it, or the bank refused the\none it had. Resume with a card for it.","required":["type"],"properties":{"type":{"type":"string","enum":["payment_method"]}}},{"type":"object","description":"The cardholder has to confirm these charges with their bank before anything is booked.\nRun each session with `provider`'s browser SDK, then resume with the same cards.","required":["provider","sessions","type"],"properties":{"provider":{"type":"string"},"sessions":{"type":"array","items":{"$ref":"#/components/schemas/CardAuthenticationSession"}},"type":{"type":"string","enum":["card_authentication"]}}}],"description":"What the run needs before it can go on. The only place a payment URL is ever handed out."},"blocked_on":{"type":["string","null"],"format":"uuid"},"cart_id":{"type":"string","format":"uuid"},"cart_status":{"$ref":"#/components/schemas/CartStatus"},"items":{"type":"array","items":{"$ref":"#/components/schemas/CartProcessingItem"}},"run_id":{"type":"string","format":"uuid"},"started_at":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/CartProcessingStatus"},"updated_at":{"type":"string","format":"date-time"}}},"CartProcessingStatus":{"type":"string","description":"Where a cart's processing run stands.","enum":["running","paused","completed","cancelled"]},"CartResponseEnriched":{"type":"object","description":"Enriched cart response with display-friendly item details.","required":["id","status","is_current","items","total","unavailable_item_ids","updated_at"],"properties":{"id":{"type":"string","format":"uuid"},"is_current":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/CartItemEnriched"},"description":"Held items, oldest first. Empty when nothing is in the cart."},"status":{"$ref":"#/components/schemas/CartStatus"},"title":{"type":["string","null"]},"total":{"$ref":"#/components/schemas/CartTotal","description":"Counts and per-currency sums of `items`."},"unavailable_item_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Ids of items that cannot be checked out."},"updated_at":{"type":"string","format":"date-time","description":"When the traveller last renamed it, picked it as the current cart, or added or removed an item."}}},"CartStatus":{"type":"string","description":"Where a cart stands. Only `Open` accepts new offers.","enum":["open","checking_out","under_review","completed","abandoned"]},"CartSummary":{"type":"object","description":"One cart without its contents - what a listing shows.","required":["id","status","is_current","total","created_at","updated_at"],"properties":{"created_at":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"is_current":{"type":"boolean","description":"Whether this is the cart a selection lands in when none is named."},"status":{"$ref":"#/components/schemas/CartStatus"},"title":{"type":["string","null"],"description":"What the traveller called this cart, if they named it."},"total":{"$ref":"#/components/schemas/CartTotal","description":"Counts and per-currency sums of what it holds."},"updated_at":{"type":"string","format":"date-time"}}},"CartTotal":{"type":"object","description":"What the cart adds up to.","required":["item_count","hotel_count","event_count","flight_count","car_count","by_currency"],"properties":{"by_currency":{"type":"array","items":{"$ref":"#/components/schemas/CurrencyTotal"},"description":"One entry per currency the cart holds, ordered by code. There is deliberately no single\ngrand total: a cart can hold a hotel priced in EUR beside a flight priced in USD, and\nadding those up would mean picking an exchange rate and quoting a number nobody will\nactually be charged."},"car_count":{"type":"integer","minimum":0},"event_count":{"type":"integer","minimum":0},"flight_count":{"type":"integer","minimum":0},"hotel_count":{"type":"integer","minimum":0},"item_count":{"type":"integer","minimum":0}}},"CartTraveler":{"type":"object","description":"One traveller as the booking holds them — a snapshot of the saved profile, not a reference.","required":["companion_id","first_name","last_name","dob","role","is_complete","missing_fields"],"properties":{"companion_id":{"type":"string","format":"uuid"},"dob":{"type":"string","format":"date"},"document":{"$ref":"#/components/schemas/PassengerDocument"},"eligible_loyalty":{"type":"array","items":{"$ref":"#/components/schemas/LoyaltyOption"},"description":"The traveller's memberships this booking could carry instead; only listed for one item's travellers."},"email":{"type":["string","null"]},"first_name":{"type":"string"},"gender":{"type":["string","null"],"enum":["male","female",null]},"is_complete":{"type":"boolean"},"last_name":{"type":"string"},"loyalty":{"type":"array","items":{"$ref":"#/components/schemas/AppliedLoyalty"},"description":"Loyalty memberships attached to this booking."},"middle_name":{"type":["string","null"]},"missing_fields":{"type":"array","items":{"type":"string"}},"nationality":{"type":["string","null"]},"phone":{"type":["string","null"]},"role":{"$ref":"#/components/schemas/TravelerRole"}}},"CartTravelersResponse":{"type":"object","required":["travelers","assigned_count"],"properties":{"assigned_count":{"type":"integer","minimum":0},"document_required":{"type":["boolean","null"],"description":"Flights only: whether a passport has to be on file before this item can be booked."},"required_count":{"type":["integer","null"],"minimum":0},"route_type":{"type":["string","null"],"description":"Flights only, so the UI can say why a passport is asked for.","enum":["domestic","international",null]},"travelers":{"type":"array","items":{"$ref":"#/components/schemas/CartTraveler"}}}},"ChatHistoryResponse":{"type":"object","description":"The conversation, plus whether an answer is still on its way.","required":["messages","replying"],"properties":{"action":{"oneOf":[{"allOf":[{"$ref":"#/components/schemas/HotelSearchAction"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["hotel_search"]}}}],"title":"hotel_search"},{"allOf":[{"$ref":"#/components/schemas/FlightSearchAction"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["flight_search"]}}}],"title":"flight_search"},{"allOf":[{"$ref":"#/components/schemas/CarSearchAction"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["car_search"]}}}],"title":"car_search"},{"allOf":[{"$ref":"#/components/schemas/EventSearchAction"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["event_search"]}}}],"title":"event_search"}],"description":"Present once, on the first read after the assistant searched something: what the client\nshould open. Read it and it is gone, so a reload does not navigate again.","discriminator":{"propertyName":"type","mapping":{"car_search":"#/components/schemas/CarSearchAction","event_search":"#/components/schemas/EventSearchAction","flight_search":"#/components/schemas/FlightSearchAction","hotel_search":"#/components/schemas/HotelSearchAction"}}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/ChatMessageResponse"},"description":"Oldest first."},"replying":{"type":"boolean","description":"True while the assistant is working on a message, which is what a client shows a typing\nindicator on."}}},"ChatMessageResponse":{"type":"object","description":"One turn of the conversation.","required":["ts","role","text"],"properties":{"role":{"type":"string","description":"`user` for the traveller, `agent` for us.","example":"agent"},"text":{"type":"string"},"ts":{"type":"integer","format":"int64","description":"When the message was stored, in Unix epoch seconds.","example":1757419200}}},"CompanionResponse":{"type":"object","description":"A saved traveller companion. The owner is the authenticated traveller, so it is not repeated\nin the payload.","required":["id","first_name","last_name","dob","is_self","created_at","updated_at"],"properties":{"created_at":{"type":"string","format":"date-time","example":"2026-11-05T10:00:00Z"},"dob":{"type":"string","format":"date"},"document":{"$ref":"#/components/schemas/PassengerDocument","description":"The travel document, needed before this companion can fly."},"email":{"type":["string","null"]},"first_name":{"type":"string"},"gender":{"type":["string","null"],"enum":["male","female",null]},"id":{"type":"string","format":"uuid"},"is_self":{"type":"boolean","description":"The account holder themselves."},"last_name":{"type":"string"},"loyalty":{"type":"array","items":{"$ref":"#/components/schemas/LoyaltyMembershipResponse"},"description":"Frequent flyer, hotel and car rental memberships; only filled in when listing companions."},"middle_name":{"type":["string","null"]},"nationality":{"type":["string","null"],"description":"ISO 3166-1 alpha-2 country of citizenship."},"phone":{"type":["string","null"]},"updated_at":{"type":"string","format":"date-time","example":"2026-11-05T10:00:00Z"}}},"Conditions":{"type":"object","description":"Perks the fare includes on this leg. `null` means the airline said nothing.","properties":{"advance_seat_selection":{"type":["boolean","null"]},"priority_boarding":{"type":["boolean","null"]},"priority_check_in":{"type":["boolean","null"]}}},"CoverNeeds":{"type":"object","properties":{"annual":{"type":"boolean","description":"A year of trips rather than this one."},"cancellation":{"type":"boolean"},"extreme_sports":{"type":"boolean"}}},"Coverage":{"type":"object","required":["key","limit"],"properties":{"deductible":{"type":["string","null"]},"group":{"type":["string","null"],"example":"Medical"},"key":{"type":"string","description":"The provider's id for the benefit.","example":"medical_expenses"},"label":{"type":["string","null"],"example":"Medical expenses"},"limit":{"$ref":"#/components/schemas/CoverageLimit"}}},"CoverageLimit":{"oneOf":[{"type":"object","description":"Covered up to `value`.","required":["value","type"],"properties":{"currency":{"type":["string","null"]},"type":{"type":"string","enum":["amount"]},"value":{"type":"string"}}},{"type":"object","description":"Covered up to `value` a day.","required":["value","type"],"properties":{"currency":{"type":["string","null"]},"type":{"type":"string","enum":["per_day"]},"value":{"type":"string"}}},{"type":"object","description":"Covered, no ceiling stated.","required":["type"],"properties":{"type":{"type":"string","enum":["included"]}}},{"type":"object","description":"Covered at the actual cost.","required":["type"],"properties":{"type":{"type":"string","enum":["actual_costs"]}}},{"type":"object","description":"Covered up to what the trip cost.","required":["type"],"properties":{"type":{"type":"string","enum":["up_to_trip_cost"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["not_covered"]}}},{"type":"object","description":"Covered on terms the documents spell out.","required":["type"],"properties":{"type":{"type":"string","enum":["other"]}}}]},"CoveredBooking":{"type":"object","required":["booking_type","booking_id"],"properties":{"booking_id":{"type":"string","format":"uuid"},"booking_type":{"type":"string","description":"`hotel`, `flight`, `car` or `event`."}}},"CreateCartRequest":{"type":"object","properties":{"title":{"type":["string","null"],"description":"What to call it, e.g. `Rome in May`. Optional - a cart works unnamed.","example":"Rome in May"}}},"CreateCompanionRequest":{"type":"object","required":["first_name","last_name","dob"],"properties":{"dob":{"type":"string","format":"date","example":"1990-12-10"},"document":{"$ref":"#/components/schemas/PassengerDocument"},"email":{"type":["string","null"],"example":"ada@example.com"},"first_name":{"type":"string","example":"Ada"},"gender":{"type":["string","null"],"enum":["male","female",null]},"is_self":{"type":"boolean","description":"Marks this traveller as the account holder; their memberships are used for searches. Setting it moves the mark\noff any other traveller."},"last_name":{"type":"string","example":"Lovelace"},"middle_name":{"type":["string","null"]},"nationality":{"type":["string","null"],"description":"ISO 3166-1 alpha-2 country of citizenship.","example":"GB"},"phone":{"type":["string","null"],"example":"+1 415 555 0134"}}},"CreateLoyaltyRequest":{"type":"object","required":["program_id","number"],"properties":{"number":{"type":"string","example":"AB123456"},"priority":{"type":"integer","format":"int32","description":"Lower wins when several of the traveller's memberships fit one booking. Defaults to `0`.","example":0},"program_id":{"type":"string","format":"uuid","description":"A program `id` from `GET /api/v1/loyalty-programs`.","example":"5d1f0c3e-8a2b-4c7d-9e10-2f3a4b5c6d7e"}}},"CreatedTravelerResponse":{"type":"object","required":["success","companion_id"],"properties":{"companion_id":{"type":"string","format":"uuid","description":"The id the other traveler endpoints address the new traveler by."},"success":{"type":"boolean","example":true}}},"CurrencyTotal":{"type":"object","description":"What the cart comes to in one currency.","required":["currency","amount"],"properties":{"amount":{"type":"string","description":"Sum of every item priced in `currency`.","example":"1284.00"},"currency":{"type":"string","description":"ISO 4217 code.","example":"USD"}}},"CustomLines":{"type":"object","required":["lines"],"properties":{"lines":{"type":"array","items":{"$ref":"#/components/schemas/PriceLine"}}}},"CustomerQuoteBooking":{"type":"object","required":["id","offer_id","status","total_amount","amount_due_now","currency","balance_amount","balance_open"],"properties":{"amount_due_now":{"type":"string"},"balance_amount":{"type":"string","description":"What is left after the deposit; zero when nothing is."},"balance_due_on":{"type":["string","null"],"format":"date"},"balance_open":{"type":"boolean","description":"The balance can be paid now."},"balance_paid_at":{"type":["string","null"],"format":"date-time"},"booked_at":{"type":["string","null"],"format":"date-time"},"currency":{"type":"string"},"failure_reason":{"type":["string","null"],"description":"Why the supplier couldn't take a paid booking."},"id":{"type":"string","format":"uuid"},"offer_id":{"type":"string","format":"uuid"},"paid_at":{"type":["string","null"],"format":"date-time"},"status":{"$ref":"#/components/schemas/ReservationStatus"},"supplier_confirmation":{"type":["string","null"],"description":"The supplier's reference, once the agent booked it."},"total_amount":{"type":"string"}}},"CustomerQuoteOffer":{"type":"object","required":["id","status","title","description","lines","summary","inclusions","exclusions","total_amount","currency","payment","amount_due_now","cancellation_terms","media","updated"],"properties":{"amount_due_now":{"type":"string","description":"What accepting it charges now: the deposit, the total, or nothing."},"balance_due_on":{"type":["string","null"],"format":"date","description":"When the rest is due, after a deposit."},"cancellation_terms":{"type":"string"},"currency":{"type":"string"},"deposit_amount":{"type":["string","null"]},"description":{"type":"string"},"exclusions":{"type":"array","items":{"type":"string"}},"id":{"type":"string","format":"uuid"},"inclusions":{"type":"array","items":{"type":"string"}},"lines":{"$ref":"#/components/schemas/QuoteOfferLines"},"media":{"type":"array","items":{"type":"string"}},"payment":{"$ref":"#/components/schemas/OfferPayment"},"published_at":{"type":["string","null"],"format":"date-time"},"status":{"$ref":"#/components/schemas/QuoteOfferStatus"},"summary":{"type":"string","description":"The lines in one sentence."},"supplier_name":{"type":["string","null"]},"title":{"type":"string"},"total_amount":{"type":"string"},"updated":{"type":"boolean","description":"Whether it is a new version of an offer published before, which it replaced."},"valid_until":{"type":["string","null"],"format":"date-time"}}},"CustomerQuoteRequest":{"type":"object","description":"A request as its customer sees it: no drafts, no internal notes, no supplier contacts.","required":["id","kind","status","title","requirements","details","created_at","updated_at","offers","timeline"],"properties":{"booking":{"$ref":"#/components/schemas/CustomerQuoteBooking","description":"The latest booking made from an accepted offer."},"budget_amount":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time"},"currency":{"type":["string","null"]},"details":{"$ref":"#/components/schemas/QuoteRequestDetails"},"end_date":{"type":["string","null"],"format":"date"},"id":{"type":"string","format":"uuid"},"insurance":{"$ref":"#/components/schemas/InsuranceExtras","description":"For an insurance request."},"kind":{"$ref":"#/components/schemas/QuoteKind"},"location_text":{"type":["string","null"]},"offers":{"type":"array","items":{"$ref":"#/components/schemas/CustomerQuoteOffer"}},"party_size":{"type":["integer","null"],"format":"int32"},"requirements":{"type":"string"},"start_date":{"type":["string","null"],"format":"date"},"status":{"$ref":"#/components/schemas/QuoteRequestStatus"},"timeline":{"type":"array","items":{"$ref":"#/components/schemas/QuoteTimelineEntry"},"description":"Oldest first."},"title":{"type":"string"},"updated_at":{"type":"string","format":"date-time"}}},"DayPlace":{"type":"object","required":["place_id","name","location","starts_at","ends_at"],"properties":{"address":{"type":["string","null"]},"category":{"type":["string","null"]},"description":{"type":["string","null"]},"ends_at":{"type":"string","example":"12:25:00"},"image_url":{"type":["string","null"]},"location":{"$ref":"#/components/schemas/GeoLocation"},"name":{"type":"string"},"opening_hours":{"type":["string","null"]},"phone":{"type":["string","null"]},"place_id":{"type":"string","description":"Pass it back in `exclude_place_ids` to leave the place out of a new plan."},"rating":{"type":["number","null"],"format":"double"},"starts_at":{"type":"string","example":"10:55:00"},"website":{"type":["string","null"]}}},"DayPlan":{"type":"object","required":["status","window","outdated","steps"],"properties":{"outdated":{"type":"boolean","description":"The day's window has changed since, so the plan no longer fits it."},"status":{"$ref":"#/components/schemas/DayPlanStatus"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/DayStep"}},"window":{"$ref":"#/components/schemas/DayWindow","description":"The window the plan was made for."}}},"DayPlanStatus":{"type":"string","enum":["generating","ready","failed"]},"DayStep":{"oneOf":[{"allOf":[{"$ref":"#/components/schemas/DayPlace"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["place"]}}}],"title":"place"},{"allOf":[{"$ref":"#/components/schemas/Transfer"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["transfer"]}}}],"title":"transfer"}],"discriminator":{"propertyName":"type","mapping":{"place":"#/components/schemas/DayPlace","transfer":"#/components/schemas/Transfer"}}},"DayWindow":{"type":"object","required":["starts_at","ends_at"],"properties":{"ends_at":{"type":"string","example":"19:00:00"},"starts_at":{"type":"string","example":"09:30:00"}}},"DeliveryMethod":{"type":"object","required":["code","name","address_required"],"properties":{"address_required":{"type":"boolean"},"code":{"type":"string"},"name":{"type":"string"}}},"Difference":{"type":"string","description":"One way a leg departs from the one it is compared with.","enum":["flights","schedule","connections","connection_airports","carrier","cabin","fare_brand","fare_basis","baggage"]},"DistanceUnit":{"type":"string","enum":["Km","Mi"]},"DocumentType":{"type":"string","enum":["passport","id_card"]},"DriveType":{"type":"string","enum":["Unspecified","FourWheel","AllWheel"]},"Event":{"type":"object","required":["event_id","name","description","event_start","location","address","category","images","tz","pricing","provider","quantity"],"properties":{"address":{"$ref":"#/components/schemas/Address"},"category":{"type":"string"},"description":{"type":"string"},"event_id":{"type":"string","format":"uuid"},"event_start":{"type":"string","format":"date-time"},"images":{"type":"array","items":{"type":"string"}},"images_source":{"type":["string","null"],"description":"Where `images` and `video_ids` come from.","enum":["Unknown","Ticketmaster","YouTube",null]},"location":{"$ref":"#/components/schemas/GeoLocation"},"name":{"type":"string"},"pricing":{"$ref":"#/components/schemas/PricingDetails","description":"pricing for 1 ticket includes fees, taxes not included"},"provider":{"$ref":"#/components/schemas/EventProvider"},"quantity":{"type":"integer","format":"int32"},"tz":{"type":"string"},"url":{"type":["string","null"]},"venue":{"type":["string","null"]},"video_ids":{"type":"array","items":{"type":"string"},"description":"YouTube video IDs for iframe embed (only for YouTube source)"}}},"EventCartItem":{"type":"object","description":"Held tickets to an event.","required":["id","event_name","provider","event_start","tz","quantity","ticket_price","total_amount","currency","status","created_at","updated_at"],"properties":{"created_at":{"type":"string","format":"date-time"},"currency":{"type":"string"},"event_name":{"type":"string"},"event_start":{"type":"string","format":"date-time","description":"Local start time at the venue, without an offset — read it with `tz`."},"id":{"type":"string","format":"uuid","description":"Handle for this item — what removing it or checking it out takes. Not the offer id."},"provider":{"type":"string"},"quantity":{"type":"integer","format":"int32"},"status":{"$ref":"#/components/schemas/ReservationStatus"},"ticket_price":{"type":"string"},"total_amount":{"type":"string"},"tz":{"type":"string","description":"IANA zone `event_start` is expressed in, e.g. `America/New_York`."},"updated_at":{"type":"string","format":"date-time"}}},"EventCartItemEnriched":{"type":"object","description":"Enriched event cart item with display-friendly fields.","required":["id","event_name","provider","event_start","tz","quantity","ticket_price","total_amount","currency","status","travelers","created_at","updated_at"],"properties":{"created_at":{"type":"string","format":"date-time"},"currency":{"type":"string"},"event_end":{"type":["string","null"],"format":"date-time","description":"Event end time if available."},"event_images":{"type":["array","null"],"items":{"type":"string"},"description":"Event images for display."},"event_name":{"type":"string"},"event_start":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"payment_method":{"type":["string","null"],"description":"How the traveller pays for it. Absent when nothing can book it.","enum":["card","stripe","provider_sdk","hosted",null]},"provider":{"type":"string"},"quantity":{"type":"integer","format":"int32"},"status":{"$ref":"#/components/schemas/ReservationStatus"},"ticket_price":{"type":"string"},"total_amount":{"type":"string"},"travelers":{"type":"array","items":{"$ref":"#/components/schemas/CartTraveler"},"description":"The ticket recipient, as a single-entry list so every item type reads the same."},"travelers_required":{"type":["integer","null"],"minimum":0},"tz":{"type":"string","description":"IANA timezone."},"updated_at":{"type":"string","format":"date-time"},"venue_address":{"type":["string","null"],"description":"Venue address for display."},"venue_name":{"type":["string","null"],"description":"Venue name for display."}}},"EventDelivery":{"type":"object","description":"How the tickets of an event booking are handed over.","required":["available"],"properties":{"address":{"$ref":"#/components/schemas/Address","description":"Where shipped tickets go. Only kept while the chosen method has `address_required`."},"available":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryMethod"},"description":"Every method the seller offers for these tickets."},"delivery_method_code":{"type":["string","null"],"description":"`code` of the chosen entry in `available`. `null` when the seller offers no method.","example":"1"}}},"EventDeliveryUpdate":{"type":"object","required":["delivery_method_code"],"properties":{"address":{"$ref":"#/components/schemas/Address","description":"Required when the method has `address_required`, ignored otherwise."},"delivery_method_code":{"type":"string","description":"`code` of one of the booking's `available` methods.","example":"2"}}},"EventDetails":{"type":"object","required":["event","offers"],"properties":{"event":{"$ref":"#/components/schemas/Event"},"offers":{"type":"array","items":{"$ref":"#/components/schemas/EventOffer"}}}},"EventDifference":{"type":"string","description":"One way an event offer departs from the one it is compared with.","enum":["level","section","row","seats","ticket_type","delivery"]},"EventEnrichmentSource":{"type":"string","description":"Source of enrichment data","enum":["Unknown","Ticketmaster","YouTube"]},"EventMatchLevel":{"type":"string","description":"How close an event offer comes to the one it is compared with. Ordered weakest first.","enum":["similar","same_level","same_section","same_row","identical"]},"EventOffer":{"type":"object","required":["offer_id","event","price","provider","quantity","delivery_methods"],"properties":{"available":{"type":["integer","null"],"format":"int32"},"delivery_methods":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryMethod"}},"event":{"$ref":"#/components/schemas/Event"},"fees":{"$ref":"#/components/schemas/Price","description":"service fee for one ticket"},"offer_id":{"type":"string","format":"uuid"},"offer_type":{"type":["string","null"]},"on_hand_date":{"type":["string","null"],"format":"date"},"price":{"$ref":"#/components/schemas/Price","description":"price for one ticket, fees and taxes are not included"},"provider":{"$ref":"#/components/schemas/EventProvider"},"quantity":{"type":"integer","format":"int32"},"seats":{"$ref":"#/components/schemas/Seats"},"similarity":{"$ref":"#/components/schemas/EventOfferSimilarity","description":"How close this offer comes to a reservation. Only set when shopping for offers similar to one."}}},"EventOfferSimilarity":{"type":"object","description":"How an event offer compares with a reference offer, typically the one a reservation was booked on.","required":["score","match_level","same_reservation","same_section","differences"],"properties":{"differences":{"type":"array","items":{"$ref":"#/components/schemas/EventDifference"},"description":"Empty when identical."},"match_level":{"$ref":"#/components/schemas/EventMatchLevel"},"price_difference":{"type":["string","null"],"description":"Ticket price and fees for the whole party minus the booked offer's, positive when dearer.\n`null` when priced in another currency.","example":"40.00"},"row_difference":{"type":["integer","null"],"format":"int32","description":"Rows back from the booked one, negative when closer to the front. `null` when either row\nis unknown or the rows cannot be compared.","example":2},"same_reservation":{"type":"boolean","description":"The very listing that was booked, possibly relisted by the seller. The price may still differ."},"same_section":{"type":"boolean"},"score":{"type":"integer","format":"int32","description":"0 to 100, higher is closer.","example":85,"minimum":0}}},"EventProvider":{"type":"string","enum":["ticket_network"]},"EventSearchAction":{"type":"object","description":"The events the assistant shopped for.","required":["date_from","date_to","quantity"],"properties":{"category":{"type":["string","null"],"enum":["concerts","sports","theatre",null]},"city":{"type":["string","null"],"example":"Las Vegas"},"date_from":{"type":"string","format":"date","description":"Venue-local, inclusive.","example":"2026-11-01"},"date_to":{"type":"string","format":"date","example":"2026-11-30"},"keyword":{"type":["string","null"],"example":"Coldplay"},"quantity":{"type":"integer","format":"int32","minimum":0}}},"EventSearchCategory":{"type":"string","enum":["concerts","sports","theatre"]},"EventSearchQuery":{"type":"object","description":"An event search as the public API takes it.","required":["date_from","date_to"],"properties":{"category":{"type":["string","null"],"enum":["concerts","sports","theatre",null]},"city":{"type":["string","null"],"example":"Las Vegas"},"date_from":{"type":"string","format":"date","description":"First day to look at, local to the venue."},"date_to":{"type":"string","format":"date","description":"Last day to look at, local to the venue, inclusive."},"keyword":{"type":["string","null"],"description":"Artist, team or event name. Omitted, every event matching the other filters is returned.","example":"Coldplay"},"quantity":{"type":["integer","null"],"format":"int32","description":"Tickets wanted together. Defaults to `1`.","example":2,"maximum":20,"minimum":1}}},"EventSearchResult":{"type":"object","description":"Events found by a search.","required":["events"],"properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/Event"}}}},"ExtraNights":{"oneOf":[{"type":"object","description":"Asked one by one, at a price the hotel names.","required":["kind"],"properties":{"kind":{"type":"string","enum":["on_request"]}}},{"type":"object","description":"Up to so many nights each side at the block's rate, while the hotel has rooms.","required":["before","after","kind"],"properties":{"after":{"type":"integer","format":"int32","minimum":0},"before":{"type":"integer","format":"int32","minimum":0},"kind":{"type":"string","enum":["up_to"]}}}],"description":"What the contract says about nights before and after the block. Either way the agent confirms them\nwith the hotel and prices them before the guests pay."},"FacilityPosition":{"type":"string","description":"Where across the cabin width a facility sits.","enum":["left","left_center","center","right_center","right"]},"FixedItem":{"oneOf":[{"type":"object","required":["booking_id","airport","at","at_hotel","transfer_minutes","type"],"properties":{"airport":{"type":"string"},"airport_name":{"type":["string","null"]},"at":{"type":"string","format":"date-time"},"at_hotel":{"type":"string","format":"date-time","description":"When the traveller can be at the hotel: out of the airport and across town."},"booking_id":{"type":"string","format":"uuid"},"transfer_minutes":{"type":"integer","format":"int32","minimum":0},"type":{"type":"string","enum":["arrival"]}}},{"type":"object","required":["booking_id","airport","at","leave_hotel_at","transfer_minutes","type"],"properties":{"airport":{"type":"string"},"airport_name":{"type":["string","null"]},"at":{"type":"string","format":"date-time"},"booking_id":{"type":"string","format":"uuid"},"leave_hotel_at":{"type":"string","format":"date-time","description":"When to leave the hotel to make the flight."},"transfer_minutes":{"type":"integer","format":"int32","minimum":0},"type":{"type":"string","enum":["departure"]}}},{"type":"object","required":["booking_id","hotel_name","at","type"],"properties":{"at":{"type":"string","format":"date-time"},"booking_id":{"type":"string","format":"uuid"},"hotel_name":{"type":"string"},"type":{"type":"string","enum":["check_in"]}}},{"type":"object","required":["booking_id","hotel_name","at","type"],"properties":{"at":{"type":"string","format":"date-time"},"booking_id":{"type":"string","format":"uuid"},"hotel_name":{"type":"string"},"type":{"type":"string","enum":["check_out"]}}},{"type":"object","required":["booking_id","name","at","type"],"properties":{"at":{"type":"string","format":"date-time"},"booking_id":{"type":"string","format":"uuid"},"location":{"$ref":"#/components/schemas/GeoLocation"},"name":{"type":"string"},"type":{"type":"string","enum":["event"]},"venue":{"type":["string","null"]}}}]},"FlightCartItem":{"type":"object","description":"A held flight itinerary.","required":["id","provider","owner_name","slices","passengers_count","total_amount","currency","status","created_at","updated_at"],"properties":{"created_at":{"type":"string","format":"date-time"},"currency":{"type":"string"},"fare_amount":{"type":"string","description":"The reservation price without seats."},"id":{"type":"string","format":"uuid","description":"Handle for this item — what removing it or checking it out takes. Not the offer id."},"owner_name":{"type":"string","description":"Airline owning the ticket."},"passengers_count":{"type":"integer","format":"int32"},"provider":{"type":"string","description":"Distribution channel the fare was sourced through."},"seats":{"$ref":"#/components/schemas/FlightSeatSelection","description":"Absent until a seat is picked."},"slices":{"type":"array","items":{"$ref":"#/components/schemas/OfferSlice"},"description":"The legs, in the order they are flown."},"status":{"$ref":"#/components/schemas/ReservationStatus"},"total_amount":{"type":"string","description":"`fare_amount` plus the seats."},"updated_at":{"type":"string","format":"date-time"}}},"FlightCartItemEnriched":{"type":"object","description":"Enriched flight cart item with display-friendly fields loaded from booking.","required":["id","provider","owner_name","slices","passengers_count","total_amount","currency","status","travelers","document_required","route_type","created_at","updated_at"],"properties":{"airports":{"type":["object","null"],"description":"Map of airport code to display info (name, city).","additionalProperties":{"$ref":"#/components/schemas/AirportDisplayInfo"},"propertyNames":{"type":"string"}},"base_amount":{"type":["string","null"],"description":"Base fare amount before taxes."},"cabin_class":{"type":["string","null"],"description":"Cabin class from first segment (economy, business, etc)."},"created_at":{"type":"string","format":"date-time"},"currency":{"type":"string"},"document_required":{"type":"boolean","description":"Whether a passport has to be on file before this flight can be booked."},"fare_amount":{"type":"string","description":"The reservation price without seats."},"id":{"type":"string","format":"uuid"},"owner_iata_code":{"type":["string","null"],"description":"IATA code of the owning airline."},"owner_logo_url":{"type":["string","null"],"description":"Logo URL of the owning airline."},"owner_name":{"type":"string","description":"Airline owning the ticket."},"passengers":{"type":"array","items":{"$ref":"#/components/schemas/OfferPassenger"},"description":"The travellers the fare is for, one entry each, so the same trip can be shopped again on\nother dates."},"passengers_count":{"type":"integer","format":"int32"},"payment_method":{"type":["string","null"],"description":"How the traveller pays for it. Absent when nothing can book it.","enum":["card","stripe","provider_sdk","hosted",null]},"provider":{"type":"string","description":"Distribution channel the fare was sourced through."},"route_type":{"$ref":"#/components/schemas/RouteType"},"seats":{"$ref":"#/components/schemas/FlightSeatSelection","description":"Absent until a seat is picked."},"slices":{"type":"array","items":{"$ref":"#/components/schemas/OfferSlice"},"description":"The legs, in the order they are flown."},"status":{"$ref":"#/components/schemas/ReservationStatus"},"tax_amount":{"type":["string","null"],"description":"Tax amount."},"total_amount":{"type":"string","description":"`fare_amount` plus the seats."},"travelers":{"type":"array","items":{"$ref":"#/components/schemas/CartTraveler"},"description":"Passengers already on the reservation."},"travelers_required":{"type":["integer","null"],"description":"Seats sold, which is how many passengers the booking needs.","minimum":0},"updated_at":{"type":"string","format":"date-time"}}},"FlightSearchAction":{"type":"object","description":"The trip the assistant shopped for.","required":["origin","destination","departure_date","adults","children_ages"],"properties":{"adults":{"type":"integer","format":"int32","minimum":0},"children_ages":{"type":"array","items":{"type":"integer","format":"int32","minimum":0}},"departure_date":{"type":"string","format":"date"},"destination":{"type":"string","example":"LIS"},"origin":{"type":"string","description":"IATA code.","example":"CDG"},"return_date":{"type":["string","null"],"format":"date","description":"Absent on a one way."}}},"FlightSearchPassenger":{"type":"object","description":"One traveller.","required":["passenger_type"],"properties":{"age":{"type":["integer","null"],"format":"int32","description":"Age at departure. Required for `child` and `infant`, where the fare depends on it, and\nomitted for `adult`.","example":9},"passenger_type":{"$ref":"#/components/schemas/PassengerType"}}},"FlightSearchRequest":{"type":"object","description":"Everything needed to shop one itinerary.","required":["slices","passengers"],"properties":{"airline_filter":{"$ref":"#/components/schemas/AirlineFilter","description":"Optional. Restricts which airlines may appear in the results, by IATA airline code. Omit it\nto shop every airline."},"cabin_class":{"type":["string","null"],"description":"Optional, `economy` when omitted. A leg the airline cannot sell in that cabin comes back in\nthe nearest one it can, so read the cabin off each returned segment.","enum":["economy","premium_economy","business","first",null]},"currency":{"type":["string","null"],"description":"Optional. The currency prices are wanted in. Offers keep the currency the ticket is charged\nin whenever it is another one.","example":"USD"},"max_connections":{"type":["integer","null"],"format":"int32","description":"Optional. Most connections allowed on any one leg — `0` returns direct flights only.\nConnections are not capped when omitted.","example":1,"minimum":0},"passengers":{"type":"array","items":{"$ref":"#/components/schemas/FlightSearchPassenger"},"description":"One entry per traveller — three adults are three entries, not one with a count."},"slices":{"type":"array","items":{"$ref":"#/components/schemas/FlightSearchSlice"},"description":"The legs to price together, in the order they are flown: one entry is a one-way, two a\nreturn, three or more a multi-city trip. All of them are priced as a single ticket."}}},"FlightSearchResultExt":{"type":"object","description":"Search results: the offers shopped for one itinerary, ready to render.","required":["search_id","offers","airports","airlines_available"],"properties":{"airlines_available":{"type":"array","items":{"type":"string"},"description":"IATA codes of the airlines owning the offers, sorted. Ready to build a carrier filter from.","example":["BA"]},"airports":{"type":"object","description":"Every IATA code appearing anywhere in `offers`, resolved to what to call it. Codes missing\nfrom the map have no reference data — render the bare code.","additionalProperties":{"$ref":"#/components/schemas/AirportInfo"},"propertyNames":{"type":"string"}},"offers":{"type":"array","items":{"$ref":"#/components/schemas/OfferExt"},"description":"Priceable itineraries, unpaginated and unsorted - except when shopping for offers similar to a\nreservation, where they come closest first. Empty when nothing is available."},"search_id":{"type":"string","description":"Handle for the search as a whole. With an `offers[].id` it is what\n`POST /api/v1/flight/search/{search_id}/offer/{offer_id}/select` takes to move an offer into booking."}}},"FlightSearchSlice":{"type":"object","description":"One leg of the trip.","required":["origin","destination","departure_date"],"properties":{"arrival_time_before":{"type":["string","null"],"description":"Optional. Latest local arrival time at `destination`, `HH:MM:SS`."},"departure_date":{"type":"string","format":"date","description":"Departure day in the origin's local time, `YYYY-MM-DD`.","example":"2026-11-05"},"departure_time_after":{"type":["string","null"],"description":"Optional. Earliest local departure time on this leg, `HH:MM:SS`. Omit for the whole day."},"departure_time_before":{"type":["string","null"],"description":"Optional. Latest local departure time on this leg, `HH:MM:SS`."},"destination":{"type":"string","description":"IATA airport or metro code to arrive at.","example":"JFK"},"origin":{"type":"string","description":"IATA code to depart from — an airport (`LHR`) or a metro code standing for every airport of\na city (`LON`). `GET /api/v1/airport/autocomplete` turns what a traveller types into these.","example":"LHR"}}},"FlightSeatMapsResponse":{"type":"object","required":["segments"],"properties":{"segments":{"type":"array","items":{"$ref":"#/components/schemas/SegmentSeatMap"},"description":"One map per upcoming segment, or per leg of a segment that changes aircraft."}}},"FlightSeatSelection":{"type":"object","description":"Seats picked on a flight booking. Every amount is in `currency`, which is always the booking's.","required":["assignments","total_amount","currency"],"properties":{"assignments":{"type":"array","items":{"$ref":"#/components/schemas/SeatAssignment"}},"currency":{"type":"string","example":"USD"},"total_amount":{"type":"string","description":"Sum of `amount` over assignments that are not `rejected`.","example":"50.00"}}},"FuelType":{"type":"string","enum":["Unspecified","Diesel","Hybrid","Electric","Lpg","Hydrogen","MultiFuel","Petrol","Ethanol"]},"FxRateResponse":{"type":"object","description":"A reference rate for showing an amount in the viewer's currency. Never used to price anything:\nthe provider charges in its own currency at whatever rate the card issuer applies.","required":["from","to","rate"],"properties":{"from":{"type":"string","description":"`from`, upper-cased.","example":"USD"},"rate":{"type":"string","description":"How many `to` one `from` buys.","example":"1.3705"},"to":{"type":"string","description":"`to`, upper-cased.","example":"CAD"}}},"Gender":{"type":"string","enum":["male","female"]},"GeoLocation":{"type":"object","description":"WGS 84 coordinates.","required":["latitude","longitude"],"properties":{"latitude":{"type":"number","format":"double","example":40.7127837},"longitude":{"type":"number","format":"double","example":-74.0059413}}},"GuestPayment":{"type":"string","enum":["agency","hotel"]},"HotelBlockBrief":{"type":"object","description":"What a room block needs, beyond the dates and party size every request has.","properties":{"board":{"type":["string","null"]},"catering":{"type":["string","null"]},"flexible_dates":{"type":"boolean"},"hotels":{"type":"array","items":{"$ref":"#/components/schemas/ShortlistedHotel"},"description":"The hotels the customer would like; none means any that fits."},"meeting_space":{"type":["string","null"]},"min_stars":{"type":["integer","null"],"format":"int32","minimum":0},"rooms":{"type":"array","items":{"$ref":"#/components/schemas/RoomNeed"}}}},"HotelBlockLines":{"type":"object","required":["rooms"],"properties":{"attrition_percent":{"type":["integer","null"],"format":"int32","description":"The share of the block, in percent, the hotel charges for even if fewer rooms are taken.","minimum":0},"cutoff":{"type":["string","null"],"format":"date","description":"Rooms not given to a guest by then go back to the hotel."},"extra_nights":{"oneOf":[{"type":"object","description":"Asked one by one, at a price the hotel names.","required":["kind"],"properties":{"kind":{"type":"string","enum":["on_request"]}}},{"type":"object","description":"Up to so many nights each side at the block's rate, while the hotel has rooms.","required":["before","after","kind"],"properties":{"after":{"type":"integer","format":"int32","minimum":0},"before":{"type":"integer","format":"int32","minimum":0},"kind":{"type":"string","enum":["up_to"]}}}],"description":"Nights before and after the block the hotel gives guests; none when it gives none."},"extras":{"type":"array","items":{"$ref":"#/components/schemas/PriceLine"}},"guest_payment":{"type":["string","null"],"description":"How guests who pay for their own room pay for it; at the hotel when not said.","enum":["agency","hotel",null]},"hotel_id":{"type":["string","null"],"description":"The shortlisted hotel it is for, by its catalog id; none for a hotel the agent found."},"min_nights":{"type":["integer","null"],"format":"int32","description":"The fewest nights a guest's own stay in the block may have.","minimum":0},"rooms":{"type":"array","items":{"$ref":"#/components/schemas/HotelBlockRoomLine"}}}},"HotelBlockRoomLine":{"type":"object","required":["room_type","count","nights","rate_per_night"],"properties":{"board":{"type":["string","null"]},"count":{"type":"integer","format":"int32","minimum":0},"nights":{"type":"integer","format":"int32","minimum":0},"rate_per_night":{"type":"string"},"room_type":{"type":"string"}}},"HotelCartItem":{"type":"object","description":"A held hotel stay.","required":["id","hotel_name","hotel_id","provider","checkin","checkout","total_amount","currency","status","created_at","updated_at"],"properties":{"checkin":{"type":"string","format":"date","description":"First night of the stay."},"checkout":{"type":"string","format":"date","description":"Departure day, exclusive."},"created_at":{"type":"string","format":"date-time","description":"When the offer was selected."},"currency":{"type":"string","example":"USD"},"hotel_id":{"type":"string","description":"The property id hotel search returned."},"hotel_name":{"type":"string"},"id":{"type":"string","format":"uuid","description":"Handle for this item — what removing it or checking it out takes. Not the offer id."},"provider":{"type":"string"},"room_types":{"type":["string","null"],"description":"Ready-to-render summary of the rooms held, e.g. `2 × Deluxe King`."},"status":{"$ref":"#/components/schemas/ReservationStatus"},"total_amount":{"type":"string","description":"All-in price of the whole stay, in `currency`.","example":"1284.00"},"updated_at":{"type":"string","format":"date-time"}}},"HotelCartItemEnriched":{"type":"object","description":"Enriched hotel cart item with display-friendly fields loaded from booking.","required":["id","hotel_name","hotel_id","provider","checkin","checkout","total_amount","currency","status","travelers","created_at","updated_at"],"properties":{"address":{"$ref":"#/components/schemas/Address","description":"Hotel address for display."},"base_amount":{"type":["string","null"],"description":"Base price before taxes."},"board_type":{"type":["string","null"],"description":"Board type (breakfast, half board, etc)."},"cancellation_policy":{"$ref":"#/components/schemas/CancellationPolicy","description":"The rules behind the description, for showing each deadline in the hotel's own time."},"cancellation_policy_description":{"type":["string","null"],"description":"Cancellation policy description."},"checkin":{"type":"string","format":"date"},"checkout":{"type":"string","format":"date"},"created_at":{"type":"string","format":"date-time"},"currency":{"type":"string"},"free_cancellation":{"type":["boolean","null"],"description":"Free cancellation available."},"geo":{"$ref":"#/components/schemas/GeoLocation","description":"Where the property is, when the provider placed it."},"hotel_id":{"type":"string"},"hotel_images":{"type":["array","null"],"items":{"type":"string"},"description":"Hotel images for display."},"hotel_name":{"type":"string"},"id":{"type":"string","format":"uuid"},"payment_method":{"type":["string","null"],"description":"How the traveller pays for it. Absent when nothing can book it.","enum":["card","stripe","provider_sdk","hosted",null]},"payment_policy":{"oneOf":[{"type":"object","description":"The guest pays nothing upfront. The card is held as a guarantee against no-show or late\ncancellation; the property collects the full amount at check-in or check-out.","required":["type"],"properties":{"type":{"type":"string","enum":["pay_at_property"]}}},{"type":"object","description":"The property charges a deposit before arrival. `amount` is present once the rate has been\nprice-checked; at search time it may be `None` (the deposit is known to be required but\nthe exact sum has not been confirmed yet).","required":["type"],"properties":{"amount":{"type":["string","null"],"example":"150.00"},"type":{"type":"string","enum":["deposit"]}}},{"type":"object","description":"The full stay price is charged to the card at booking time.","required":["type"],"properties":{"type":{"type":"string","enum":["prepay"]}}}],"description":"How the property collects payment (deposit, pay-at-property, prepay)."},"provider":{"type":"string"},"room_description":{"type":["string","null"],"description":"Detailed room description."},"room_types":{"type":["string","null"]},"rooms":{"type":"array","items":{"$ref":"#/components/schemas/RoomOccupancy"},"description":"The party in each room the price is for, in the shape a hotel search takes, so the same\nstay can be shopped again on other dates."},"star_rating":{"type":["integer","null"],"format":"int32","description":"Hotel star rating (1-5).","minimum":0},"status":{"$ref":"#/components/schemas/ReservationStatus"},"tax_amount":{"type":["string","null"],"description":"Tax amount."},"total_amount":{"type":"string"},"travelers":{"type":"array","items":{"$ref":"#/components/schemas/CartTraveler"},"description":"Guests already on the reservation."},"travelers_required":{"type":["integer","null"],"description":"How many the room sleeps.","minimum":0},"updated_at":{"type":"string","format":"date-time"}}},"HotelDifference":{"type":"string","description":"One way a hotel or an offer departs from the one it is compared with.","enum":["property","location","star_rating","chain","guest_rating","room","bedding","view","board","cancellation","rate_plan","payment"]},"HotelInfo":{"type":"object","description":"A property as returned by search.","required":["id","name","address","geo_location","star_rating","amenities","images"],"properties":{"address":{"$ref":"#/components/schemas/Address"},"amenities":{"type":"array","items":{"type":"string"},"description":"Free-text amenity labels in the requested language. For matching, use `amenity_keys`."},"chain":{"type":["string","null"],"description":"Hotel brand as the provider names it, e.g. `Hampton Inn`.","example":"Hampton Inn"},"chain_code":{"type":["string","null"],"description":"GDS chain code, which says which hotel loyalty program the stay credits.","example":"HX"},"description":{"type":"string","description":"Property description in the requested language; may be empty."},"geo_location":{"$ref":"#/components/schemas/GeoLocation"},"id":{"type":"string","description":"Opaque property id."},"images":{"type":"array","items":{"type":"string"},"description":"Property photo URLs, best first."},"name":{"type":"string","description":"Property name as the provider spells it.","example":"Grand Luxury Hotel & Spa"},"rating":{"type":["string","null"],"description":"rating from travellers reviews 0..10"},"rating_cnt":{"type":["integer","null"],"format":"int64","description":"number of ratings from travelers"},"star_rating":{"type":"integer","format":"int32","description":"Official star classification, `0` when the provider gives none.","example":5,"minimum":0},"tz":{"type":["string","null"],"description":"IANA timezone of the property, e.g. `America/New_York`.","example":"America/New_York"}}},"HotelInfoExt":{"allOf":[{"$ref":"#/components/schemas/HotelInfo"},{"type":"object","required":["amenity_keys"],"properties":{"amenity_keys":{"type":"array","items":{"type":"string"},"description":"Language-independent counterparts of the free-text `amenities` list (`free_wifi`, `pool`,\n`gym`, …). Match on these rather than on the display strings."}}}],"description":"Property details plus normalised amenity keys. Serialised flat."},"HotelMatchLevel":{"type":"string","description":"How close a hotel offer comes to the one it is compared with. Ordered weakest first.","enum":["similar","same_hotel","same_room","identical"]},"HotelOfferSimilarity":{"type":"object","description":"How an offer compares with a reference offer, typically the one a reservation was booked on.","required":["score","match_level","same_reservation","same_conditions","differences"],"properties":{"differences":{"type":"array","items":{"$ref":"#/components/schemas/HotelDifference"},"description":"Property and offer differences together; empty when identical."},"match_level":{"$ref":"#/components/schemas/HotelMatchLevel"},"price_difference":{"type":["string","null"],"description":"`pricing.total` minus the reference's, positive when dearer. `null` when priced in another currency.","example":"25.00"},"same_conditions":{"type":"boolean","description":"Refundability and the free-cancellation deadline match the reference."},"same_reservation":{"type":"boolean","description":"The very product that was booked: same property, rooms, board, rate plan and cancellation\nterms. The price may still differ."},"score":{"type":"integer","format":"int32","description":"0 to 100, higher is closer.","example":92,"minimum":0}}},"HotelOffersExt":{"type":"object","description":"One property and the offers shopped for it.","required":["hotel","offers","more_rates_available"],"properties":{"hotel":{"$ref":"#/components/schemas/HotelInfoExt","description":"The property itself."},"more_rates_available":{"type":"boolean","description":"Whether this property has rates beyond the ones listed here, so a UI knows when \"see all\nrooms\" is worth offering.\n\n`true`: `GET /api/v1/hotel/rates/{offer_id}`, with any `offer_id` from this property's\n`offers`, returns the property again with its complete list of offers, shaped exactly like\none entry of `hotels`. `false`: every rate is already here, and that call\nanswers `404`."},"offers":{"type":"array","items":{"$ref":"#/components/schemas/RoomOffersExt"},"description":"Bookable offers for the requested stay and occupancy."},"similarity":{"$ref":"#/components/schemas/HotelSimilarity","description":"How the property compares with a booked one. Only set by similar-offer search."}}},"HotelSearchAction":{"type":"object","description":"The stay the assistant shopped for.","required":["location","latitude","longitude","check_in","check_out","adults","children_ages"],"properties":{"adults":{"type":"integer","format":"int32","minimum":0},"check_in":{"type":"string","format":"date","example":"2026-11-01"},"check_out":{"type":"string","format":"date","example":"2026-11-03"},"children_ages":{"type":"array","items":{"type":"integer","format":"int32","minimum":0},"description":"One age per child, empty when there are none."},"latitude":{"type":"number","format":"double"},"location":{"type":"string","description":"The place as the traveller named it, for the destination field.","example":"Paris"},"longitude":{"type":"number","format":"double"},"radius_km":{"type":["number","null"],"format":"double"}}},"HotelSearchRequest":{"type":"object","description":"Everything needed to shop one hotel stay.","required":["latitude","longitude","check_in","check_out","rooms"],"properties":{"amenities":{"type":["array","null"],"items":{"type":"string","enum":["AirConditioning","Balcony","Bar","Bath","Beach","Bed","CoffeeTea","Concierge","Desk","Elevator","FitnessCenter","FreeParking","FreeWiFi","Fridge","Hairdryer","Iron","Kitchen","Lounge","Minibar","Parking","PetsAllowed","Phone","Restaurant","Safe","Shower","Shuttle","Spa","SwimmingPool","TV","Toilet","View","WiFi"]},"description":"Keep only properties offering all of these amenities.\n\nValues are case-sensitive, spelled exactly as listed: `AirConditioning`, `Balcony`, `Bar`,\n`Bath`, `Beach`, `Bed`, `CoffeeTea`, `Concierge`, `Desk`, `Elevator`, `FitnessCenter`,\n`FreeParking`, `FreeWiFi`, `Fridge`, `Hairdryer`, `Iron`, `Kitchen`, `Lounge`, `Minibar`,\n`Parking`, `PetsAllowed`, `Phone`, `Restaurant`, `Safe`, `Shower`, `Shuttle`, `Spa`,\n`SwimmingPool`, `TV`, `Toilet`, `View`, `WiFi`.","example":["FreeWiFi","SwimmingPool"]},"check_in":{"type":"string","format":"date","description":"First night of the stay, `YYYY-MM-DD`.","example":"2026-11-05"},"check_out":{"type":"string","format":"date","description":"Departure day, exclusive — the night before it is the last one booked. Must be after\n`check_in`.","example":"2026-11-08"},"currency":{"type":["string","null"],"description":"The currency prices are wanted in. Defaults to `USD`. Offers keep the currency the hotel\ncharges whenever it is another one.","example":"USD"},"guest_nationality":{"type":["string","null"],"description":"ISO 3166-1 alpha-2 country of the lead guest. Many rates are nationality-restricted, so\nthis changes both price and availability. Defaults to `US`.","example":"US"},"hotel_star_ratings":{"type":["array","null"],"items":{"type":"integer","format":"int32"},"description":"Star classes to keep. Half steps are included, so `4` also matches 4.5-star properties.","example":[4,5]},"language":{"type":["string","null"],"description":"Language of the response: hotel and room texts, the cancellation summary and amenity keys.\n\nFully supported: `de`, `en`, `es`, `fr`, `it`, `ru`, `uk`, `zh`. Other ISO 639-1 codes may\nlocalise property texts while the rest stays English. Anything unsupported falls back to\nEnglish rather than failing the request. Defaults to `en`.","example":"en"},"latitude":{"type":"number","format":"double","description":"Centre of the search. Resolve the place in your own UI and send the point.","example":40.7075},"longitude":{"type":"number","format":"double","description":"Centre of the search. Resolve the place in your own UI and send the point.","example":-74.0113},"radius_km":{"type":["number","null"],"format":"double","description":"Search radius around the resolved centre, in kilometres. Defaults to `5`.","example":5.0},"requested_hotel_name":{"type":["string","null"],"description":"Narrows the search onto a single property. The name is geocoded — the point it resolves to\ntakes precedence over `latitude` / `longitude` — and matched leniently."},"rooms":{"type":"array","items":{"$ref":"#/components/schemas/RoomOccupancy"},"description":"One entry per room required. Returned offers are priced for the whole party, so a\ntwo-entry list yields offers that already contain two rooms."}}},"HotelSearchResultExt":{"type":"object","description":"Search results: every matching property with its bookable offers.","required":["hotels"],"properties":{"hotels":{"type":"array","items":{"$ref":"#/components/schemas/HotelOffersExt"},"description":"Matching properties, unsorted and unpaginated."}}},"HotelSimilarity":{"type":"object","description":"How a property compares with the one of the reference offer.","required":["score","same_property","distance_meters","star_rating_difference","differences"],"properties":{"differences":{"type":"array","items":{"$ref":"#/components/schemas/HotelDifference"},"description":"Empty for the same property."},"distance_meters":{"type":"integer","format":"int32","description":"Straight-line distance from the booked property.","example":420,"minimum":0},"same_property":{"type":"boolean","description":"The property that was booked, possibly sold through another provider."},"score":{"type":"integer","format":"int32","description":"0 to 100, higher is closer. `100` for the very same property.","example":78,"minimum":0},"star_rating_difference":{"type":"integer","format":"int32","description":"`star_rating` minus the booked property's, negative when lower.","example":-1}}},"InsuranceBrief":{"type":"object","description":"The trip to insure, as the checkout found it. Agents complete what the cart couldn't tell, such as a\ndestination named only in a hotel's address.","required":["quote"],"properties":{"cart_id":{"type":["string","null"],"format":"uuid","description":"The cart whose bookings it covers."},"quote":{"$ref":"#/components/schemas/InsuranceQuoteRequest"}}},"InsuranceDocument":{"type":"object","required":["kind","url"],"properties":{"kind":{"$ref":"#/components/schemas/InsuranceDocumentKind"},"url":{"type":"string"}}},"InsuranceDocumentKind":{"type":"string","enum":["terms","product_info","certificate","other"]},"InsuranceDocumentView":{"type":"object","required":["id","kind","file_name","content_type","size_bytes","created_at"],"properties":{"booking_id":{"type":["string","null"],"format":"uuid","description":"The policy whose certificate it is."},"content_type":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"file_name":{"type":"string"},"id":{"type":"string","format":"uuid"},"kind":{"$ref":"#/components/schemas/InsuranceDocumentKind"},"offer_id":{"type":["string","null"],"format":"uuid","description":"The offer whose terms it is."},"size_bytes":{"type":"integer","format":"int32"}}},"InsuranceExtras":{"type":"object","description":"What an insurance request has beyond any other: the bookings it covers and the agent's files.","required":["covered","documents"],"properties":{"covered":{"type":"array","items":{"$ref":"#/components/schemas/CoveredBooking"}},"documents":{"type":"array","items":{"$ref":"#/components/schemas/InsuranceDocumentView"}}}},"InsuranceHighlights":{"type":"object","required":["included","excluded"],"properties":{"excluded":{"type":"array","items":{"type":"string"}},"included":{"type":"array","items":{"type":"string"}}}},"InsuranceLines":{"type":"object","description":"One insurer's policy for the trip, as the agent got it.","required":["insurer","product","coverages","premium"],"properties":{"coverages":{"type":"array","items":{"$ref":"#/components/schemas/Coverage"}},"highlights":{"$ref":"#/components/schemas/InsuranceHighlights"},"insurer":{"type":"string","example":"AXA Assistance"},"plan":{"type":["string","null"],"example":"Premium"},"premium":{"type":"string","description":"What the traveller pays for the whole party."},"product":{"type":"string","example":"Travel Protect"},"tax":{"type":["string","null"],"description":"Taxes already inside `premium`."},"terms_url":{"type":["string","null"],"description":"The policy wording on the insurer's site."}}},"InsuranceOffer":{"type":"object","description":"One insurer's plan for the trip. The insurer, the documents and the disclaimer go wherever the offer is shown.","required":["offer_id","provider","insurer","product","pricing","coverages","highlights","documents","rank"],"properties":{"coverages":{"type":"array","items":{"$ref":"#/components/schemas/Coverage"}},"disclaimer":{"type":["string","null"],"description":"Text the insurer requires shown with the price."},"documents":{"type":"array","items":{"$ref":"#/components/schemas/InsuranceDocument"}},"expires_at":{"type":["string","null"],"format":"date-time"},"highlights":{"$ref":"#/components/schemas/InsuranceHighlights"},"insurer":{"$ref":"#/components/schemas/Insurer"},"offer_id":{"type":"string","format":"uuid"},"pricing":{"$ref":"#/components/schemas/InsurancePricing"},"product":{"$ref":"#/components/schemas/InsuranceProduct"},"provider":{"type":"string"},"rank":{"type":"integer","format":"int32","description":"Position among the quote's offers, cheapest first.","minimum":0}}},"InsuranceOptIn":{"type":"object","description":"Travel insurance asked for at checkout. Once the cart is booked, an agent sends offers for it.","required":["residence_country"],"properties":{"cover":{"$ref":"#/components/schemas/CoverNeeds"},"page_url":{"type":["string","null"],"description":"The page the traveller follows the offers on; emails link back to it."},"purpose":{"$ref":"#/components/schemas/TripPurpose"},"residence_country":{"type":"string","description":"Where the travellers live, ISO 3166-1 alpha-2.","example":"US"},"residence_region":{"type":["string","null"],"description":"Required for US residents.","example":"NY"}}},"InsurancePricing":{"type":"object","required":["total","currency","is_starting_price"],"properties":{"currency":{"type":"string","example":"USD"},"is_starting_price":{"type":"boolean","description":"A \"from\" price: the insurer sets the exact premium."},"tax":{"type":["string","null"],"description":"Taxes already inside `total`, when the insurer breaks them out."},"total":{"type":"string","description":"What the traveller pays for the whole party.","example":"189.40"}}},"InsuranceProduct":{"type":"object","required":["code"],"properties":{"code":{"type":"string","description":"The provider's own id for the product."},"name":{"type":["string","null"],"example":"Travel Protect"},"plan":{"type":["string","null"],"example":"Premium"}}},"InsuranceQuoteRequest":{"type":"object","required":["start_date","end_date","residence_country","destinations","travellers","currency"],"properties":{"cover":{"$ref":"#/components/schemas/CoverNeeds"},"currency":{"type":"string","description":"The ISO 4217 currency prices are wanted in and `trip_cost` is given in.","example":"USD"},"deposit_date":{"type":["string","null"],"format":"date","description":"When the trip was first paid for. Some insurers waive exclusions for cover bought soon after it."},"destinations":{"type":"array","items":{"type":"string"},"description":"ISO 3166-1 alpha-2 countries visited.","example":["MX"]},"end_date":{"type":"string","format":"date","description":"Last day of cover."},"language":{"type":["string","null"],"description":"ISO 639-1 language of the offers' texts and the insurer's checkout.","example":"en"},"purpose":{"$ref":"#/components/schemas/TripPurpose"},"residence_country":{"type":"string","description":"ISO 3166-1 alpha-2 country the travellers live in, which decides who may sell them cover.","example":"US"},"residence_region":{"type":["string","null"],"description":"The state or province of residence; required for the US, where products differ by state.","example":"NY"},"start_date":{"type":"string","format":"date","description":"First day of cover."},"travellers":{"type":"array","items":{"$ref":"#/components/schemas/InsuredTraveller"}},"trip_cost":{"type":["string","null"],"description":"What the whole party paid for the trip, in `currency`. Required for cancellation cover.","example":"4200.00"}}},"InsuranceQuoteResult":{"type":"object","required":["offers"],"properties":{"offers":{"type":"array","items":{"$ref":"#/components/schemas/InsuranceOffer"},"description":"Cheapest first. Empty when no insurer covers the trip."}}},"InsuredTraveller":{"type":"object","description":"An age, or a date of birth to take it from on the first day of cover.","properties":{"age":{"type":["integer","null"],"format":"int32","example":41,"minimum":0},"dob":{"type":["string","null"],"format":"date"}}},"Insurer":{"type":"object","properties":{"logo_url":{"type":["string","null"]},"name":{"type":["string","null"],"description":"The underwriting insurer.","example":"AXA Assistance"}}},"ItemPaymentRequest":{"type":"object","description":"The payment the page finished for this item.","properties":{"three_d_secure_session_id":{"type":["string","null"],"description":"Duffel's card form: `id` of the session `createThreeDSecureSession` answered with status\n`ready_for_payment`. Left out for `stripe`, whose payment is read from Stripe itself."}}},"ItemPaymentResponse":{"type":"object","description":"What a provider's payment SDK takes to charge one item, on the site's own page. Which fields\nare set depends on `provider`.","required":["provider"],"properties":{"amount":{"type":["string","null"],"description":"Duffel: the amount the airline charges, in `currency`.","example":"219.64"},"cardholder_present":{"type":["boolean","null"],"description":"Duffel: `cardholderPresent` of `createThreeDSecureSession`; `false` when someone of the agency\nkeys in a card the traveller gave them."},"client_key":{"type":["string","null"],"description":"Duffel: the client key for `DuffelCardForm` and `createThreeDSecureSession`."},"client_secret":{"type":["string","null"],"description":"Stripe: the intent's client secret; the publishable key is in `GET /client-config`."},"currency":{"type":["string","null"],"example":"EUR"},"provider":{"type":"string","description":"Who takes the card: `nuitee` or `nuitee_air` (liteAPI's SDK), `duffel` (Duffel's card form) or\n`stripe` (the agency's Stripe holds the money, Stripe.js `confirmCardPayment` with `client_secret`)."},"public_key":{"type":["string","null"],"description":"liteAPI."},"resource_id":{"type":["string","null"],"description":"Duffel: the offer the card is authenticated for, `resourceId` of `createThreeDSecureSession`."},"return_url":{"type":["string","null"],"description":"liteAPI: where the SDK sends the browser once it charged the card. It books the item and\nanswers with no content, so the page stays where it is and sees the item land in the cart processing."},"sdk_url":{"type":["string","null"],"description":"liteAPI: the SDK script to load."},"secret_key":{"type":["string","null"],"description":"liteAPI: this item's payment, issued by the provider when the item was prebooked."}}},"ItemState":{"oneOf":[{"type":"object","required":["state"],"properties":{"state":{"type":"string","enum":["queued"]}}},{"type":"object","required":["state"],"properties":{"state":{"type":"string","enum":["prepared"]}}},{"type":"object","required":["state"],"properties":{"state":{"type":"string","enum":["booked"]}}},{"type":"object","required":["required","state"],"properties":{"required":{"$ref":"#/components/schemas/RequiredInput"},"state":{"type":"string","enum":["awaiting_input"]}}},{"type":"object","required":["reason_slug","message","state"],"properties":{"message":{"type":"string"},"reason_slug":{"type":"string"},"state":{"type":"string","enum":["failed"]}}},{"type":"object","required":["state"],"properties":{"state":{"type":"string","enum":["skipped"]}}},{"type":"object","description":"A charge was attempted and its outcome is unknown. Never retried by anything.","required":["state"],"properties":{"state":{"type":"string","enum":["post_payment_review"]}}},{"type":"object","description":"Failed before anything was charged and was swapped, in the same checkout, for\n`replacement_item_id` - also an item of this run.","required":["replacement_item_id","state"],"properties":{"replacement_item_id":{"type":"string","format":"uuid"},"state":{"type":"string","enum":["replaced"]}}}],"description":"Where one item stands."},"ItemsPaymentRequest":{"type":"object","description":"A card for some of the cart's items. Lets a traveller split a cart across cards.","required":["item_ids","payment_method"],"properties":{"item_ids":{"type":"array","items":{"type":"string","format":"uuid"}},"payment_method":{"$ref":"#/components/schemas/PaymentMethodRequest"}}},"LoyaltyKind":{"type":"string","enum":["air","hotel","car"]},"LoyaltyMembershipResponse":{"type":"object","description":"One of a traveller's loyalty memberships.","required":["id","companion_id","program_id","program_code","program_name","kind","number","priority"],"properties":{"companion_id":{"type":"string","format":"uuid"},"id":{"type":"string","format":"uuid"},"kind":{"$ref":"#/components/schemas/LoyaltyKind"},"number":{"type":"string","example":"AB123456"},"priority":{"type":"integer","format":"int32","example":0},"program_code":{"type":"string","example":"flying_blue"},"program_id":{"type":"string","format":"uuid"},"program_name":{"type":"string","example":"Flying Blue"}}},"LoyaltyOption":{"type":"object","description":"A membership a traveller could attach to one booking, offered at checkout.","required":["membership_id","kind","program_code","program_name","number"],"properties":{"kind":{"$ref":"#/components/schemas/LoyaltyKind"},"membership_id":{"type":"string","format":"uuid"},"number":{"type":"string","example":"AB123456"},"program_code":{"type":"string","example":"flying_blue"},"program_name":{"type":"string","example":"Flying Blue"}}},"LoyaltyProgram":{"type":"object","required":["id","code","kind","name","supplier_codes"],"properties":{"code":{"type":"string","example":"flying_blue"},"id":{"type":"string","format":"uuid"},"kind":{"$ref":"#/components/schemas/LoyaltyKind"},"name":{"type":"string","example":"Flying Blue"},"supplier_codes":{"type":"array","items":{"type":"string"},"description":"Airlines, GDS hotel chain codes or car vendor codes whose bookings credit the program directly; the first\nairline is the one that issues the numbers.","example":["AF","KL"]}}},"MatchLevel":{"type":"string","description":"How close an offer comes to the one it is compared with. Ordered weakest first.","enum":["similar","same_flights","identical"]},"Mileage":{"oneOf":[{"type":"string","enum":["Unlimited"]},{"type":"object","required":["Limited"],"properties":{"Limited":{"type":"object","required":["allowance","unit"],"properties":{"allowance":{"type":"integer","format":"int32","minimum":0},"extra_charge":{"type":["string","null"]},"unit":{"$ref":"#/components/schemas/DistanceUnit"}}}}}]},"NearbyAirport":{"allOf":[{"$ref":"#/components/schemas/AirportSuggestion"},{"type":"object","required":["distance_km"],"properties":{"distance_km":{"type":"number","format":"float","description":"Straight-line distance from the point, in kilometres."}}}]},"NearbyAirportsResponse":{"type":"object","required":["results"],"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/NearbyAirport"}}}},"NegotiatedRate":{"type":"object","description":"A fare or room rate one of the tenant's negotiated codes unlocked. The code itself stays off it: offers reach\ntravellers, and the codes are the tenant's.","properties":{"label":{"type":["string","null"],"description":"What travellers are shown; without one, a generic \"Negotiated rate\"."}}},"NewQuoteRequest":{"type":"object","description":"A customer's brief, from the portal or the assistant.","required":["kind","title"],"properties":{"budget_amount":{"type":["string","null"]},"currency":{"type":["string","null"]},"departure_id":{"type":["string","null"],"format":"uuid","description":"The departure of the agency's package it asks about, from `GET /api/v1/packages/{slug}`."},"details":{"oneOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["custom"]}}},{"allOf":[{"$ref":"#/components/schemas/HotelBlockBrief"},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hotel_block"]}}}]},{"allOf":[{"$ref":"#/components/schemas/InsuranceBrief"},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["insurance"]}}}]}],"description":"The kind's own fields, e.g. the room mix of a hotel block. Absent means none given."},"end_date":{"type":["string","null"],"format":"date"},"kind":{"$ref":"#/components/schemas/QuoteKind"},"language":{"type":["string","null"],"description":"The language the customer's emails are written in, e.g. `fr`. Absent means English."},"location_text":{"type":["string","null"]},"page_url":{"type":["string","null"],"description":"The page the customer follows the request on; emails and the payment page link back to it."},"party_size":{"type":["integer","null"],"format":"int32"},"requirements":{"type":"string","description":"Everything else the agent should know, in the customer's words."},"start_date":{"type":["string","null"],"format":"date"},"title":{"type":"string","description":"\"Wedding room block in Lisbon\"."}}},"OfferConditions":{"type":"object","description":"What the fare rules allow before departure. An absent entry means the airline said nothing,\nwhich is not the same as \"not allowed\".","properties":{"change_before_departure":{"$ref":"#/components/schemas/Refund","description":"Moving the ticket to another flight."},"refund_before_departure":{"$ref":"#/components/schemas/Refund","description":"Handing the ticket back for a refund."}}},"OfferExt":{"type":"object","description":"One priceable itinerary: every leg, for the whole party, on one ticket.","required":["id","provider","currency","base_amount","total_amount","slices","passengers","passenger_identity_documents_required","owner","expires_at","conditions"],"properties":{"base_amount":{"type":"string","description":"Fare before taxes, for the whole party.","example":"300.00"},"conditions":{"$ref":"#/components/schemas/OfferConditions"},"currency":{"type":"string","description":"ISO 4217 code of every amount on this offer: the currency the ticket is charged in,\nwhatever currency the search asked for.","example":"USD"},"expires_at":{"type":"string","format":"date-time","description":"When the airline stops honouring this price. Past it, re-shop."},"id":{"type":"string","description":"Handle for this offer inside its search."},"negotiated_rate":{"$ref":"#/components/schemas/NegotiatedRate","description":"Set when one of the tenant's negotiated codes unlocked this fare."},"owner":{"$ref":"#/components/schemas/Airline","description":"Airline owning the ticket — whose fare rules apply, not necessarily who flies it."},"passenger_identity_documents_required":{"type":"boolean","description":"Passport or ID details have to be collected before this offer can be booked."},"passengers":{"type":"array","items":{"$ref":"#/components/schemas/OfferPassenger"},"description":"The travellers this price covers, one entry each."},"provider":{"type":"string","description":"Distribution channel the fare was sourced through."},"similarity":{"$ref":"#/components/schemas/OfferSimilarity","description":"How close this offer comes to a reservation. Only set when shopping for offers similar to one."},"slices":{"type":"array","items":{"$ref":"#/components/schemas/OfferSlice"},"description":"The legs, in the order they were requested."},"tax_amount":{"type":["string","null"],"description":"The part of `total_amount` that is tax, when the airline breaks it out.","example":"50.00"},"total_amount":{"type":"string","description":"All-in price for every traveller and every leg — the amount to display.","example":"350.00"}}},"OfferPassenger":{"type":"object","description":"One traveller this offer is priced for.","required":["passenger_type"],"properties":{"age":{"type":["integer","null"],"format":"int64"},"passenger_type":{"$ref":"#/components/schemas/PassengerType"}}},"OfferPayment":{"type":"string","description":"What accepting an offer takes, which the agent decides per offer.","enum":["full","deposit","nothing"]},"OfferSimilarity":{"type":"object","description":"How an offer compares with a reference offer, typically the one a reservation was booked on.","required":["score","match_level","same_reservation","same_provider","same_conditions","slices"],"properties":{"match_level":{"$ref":"#/components/schemas/MatchLevel","description":"The weakest level across the legs, lowered from `identical` when the fare conditions differ."},"price_difference":{"type":["string","null"],"description":"`total_amount` minus the reference's, positive when dearer. `null` when priced in another currency.","example":"25.00"},"same_conditions":{"type":"boolean","description":"Refund and change permissions match the reference."},"same_provider":{"type":"boolean","description":"Sourced through the same distribution channel as the reference."},"same_reservation":{"type":"boolean","description":"The very product that was booked: every leg identical and the same fare conditions. The\nprice may still differ."},"score":{"type":"integer","format":"int32","description":"0 to 100, higher is closer.","example":92,"minimum":0},"slices":{"type":"array","items":{"$ref":"#/components/schemas/SliceSimilarity"},"description":"One per leg, in the order of the offer's `slices`."}}},"OfferSlice":{"type":"object","description":"One leg as sold: the flights that make it up, end to end.","required":["origin","destination","segments","conditions","baggages"],"properties":{"baggages":{"type":"array","items":{"$ref":"#/components/schemas/Baggage"},"description":"Baggage the fare includes on this leg, per traveller. An absent `bag_type` means the fare\ncarries none of that kind."},"conditions":{"$ref":"#/components/schemas/Conditions"},"destination":{"type":"string","description":"destination airport iata code","example":"JFK"},"duration":{"type":["integer","null"],"format":"int32","description":"Gate to gate, in minutes, layovers included.","example":465},"fare_brand_name":{"type":["string","null"],"description":"Branded fare this leg is priced at, e.g. `ECONOMY BASIC`. Two offers can be the same flights\nat different brands, and this is what tells them apart.","example":"Economy"},"origin":{"type":"string","description":"origin airport iata code","example":"LHR"},"segments":{"type":"array","items":{"$ref":"#/components/schemas/OfferSliceSegment"},"description":"The flights flown in order. More than one means the leg connects."}}},"OfferSliceSegment":{"type":"object","description":"One flight: a single flight number from one airport to the next.","required":["origin","destination","stops","operating_carrier","marketing_carrier_flight_number","marketing_carrier","departing_at","arriving_at","cabin_class"],"properties":{"aircraft":{"$ref":"#/components/schemas/Aircraft","description":"Aircraft scheduled to fly it, when the airline names one."},"arriving_at":{"type":"string","format":"date-time","description":"Local time at `destination`, without an offset — so it can read as earlier than\n`departing_at` on a westbound flight.","example":"2026-11-05T17:45:00"},"cabin_class":{"$ref":"#/components/schemas/CabinClass","description":"The cabin this segment is actually sold in, which can differ from the one requested."},"departing_at":{"type":"string","format":"date-time","description":"Local time at `origin`, without an offset.","example":"2026-11-05T10:00:00"},"destination":{"type":"string","example":"JFK"},"destination_terminal":{"type":["string","null"]},"duration":{"type":["integer","null"],"format":"int32","description":"Scheduled flying time, in minutes.","example":465},"fare_basis_code":{"type":["string","null"],"description":"The fare's own code in the airline's tariff, for support to quote back."},"marketing_carrier":{"$ref":"#/components/schemas/Airline","description":"The airline the flight is sold under — the code on the ticket."},"marketing_carrier_flight_number":{"type":"string"},"operating_carrier":{"$ref":"#/components/schemas/Airline","description":"The airline actually flying it, which on a codeshare differs from the marketing carrier."},"operating_carrier_flight_number":{"type":["string","null"]},"origin":{"type":"string","example":"LHR"},"origin_terminal":{"type":["string","null"]},"stops":{"type":"array","items":{"$ref":"#/components/schemas/Stop"},"description":"Technical stops on the way. Usually empty."}}},"PassengerDocument":{"type":"object","required":["document_type","document_number","document_expiry","document_issue_country"],"properties":{"document_expiry":{"type":"string","format":"date","example":"2032-04-18"},"document_issue_country":{"type":"string","description":"ISO 3166-1 alpha-2 country that issued the document.","example":"US"},"document_number":{"type":"string","example":"X1234567"},"document_type":{"$ref":"#/components/schemas/DocumentType"}}},"PassengerType":{"type":"string","description":"Fare category a traveller is priced under. `infant` means an infant on an adult's lap.","enum":["adult","child","infant"]},"PaymentMethod":{"type":"string","enum":["card","stripe","provider_sdk","hosted"]},"PaymentMethodRequest":{"type":"object","description":"Card details, straight from the checkout form. Used for one run and never stored; a run that\npauses drops them, which is why a resume carries them again.\n\nThis shape is how the sandbox takes payment: one rate-limited test card\n(`4111 1111 1111 1111`, expiry 12/30, CVC 123), so an integration can be\ndriven end to end before a payment provider is wired up. In production,\npayment is an adapter onto the partner's own rails — their PSP, gateway,\ntokenisation, or a provider's hosted payment page — and the shape a partner\nruns determines their PCI scope.","required":["number","expiry_month","expiry_year","card_type_code","security_code","holder_given_name","holder_surname"],"properties":{"card_type_code":{"type":"string","description":"Two-letter scheme code: `VI`, `CA`, `AX`, `DS`, `DC`, `JC`."},"expiry_month":{"type":"string","description":"Two digits, `01`..`12`."},"expiry_year":{"type":"string","description":"Two digits, the last two of the year."},"holder_given_name":{"type":"string"},"holder_surname":{"type":"string"},"number":{"type":"string","description":"Card number, digits only."},"security_code":{"type":"string"}}},"PaymentPolicy":{"oneOf":[{"type":"object","description":"The guest pays nothing upfront. The card is held as a guarantee against no-show or late\ncancellation; the property collects the full amount at check-in or check-out.","required":["type"],"properties":{"type":{"type":"string","enum":["pay_at_property"]}}},{"type":"object","description":"The property charges a deposit before arrival. `amount` is present once the rate has been\nprice-checked; at search time it may be `None` (the deposit is known to be required but\nthe exact sum has not been confirmed yet).","required":["type"],"properties":{"amount":{"type":["string","null"],"example":"150.00"},"type":{"type":"string","enum":["deposit"]}}},{"type":"object","description":"The full stay price is charged to the card at booking time.","required":["type"],"properties":{"type":{"type":"string","enum":["prepay"]}}}],"description":"How the property collects payment from the guest."},"PlaceAutocompleteResponse":{"type":"object","required":["results"],"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/PlaceSuggestion"}}}},"PlaceSuggestion":{"type":"object","description":"One autocomplete result, carrying everything `POST /api/v1/hotel/search` needs.","required":["name","kind","country_code","country_name","label","latitude","longitude","search_radius_km"],"properties":{"country_code":{"type":"string","description":"ISO 3166-1 alpha-2.","example":"FR"},"country_name":{"type":"string","example":"France"},"iata_city_code":{"type":["string","null"],"description":"IATA city code, where one exists. Only settlements carry one.","example":"PAR"},"iata_code":{"type":["string","null"],"description":"Set only on an airport."},"id":{"type":["integer","null"],"format":"int64","description":"Stable place id, safe to store. Absent for an airport, which `iata_code` identifies instead.","example":2988507},"kind":{"type":"string","description":"`city`, `island` or `region`, and `airport` when asked for. Islands and regions cover\nground rather than sitting at a point, so they carry a wider search radius.","example":"city"},"label":{"type":"string","description":"Ready to render in a dropdown: the place, its region and its country.","example":"Paris, Île-de-France, France"},"latitude":{"type":"number","format":"double","description":"Where to search. Feed straight into a hotel search.","example":48.85341},"longitude":{"type":"number","format":"double","example":2.3488},"name":{"type":"string","description":"The place's name in the requested language, falling back to its local name.","example":"Paris"},"population":{"type":["integer","null"],"format":"int64","description":"Absent for an airport.","example":2138551},"region":{"type":["string","null"],"description":"First-level administrative division — state, region, province.","example":"Île-de-France"},"search_radius_km":{"type":"number","format":"float","description":"The radius, in kilometres, that a hotel search around this point should use.","example":19.9},"timezone":{"type":["string","null"],"description":"IANA time zone.","example":"Europe/Paris"}}},"PlanDaysRequest":{"type":"object","required":["dates"],"properties":{"dates":{"type":"array","items":{"type":"string"},"example":["2026-11-03","2026-11-04"]},"exclude_place_ids":{"type":"array","items":{"type":"string"},"description":"`place_id`s to leave out."}}},"Price":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"string"},"currency":{"type":"string"}}},"PriceLine":{"type":"object","description":"One priced item of an offer, or an extra on top of a structured one.","required":["description","amount"],"properties":{"amount":{"type":"string"},"description":{"type":"string"}}},"PricingDetails":{"type":"object","required":["min_price","max_price","currency"],"properties":{"currency":{"type":"string"},"max_price":{"type":"string"},"min_price":{"type":"string"}}},"QuoteBookingEntry":{"type":"object","description":"A group or custom request an agent booked with the supplier by hand.","required":["id","request_id","kind","title","summary","status","total_amount","amount_paid","currency","covered_booking_ids"],"properties":{"amount_paid":{"type":"string","description":"What was paid when the offer was accepted: a deposit, or the total."},"booked_at":{"type":["string","null"],"format":"date-time"},"confirmation":{"type":["string","null"],"description":"The supplier's reference."},"covered_booking_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"For travel insurance: the `id`s of the `bookings` it covers."},"currency":{"type":"string"},"id":{"type":"string","format":"uuid"},"kind":{"$ref":"#/components/schemas/QuoteKind"},"request_id":{"type":"string","format":"uuid","description":"The request on `GET /api/v1/quote-requests/{id}`."},"status":{"$ref":"#/components/schemas/ReservationStatus"},"summary":{"type":"string","description":"The offer's lines in one sentence."},"supplier":{"type":["string","null"]},"title":{"type":"string"},"total_amount":{"type":"string"}}},"QuoteKind":{"type":"string","description":"What a request is for. Each kind brings its own brief and offer lines; the tables are shared.","enum":["custom","hotel_block","insurance"]},"QuoteMessageRequest":{"type":"object","required":["body"],"properties":{"body":{"type":"string"}}},"QuoteOfferLines":{"oneOf":[{"allOf":[{"$ref":"#/components/schemas/CustomLines"},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["custom"]}}}],"title":"custom"},{"allOf":[{"$ref":"#/components/schemas/HotelBlockLines"},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hotel_block"]}}}],"title":"hotel_block"},{"allOf":[{"$ref":"#/components/schemas/InsuranceLines"},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["insurance"]}}}],"title":"insurance"}],"description":"What an offer is made of, priced line by line.","discriminator":{"propertyName":"kind","mapping":{"custom":"#/components/schemas/CustomLines","hotel_block":"#/components/schemas/HotelBlockLines","insurance":"#/components/schemas/InsuranceLines"}}},"QuoteOfferStatus":{"type":"string","enum":["draft","published","accepted","declined","withdrawn","expired"]},"QuotePayment":{"type":"object","description":"Where the customer pays for an accepted offer.","required":["booking_id","amount_due_now","currency"],"properties":{"amount_due_now":{"type":"string"},"booking_id":{"type":"string","format":"uuid"},"client_secret":{"type":["string","null"],"description":"The Stripe payment to confirm on the portal's own card form instead of the page; none when nothing is due now."},"currency":{"type":"string"},"payment_url":{"type":["string","null"],"description":"The page that takes the card; none when nothing is due now."}}},"QuoteRequestDetails":{"oneOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["custom"]}}},{"allOf":[{"$ref":"#/components/schemas/HotelBlockBrief"},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hotel_block"]}}}]},{"allOf":[{"$ref":"#/components/schemas/InsuranceBrief"},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["insurance"]}}}]}],"description":"The kind-specific part of a customer's brief."},"QuoteRequestListItem":{"type":"object","required":["id","kind","status","title","brief","offers","created_at","updated_at"],"properties":{"brief":{"type":"string","description":"Dates, party size and place in one line."},"created_at":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"kind":{"$ref":"#/components/schemas/QuoteKind"},"offers":{"type":"integer","format":"int64","description":"Offers the customer can see."},"status":{"$ref":"#/components/schemas/QuoteRequestStatus"},"title":{"type":"string"},"updated_at":{"type":"string","format":"date-time"}}},"QuoteRequestStatus":{"type":"string","enum":["submitted","in_progress","awaiting_customer","offers_available","accepted","fulfilling","booked","cancelled","closed"]},"QuoteRequestsResponse":{"type":"object","required":["requests"],"properties":{"requests":{"type":"array","items":{"$ref":"#/components/schemas/QuoteRequestListItem"},"description":"Newest first."}}},"QuoteTimelineEntry":{"type":"object","required":["actor","kind","body","created_at"],"properties":{"actor":{"type":"string","description":"`customer`, `agent` or `system`."},"body":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"kind":{"type":"string","description":"`message`, `status_change`, `offer_published`, ..."}}},"Refund":{"type":"object","description":"Whether the airline permits it, and what it charges.","required":["allowed"],"properties":{"allowed":{"type":"boolean"},"penalty_amount":{"type":["string","null"],"description":"Fee charged for it. `null` when the airline quotes no fixed amount up front.","example":"100.00"},"penalty_currency":{"type":["string","null"],"description":"ISO 4217 code of `penalty_amount`.","example":"USD"}}},"ReorderDayRequest":{"type":"object","required":["place_ids"],"properties":{"place_ids":{"type":"array","items":{"type":"string"},"description":"Every `place_id` of the day's plan, in the order to visit them.","example":["516428","517515","517712"]}}},"ReplacementRequest":{"type":"object","description":"An offer to book instead of the flight, hotel or car that failed.","required":["offer_id"],"properties":{"offer_id":{"type":"string","description":"A flight `offers[].id`, a hotel `hotels[].offers[].offer_id` or a car `offers[].offer_id`.","example":"off_0000AbCdEf"},"search_id":{"type":["string","null"],"description":"For a flight, `search_id` of the similar-offers (or any flight search) response the offer\ncame from. Left out for a hotel or a car: their offers are found by id alone.","example":"b1f0c3a2-6d4e-4a7b-9c21-3e5f7a9d0b14"}}},"RequiredInput":{"oneOf":[{"type":"object","description":"The provider repriced the item. Resume with `confirmed_price` set to `new` to accept it.","required":["old","new","currency","type"],"properties":{"currency":{"type":"string"},"new":{"type":"string"},"old":{"type":"string"},"old_currency":{"type":["string","null"],"description":"Set when `old` was quoted in another currency than `currency`."},"type":{"type":"string","enum":["price_confirmation"]}}},{"type":"object","description":"Passenger or guest details are missing. Fill them in through the booking's own endpoint,\nthen resume.","required":["missing","type"],"properties":{"missing":{"type":"array","items":{"type":"string"}},"type":{"type":"string","enum":["traveller_details"]}}},{"type":"object","description":"The provider takes payment on its own page. Open this, pay, then poll again.","required":["payment_url","type"],"properties":{"payment_url":{"type":"string"},"type":{"type":"string","enum":["hosted_payment"]}}},{"type":"object","description":"The item is charged from a card and the run holds none for it, or the bank refused the\none it had. Resume with a card for it.","required":["type"],"properties":{"type":{"type":"string","enum":["payment_method"]}}},{"type":"object","description":"The cardholder has to confirm these charges with their bank before anything is booked.\nRun each session with `provider`'s browser SDK, then resume with the same cards.","required":["provider","sessions","type"],"properties":{"provider":{"type":"string"},"sessions":{"type":"array","items":{"$ref":"#/components/schemas/CardAuthenticationSession"}},"type":{"type":"string","enum":["card_authentication"]}}}],"description":"What the run needs before it can go on. The only place a payment URL is ever handed out."},"ReservationStatus":{"type":"string","description":"Where a booking stands. Only `pending` and `prepared` are in the cart; the rest have left it.","enum":["pending","prepared","booked","cancelled","abandoned"]},"ResumeProcessingRequest":{"type":"object","properties":{"confirmed_price":{"type":["string","null"],"description":"Accepts the new total a `price_confirmation` pause reported."},"payment_method":{"$ref":"#/components/schemas/PaymentMethodRequest","description":"Required whenever an item ahead still has to be charged - the card never survives a pause."},"payments":{"type":"array","items":{"$ref":"#/components/schemas/ItemsPaymentRequest"},"description":"Cards for particular items, as on start."},"replace_with":{"$ref":"#/components/schemas/ReplacementRequest","description":"Books this offer in place of the flight, hotel or car the run failed on, in the same checkout,\nand carries on. Take it from the `similar-offers` search of the failed booking."},"run_id":{"type":["string","null"],"format":"uuid","description":"The run being resumed, from a previous snapshot. Rejected when the run has moved on."},"skip_item":{"type":"boolean","description":"Abandons the blocking item and carries on with the rest of the cart."}}},"RoomNeed":{"type":"object","required":["room_type","count"],"properties":{"count":{"type":"integer","format":"int32","minimum":0},"room_type":{"type":"string"}}},"RoomOccupancy":{"type":"object","description":"One physical room and the party sleeping in it.","required":["adults","children","children_ages"],"properties":{"adults":{"type":"integer","format":"int32","description":"Adults sharing this room; at least one.","example":2,"minimum":1},"children":{"type":"integer","format":"int32","description":"Children sharing this room. Rates are derived from `children_ages`, so send one age there\nfor every child counted here.","example":0,"minimum":0},"children_ages":{"type":"array","items":{"type":"integer","format":"int32","minimum":0},"description":"Age at check-in of each child in this room, one entry per child. Empty when there are none.","example":[]}}},"RoomOffer":{"type":"object","description":"One room within an offer.","required":["room_type","rate_plan","pricing","cancellation_policy","room_amenities","room_images","capacity","adults","bedding"],"properties":{"adults":{"type":"integer","format":"int32","description":"adults number comes from search request","minimum":0},"area_sqft":{"type":["integer","null"],"format":"int32","description":"Room size in square feet, when published.","minimum":0},"bedding":{"type":"string","description":"Bed configuration as described by the provider, e.g. `1 king bed`.","example":"1 king bed"},"cancellation_policy":{"$ref":"#/components/schemas/CancellationPolicy"},"capacity":{"type":"integer","format":"int32","description":"Maximum number of guests the room sleeps.","example":2,"minimum":0},"children_ages":{"type":["array","null"],"items":{"type":"integer","format":"int32","minimum":0},"description":"childrean ages comes from search request"},"description":{"type":["string","null"]},"flags":{"type":["integer","null"],"format":"int32","description":"Bitmask of board and lounge benefits for this room, read the same way as the offer's own\n`flags`: `1` breakfast, `2` lunch, `4` dinner, `8` all-inclusive, `16` lounge access."},"negotiated_rate":{"$ref":"#/components/schemas/NegotiatedRate","description":"Set when one of the tenant's negotiated codes unlocked this rate."},"pricing":{"$ref":"#/components/schemas/PricingDetails"},"rate_plan":{"type":"string","description":"Commercial terms attached to the room, e.g. `Bed & Breakfast`.","example":"Bed & Breakfast"},"room_amenities":{"type":"array","items":{"type":"string"},"description":"Free-text amenity labels for the room itself."},"room_id":{"type":["string","null"],"description":"Room identifier. Rooms sharing an id and view are the same product, which is how\nidentical rooms are grouped for display."},"room_images":{"type":"array","items":{"type":"string"},"description":"Photo URLs of this room."},"room_type":{"type":"string","description":"Room name as sold, e.g. `Deluxe King`.","example":"Deluxe King"},"view":{"type":["string","null"],"description":"View the room faces, when published."}}},"RoomOffers":{"type":"object","description":"One bookable offer: every room of the requested party, priced together.","required":["offer_id","checkin","checkout","rooms","pricing","cancellation_policy"],"properties":{"cancellation_policy":{"$ref":"#/components/schemas/CancellationPolicy","description":"Cancellation rules, ordered by `from` in the property's timezone."},"checkin":{"type":"string","format":"date","description":"First night of the stay."},"checkout":{"type":"string","format":"date","description":"Departure day, exclusive."},"flags":{"type":["integer","null"],"format":"int32","description":"Bitmask of board and lounge benefits: `1` breakfast, `2` lunch, `4` dinner,\n`8` all-inclusive, `16` lounge access. Test single bits — all-inclusive does not set the\nindividual meal bits, and lounge access combines with them. `0` means room only; `null`\nmeans the provider said nothing about board, which is not the same as \"no meals\".","example":1},"offer_id":{"type":"string","format":"uuid","description":"Handle for the rest of the funnel — hotel rates and offer selection. Search-scoped: re-shop\nrather than storing it long term."},"payment_policy":{"oneOf":[{"type":"object","description":"The guest pays nothing upfront. The card is held as a guarantee against no-show or late\ncancellation; the property collects the full amount at check-in or check-out.","required":["type"],"properties":{"type":{"type":"string","enum":["pay_at_property"]}}},{"type":"object","description":"The property charges a deposit before arrival. `amount` is present once the rate has been\nprice-checked; at search time it may be `None` (the deposit is known to be required but\nthe exact sum has not been confirmed yet).","required":["type"],"properties":{"amount":{"type":["string","null"],"example":"150.00"},"type":{"type":"string","enum":["deposit"]}}},{"type":"object","description":"The full stay price is charged to the card at booking time.","required":["type"],"properties":{"type":{"type":"string","enum":["prepay"]}}}],"description":"How the property collects payment. `None` means the provider did not specify."},"pricing":{"$ref":"#/components/schemas/PricingDetails","description":"All-in price of the whole stay for all rooms."},"rooms":{"type":"array","items":{"$ref":"#/components/schemas/RoomOffer"},"description":"The rooms this offer covers, one entry per requested room."}}},"RoomOffersExt":{"allOf":[{"$ref":"#/components/schemas/RoomOffers"},{"type":"object","required":["free_cancellation"],"properties":{"cancellation_policy_description":{"type":["string","null"],"description":"Ready-to-render summary of `cancellation_policy`, in the requested language."},"free_cancellation":{"type":"boolean","description":"The offer still has a free-cancellation window open."},"similarity":{"$ref":"#/components/schemas/HotelOfferSimilarity","description":"How the offer compares with a booked one. Only set by similar-offer search."}}}],"description":"A bookable offer plus cancellation fields derived for display. Serialised flat."},"RouteType":{"type":"string","description":"Whether an itinerary crosses a border, which decides if a passport is required.","enum":["domestic","international"]},"SeatAssignment":{"type":"object","description":"One passenger's seat on one segment, or on one leg of a segment that changes aircraft.","required":["segment","passenger_index","designator","amount","offer_id","status","updated_at"],"properties":{"amount":{"type":"string","description":"Zero for a free seat.","example":"25.00"},"characteristics":{"type":"array","items":{"type":"string"}},"designator":{"type":"string","example":"12A"},"emd_number":{"type":["string","null"],"description":"The EMD that paid for the seat. Only paid seats get one.","example":"1151234567890"},"leg":{"$ref":"#/components/schemas/SeatMapLeg"},"offer_id":{"type":"string","description":"The signed seat offer this was picked with; carries what buying the seat needs."},"passenger_index":{"type":"integer","description":"Zero-based position of the passenger in the booking.","minimum":0},"provider_status_code":{"type":["string","null"],"description":"The airline's own status code, e.g. `HK` or `UC`.","example":"HK"},"segment":{"$ref":"#/components/schemas/SeatMapSegmentRef"},"status":{"$ref":"#/components/schemas/SeatAssignmentStatus"},"updated_at":{"type":"string","format":"date-time"}}},"SeatAssignmentStatus":{"type":"string","enum":["selected","requested","confirmed","rejected"]},"SeatAvailability":{"type":"string","enum":["available","occupied","restricted","no_seat"]},"SeatColumnPosition":{"type":"string","enum":["window","center","aisle"]},"SeatMapCabin":{"type":"object","description":"One cabin compartment of the aircraft.","required":["deck","first_row","last_row","columns","rows"],"properties":{"cabin_class":{"type":["string","null"],"description":"Cabin a fare is sold in.","enum":["economy","premium_economy","business","first",null]},"columns":{"type":"array","items":{"$ref":"#/components/schemas/SeatMapColumn"},"description":"Columns left to right. An aisle runs between two neighbouring `aisle` columns."},"deck":{"$ref":"#/components/schemas/SeatMapDeck"},"first_row":{"type":"integer","format":"int32"},"last_row":{"type":"integer","format":"int32"},"name":{"type":["string","null"],"description":"Airline's own name for the cabin.","example":"Economy"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/SeatMapRow"}}}},"SeatMapColumn":{"type":"object","required":["id","position"],"properties":{"id":{"type":"string","example":"A"},"position":{"$ref":"#/components/schemas/SeatColumnPosition"}}},"SeatMapDeck":{"type":"string","enum":["main","upper","lower"]},"SeatMapFacility":{"type":"object","required":["kind"],"properties":{"columns":{"type":"array","items":{"type":"string"},"description":"Columns the facility takes up. Empty when the provider does not say."},"kind":{"type":"string","description":"Known values: `lavatory`, `galley`, `closet`, `stairs`, `bar`, `storage`. Anything else\nis the provider's own code passed through.","example":"lavatory"},"position":{"type":["string","null"],"description":"Where across the cabin width a facility sits.","enum":["left","left_center","center","right_center","right",null]}}},"SeatMapLeg":{"type":"object","required":["origin","destination"],"properties":{"destination":{"type":"string","example":"JFK"},"origin":{"type":"string","example":"LHR"}}},"SeatMapRow":{"type":"object","required":["number","seats"],"properties":{"characteristics":{"type":"array","items":{"type":"string"},"description":"Known values: `exit_row`, `overwing`, `extra_legroom`, `bulkhead`. Anything else is the\nprovider's own code passed through."},"facilities":{"type":"array","items":{"$ref":"#/components/schemas/SeatMapFacility"},"description":"Lavatories, galleys and the like that sit in this row instead of seats."},"number":{"type":"integer","format":"int32"},"seats":{"type":"array","items":{"$ref":"#/components/schemas/SeatMapSeat"}}}},"SeatMapSeat":{"type":"object","required":["designator","column","availability"],"properties":{"availability":{"$ref":"#/components/schemas/SeatAvailability"},"characteristics":{"type":"array","items":{"type":"string"},"description":"Known values: `window`, `aisle`, `center`, `exit_row`, `extra_legroom`, `bassinet`,\n`bulkhead`, `preferred`, `chargeable`, `restricted_recline`, `no_infant`,\n`infant_allowed`, `handicapped`, `rear_facing`, `overwing`. Anything else is the\nprovider's own code passed through."},"column":{"type":"string","example":"A"},"designator":{"type":"string","example":"12A"},"prices":{"type":"array","items":{"$ref":"#/components/schemas/SeatPrice"},"description":"One entry per passenger the seat is offered to; a passenger can pick it only through\ntheir entry's `offer_id`. Free seats have an `amount` of `0`."}}},"SeatMapSegmentRef":{"type":"object","description":"Points back at a segment of the booked offer. Segments carry no id of their own, so the\nslice and segment positions are the key and the rest is there to read it at a glance.","required":["slice_index","segment_index","origin","destination","marketing_carrier","flight_number","departing_at"],"properties":{"departing_at":{"type":"string","format":"date-time","description":"Local time at `origin`, without an offset.","example":"2026-11-05T10:00:00"},"destination":{"type":"string","example":"JFK"},"flight_number":{"type":"string","example":"117"},"marketing_carrier":{"type":"string","description":"IATA code of the marketing carrier.","example":"BA"},"origin":{"type":"string","example":"LHR"},"segment_index":{"type":"integer","description":"Zero-based position of the segment within its slice.","minimum":0},"slice_index":{"type":"integer","description":"Zero-based position of the slice in the offer.","minimum":0}}},"SeatPrice":{"type":"object","description":"What one passenger pays for a seat.","required":["passenger_index","amount","currency","offer_id"],"properties":{"amount":{"type":"string","example":"25.00"},"currency":{"type":"string","example":"USD"},"offer_id":{"type":"string","description":"Signed handle naming this seat for this passenger at this price; what seat assignment takes."},"passenger_index":{"type":"integer","description":"Zero-based position of the passenger in the booking.","minimum":0}}},"SeatRequest":{"type":"object","description":"A seat picked off the seat map.","required":["offer_id"],"properties":{"offer_id":{"type":"string","description":"The seat map price's `offer_id` for this seat and passenger.","example":"k1.eyJiIjoiOWQyZjRjODEtM2FiNy00ZTA1LThjMTktNmY3YTBiM2Q1ZTIxIn0"}}},"Seats":{"type":"object","properties":{"high_seat":{"type":["string","null"]},"low_seat":{"type":["string","null"]},"row":{"type":["string","null"]},"section":{"type":["string","null"]}}},"SegmentSeatMap":{"type":"object","description":"Seat map of one booked flight segment.","required":["segment","cabins"],"properties":{"cabins":{"type":"array","items":{"$ref":"#/components/schemas/SeatMapCabin"}},"leg":{"$ref":"#/components/schemas/SeatMapLeg","description":"Set only when the segment changes aircraft mid-way and this map covers one leg of it."},"segment":{"$ref":"#/components/schemas/SeatMapSegmentRef"}}},"SendChatMessageRequest":{"type":"object","description":"What the traveller typed into the web chat.","required":["text"],"properties":{"text":{"type":"string","description":"The message, as typed. Trailing whitespace is trimmed and an empty message is rejected.","example":"Find me a hotel in Lisbon for the first week of May"}}},"SetTravelerLoyaltyRequest":{"type":"object","required":["loyalty_ids"],"properties":{"loyalty_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"The memberships to attach, from the traveller's `eligible_loyalty`, most preferred first. Empty attaches none.\nA hotel stay or a rental takes at most one."}}},"ShortlistedHotel":{"type":"object","description":"A hotel the customer would like the block at, picked from the catalog.","required":["id","name"],"properties":{"address":{"type":["string","null"]},"description":{"type":["string","null"],"description":"What the catalog says about it, as plain text."},"id":{"type":"string","description":"The catalog's id, which an offer for this hotel names."},"image":{"type":["string","null"]},"images":{"type":"array","items":{"type":"string"},"description":"The catalog's photos, best first; `image` is the first of them."},"name":{"type":"string"},"stars":{"type":["integer","null"],"format":"int32","minimum":0}}},"SliceSimilarity":{"type":"object","description":"How one leg compares with the same leg of the reference offer.","required":["score","match_level","departure_shift_minutes","arrival_shift_minutes","differences"],"properties":{"arrival_shift_minutes":{"type":"integer","format":"int64","description":"Minutes the final arrival moved, negative when earlier.","example":30},"departure_shift_minutes":{"type":"integer","format":"int64","description":"Minutes the first departure moved, negative when earlier.","example":45},"differences":{"type":"array","items":{"$ref":"#/components/schemas/Difference"},"description":"Empty when the leg is identical."},"match_level":{"$ref":"#/components/schemas/MatchLevel"},"score":{"type":"integer","format":"int32","description":"0 to 100, higher is closer.","example":87,"minimum":0}}},"StartProcessingRequest":{"type":"object","properties":{"insurance":{"$ref":"#/components/schemas/InsuranceOptIn","description":"Travel insurance to ask an agent for once the cart is booked."},"language":{"type":["string","null"],"description":"Language for anything the traveller is sent while the run works. Defaults to `en`.","example":"en"},"payment_method":{"$ref":"#/components/schemas/PaymentMethodRequest","description":"The card for every item `payments` does not name."},"payments":{"type":"array","items":{"$ref":"#/components/schemas/ItemsPaymentRequest"},"description":"Cards for particular items, when the traveller splits the cart across cards."}}},"Stop":{"type":"object","description":"A technical stop: the aircraft lands but the flight number does not change, so it is not a\nconnection and nobody changes planes.","required":["arriving_at","departing_at","airport"],"properties":{"airport":{"type":"string","description":"IATA code of the airport stopped at."},"arriving_at":{"type":"string","format":"date-time"},"departing_at":{"type":"string","format":"date-time"},"duration":{"type":["integer","null"],"format":"int32","description":"Time on the ground, in minutes."}}},"SuccessResponse":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","example":true}}},"Tax":{"type":"object","description":"A single tax or fee line.","required":["tax_type","amount","mandatory","description","included_in_price"],"properties":{"amount":{"type":"string","description":"Charge in the offer's currency.","example":"112.35"},"description":{"type":"string","description":"Human readable label; may be empty, in which case fall back to a generic \"Tax & Fee\"."},"included_in_price":{"type":"boolean","description":"`true` when the charge is already inside `total`, `false` when it is collected at the\nproperty on top of it."},"mandatory":{"type":"boolean","description":"The guest cannot opt out of this charge."},"percentage":{"type":["string","null"],"description":"Rate the charge was computed at, when the provider expresses it as a percentage."},"tax_type":{"type":"string","description":"Provider's classification of the charge, e.g. `VAT` or `CITY_TAX`.","example":"VAT"}}},"Transfer":{"type":"object","required":["mode","distance_meters","duration_minutes","starts_at"],"properties":{"distance_meters":{"type":"integer","format":"int32","minimum":0},"duration_minutes":{"type":"integer","format":"int32","minimum":0},"mode":{"$ref":"#/components/schemas/TransferMode"},"path":{"type":"array","items":{"$ref":"#/components/schemas/GeoLocation"},"description":"The way along the road, for drawing. Empty when unknown."},"starts_at":{"type":"string","example":"12:25:00"}}},"TransferMode":{"type":"string","enum":["walk","taxi"]},"Transmission":{"type":"string","enum":["Manual","Automatic"]},"TravelerRole":{"type":"string","description":"What a traveller is to their booking. `Guest` and `Passenger` are the same standing as each\nother, named as hotels and airlines name them.","enum":["lead","guest","passenger"]},"TripDay":{"type":"object","description":"One calendar day spent at a hotel in the cart.","required":["date","hotel_booking_id","hotel_name","hotel_location","fixed","covered","plannable"],"properties":{"city":{"type":["string","null"]},"covered":{"type":"boolean","description":"Whether the city guide knows the hotel's city."},"date":{"type":"string","format":"date"},"fixed":{"type":"array","items":{"$ref":"#/components/schemas/FixedItem"},"description":"What is already set for the day."},"hotel_booking_id":{"type":"string","format":"uuid","description":"The hotel booking the day is spent from."},"hotel_location":{"$ref":"#/components/schemas/GeoLocation"},"hotel_name":{"type":"string"},"plan":{"$ref":"#/components/schemas/DayPlan"},"plannable":{"type":"boolean","description":"Whether a plan can be requested for the day."},"window":{"$ref":"#/components/schemas/DayWindow","description":"Local time left free for sightseeing. Absent when the day has none."}}},"TripDays":{"type":"object","description":"The days of a cart's trip.","required":["days"],"properties":{"days":{"type":"array","items":{"$ref":"#/components/schemas/TripDay"}}}},"TripHelp":{"type":"object","description":"A storefront trip's request and its thread, read by the traveller and by the agency.","required":["id","status","subject","created_at","messages"],"properties":{"created_at":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/TripHelpMessage"},"description":"Oldest first."},"status":{"type":"string","description":"`open` waits on the agency, `answered` on the traveller, `closed` on nobody.","example":"open"},"subject":{"type":"string"}}},"TripHelpMessage":{"type":"object","required":["id","body","from_agency","created_at"],"properties":{"body":{"type":"string","description":"What was written; on a system line, what it is about."},"created_at":{"type":"string","format":"date-time"},"from_agency":{"type":"boolean","description":"Written by someone of the agency."},"id":{"type":"string","format":"uuid"},"note":{"type":["string","null"],"description":"Set on a line the system wrote, to be worded by the app: `payment_unconfirmed` says `body` was paid for and\nits provider never confirmed it."}}},"TripPurpose":{"type":"string","enum":["leisure","business","study","cruise","expat","other"]},"UpdateCartRequest":{"type":"object","properties":{"current":{"type":["boolean","null"],"description":"Set to `true` to make this the traveller's current cart."},"title":{"type":["string","null"],"description":"New title. Send `null` to clear it; omit the field to leave it alone.","example":"Rome in May"}}},"UpdateCompanionRequest":{"type":"object","description":"Every field is optional: omitting one leaves it as stored. The fields that can hold nothing\nalso accept an explicit `null`, which clears them.","properties":{"dob":{"type":["string","null"],"format":"date","example":"1990-12-10"},"document":{"$ref":"#/components/schemas/PassengerDocument"},"email":{"type":["string","null"],"example":"ada@example.com"},"first_name":{"type":["string","null"],"example":"Ada"},"gender":{"type":["string","null"],"enum":["male","female",null]},"is_self":{"type":["boolean","null"]},"last_name":{"type":["string","null"],"example":"Lovelace"},"middle_name":{"type":["string","null"]},"nationality":{"type":["string","null"],"example":"GB"},"phone":{"type":["string","null"],"example":"+1 415 555 0134"}}},"UpdateLoyaltyRequest":{"type":"object","description":"Every field is optional: omitting one leaves it as stored.","properties":{"number":{"type":["string","null"],"example":"AB123456"},"priority":{"type":["integer","null"],"format":"int32","example":1}}},"VehicleClassification":{"type":"object","description":"Decoded 4-letter ACRISS (SIPP) vehicle code, e.g. `ECAR` = Economy, 2/4 door, automatic, AC.\nLetters outside the ACRISS tables decode to `None` rather than failing the whole code.","required":["code"],"properties":{"air_conditioning":{"type":["boolean","null"]},"body_type":{"type":["string","null"],"enum":["TwoThreeDoor","TwoFourDoor","FourFiveDoor","Wagon","PassengerVan","Limousine","Sport","Convertible","Suv","OpenAirAllTerrain","Special","PickupRegularCab","PickupExtendedCab","SpecialOffer","Coupe","Monospace","RecreationalVehicle","MotorHome","TwoWheelVehicle","Roadster","Crossover","CommercialVan",null]},"category":{"type":["string","null"],"enum":["Mini","MiniElite","Economy","EconomyElite","Compact","CompactElite","Intermediate","IntermediateElite","Standard","StandardElite","Fullsize","FullsizeElite","Premium","PremiumElite","Luxury","LuxuryElite","Oversize","Special",null]},"code":{"type":"string","example":"ECAR"},"drive":{"type":["string","null"],"enum":["Unspecified","FourWheel","AllWheel",null]},"fuel":{"type":["string","null"],"enum":["Unspecified","Diesel","Hybrid","Electric","Lpg","Hydrogen","MultiFuel","Petrol","Ethanol",null]},"transmission":{"type":["string","null"],"enum":["Manual","Automatic",null]}}},"ViaPlace":{"type":"object","description":"The place a suggestion was reached through, when it was not matched directly.","required":["geoname_id","name","distance_km"],"properties":{"distance_km":{"type":"number","format":"float","description":"Great-circle kilometres from the place to the airport.","example":84.5},"geoname_id":{"type":"integer","format":"int64","description":"Place id, the same one `/api/v1/place/autocomplete` returns.","example":2775220},"name":{"type":"string","example":"Ischgl"}}},"WebChatAction":{"oneOf":[{"allOf":[{"$ref":"#/components/schemas/HotelSearchAction"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["hotel_search"]}}}],"title":"hotel_search"},{"allOf":[{"$ref":"#/components/schemas/FlightSearchAction"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["flight_search"]}}}],"title":"flight_search"},{"allOf":[{"$ref":"#/components/schemas/CarSearchAction"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["car_search"]}}}],"title":"car_search"},{"allOf":[{"$ref":"#/components/schemas/EventSearchAction"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["event_search"]}}}],"title":"event_search"}],"description":"What a web client should put on screen after the assistant searched something for it.","discriminator":{"propertyName":"type","mapping":{"car_search":"#/components/schemas/CarSearchAction","event_search":"#/components/schemas/EventSearchAction","flight_search":"#/components/schemas/FlightSearchAction","hotel_search":"#/components/schemas/HotelSearchAction"}}}},"securitySchemes":{"app_id":{"type":"apiKey","in":"header","name":"X-App-Id","description":"UUID of the client application, issued when your integration is registered."},"bearer_auth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"RS256 JWT identifying the end user, sent as `Authorization: Bearer <token>`."}}},"tags":[{"name":"Place","description":"Place lookup for choosing where to search"},{"name":"Airport","description":"Airport and city lookup for choosing where to fly"},{"name":"Airline","description":"Airline lookup by name or IATA code"},{"name":"Currency","description":"Reference exchange rates for showing amounts in another currency"},{"name":"Hotel","description":"Hotel search, rates, booking and cancellation"},{"name":"Flight","description":"Flight search, booking and cancellation"},{"name":"Car","description":"Car rental branch lookup, availability search and selection"},{"name":"Event","description":"Event search, ticket listings, selection and delivery"},{"name":"Insurance","description":"Travel insurance quotes"},{"name":"Cart","description":"Selected offers held for checkout"},{"name":"Cart Processing","description":"Booking every reservation in a cart"},{"name":"Day Plan","description":"Sightseeing plans for the days of a trip"},{"name":"Bookings","description":"Reservations the traveller has settled"},{"name":"Quote Requests","description":"Group, custom and travel insurance requests an agent quotes and books by hand"},{"name":"Chat","description":"Conversation with the travel assistant"},{"name":"Companion","description":"Saved travellers to book for"},{"name":"Loyalty","description":"Frequent flyer, hotel and car rental memberships of saved travellers"},{"name":"Travelers","description":"Assignment of saved travellers to cart items"}]}