Skip to Content
OpenRoam Docs
Flights

Get a flight seat map

Returns the seat map of a flight offer, with the seats each passenger can take and their prices.

GET
/v1/flights/offers/{publicId}/seat-map

Returns the seat map of a flight offer, with the seats each passenger can take and their prices.

The seat map is read from the airline on each call, so availability can change between calls; prices are in the API key's currency. isSupported is false when the airline offers no seat selection for the offer. Segments are named by sliceIndex and segmentIndex, their 1-based position in the offer; a segment without a seat map is left out. A seat can be booked only for the passengers in its availableFor. Send chosen seats in the order's inputs.passengers[].selectedSeats, one per passenger per segment. An unknown, expired or another partner's publicId returns 400 / 11004.

Authorization

PartnerApiKey
headerX-Partner-Key<token>

Partner API Key (X-Partner-Key)

Path Parameters

publicId*string

An offer or fare option publicId from search or quote.

Response Body

OK

  1. response

Partner seat map. Segments name their position in the offer; seats are chosen by sliceIndex, segmentIndex, passengerIndex and seatDesignator.

isSupported*boolean
segments*array<>
warnings*array<string>
Example Request
curl -X GET 'https://api.sandbox.openroam.com/v1/flights/offers/string/seat-map'
Example Response
{  "isSupported": true,  "segments": [    {      "sliceIndex": 0,      "segmentIndex": 0,      "cabinClass": "economy",      "deck": 0,      "aisles": [        0      ],      "rows": [        {          "number": 0,          "sections": [            {              "elements": [                {                  "type": "string",                  "seatDesignator": "string",                  "label": "string",                  "isAvailable": true,                  "characteristics": [                    "string"                  ],                  "availableFor": [                    {                      "passengerIndex": 0,                      "price": {                        "amount": 0,                        "currency": "string"                      }                    }                  ]                }              ]            }          ]        }      ]    }  ],  "warnings": [    "string"  ]}

Order flights POST

Places and pays for flight bookings, one fare per item. Takes the same body as quote, with `inputs` required. Requires an `Idempotency-Key` header (a new UUID per purchase) and an API key with order-manage permission. Repeating the same request with the same key returns the original order; while the first request is still running the response is 409 / 12002 with `Retry-After`, after which you send the same request again. The order is paid from your wallet balance and ticketing completes asynchronously: track it with `GET /orders/{id}` or the `order.fulfillment.updated` webhook. `publicId` is a fare's `publicId` from search, or one that a quote returned. `inputs.passengers` lists every passenger of the fare exactly once, in `passengerIndex` order 1 to N, optionally with seats in `selectedSeats`; paid baggage and other services go in `inputs.selectedServices`. Seats and services are checked against the airline's current offer and seat map, and their prices are added to the item's price. Each item is priced again with the airline before payment, and the price is capped. With the optional `inputs.maxPrice`, in the order currency, a higher price for the item (the fare with its paid extras) gives 409 / 11002 at `items[i].inputs.maxPrice`. Without it, the fare may not cost more than the price returned with the `publicId` (409 / 11002 at `items[i]`), and the order must be in the currency of that price (400 / 11005 at `items[i]`). A `publicId` keeps that price: after 409 / 11002, quote again and order with the `publicId` the quote returns, or send `inputs.maxPrice`. Each item is checked completely before the next one, and the first failure names its item: an invalid input or missing `inputs` gives 400 / 10001 at its path under `items[i]`, for example `items[0].inputs.passengers[0].email`; an unknown, expired or another partner's `publicId` 400 / 11004 at `items[i]`; an offer the airline no longer sells 409 / 11003 at `items[i]`. A wallet charge that fails gives 402 / 16000, with `details[0]` naming `wallet` and `INSUFFICIENT_BALANCE` or `WALLET_BLOCKED`; send the same request with the same key after a top-up. Nothing is created or charged when the order is refused.

Quote flights POST

Prices flight fares again with the airline, without placing an order. Takes the same body as order: `{ currency, referenceId, items[] }` with 1 to 5 items, each `{ publicId, quantity, inputs }` and `quantity` 1. `inputs` may be left out: the quote then prices the fare alone. Inputs that are sent are checked as the order checks them, and their paid extras are added to the price. Prices are in `currency`, or in the API key's currency when it is omitted. Nothing is charged or held. Returns `{ currency, items, total }`. Each item has a new `publicId`: order with it before `details.expiresAt`. It keeps the fare's price, which caps an order without `inputs.maxPrice`. `details` carries the fare's conditions, included baggage and price breakdown, `hasSeatMaps`, the paid extras (`availableServices`) that can be sent in the order's `inputs.selectedServices`, and `fareOptions`: the fares for the same flights and airline, cheapest first and including the quoted one, each with its own `publicId` that can be quoted or ordered. A higher airline price is returned with 200; only `inputs.maxPrice` stops a quote. Each item is checked completely, its inputs, its `publicId` and its price, before the next one, and the first failure names its item: an invalid input or a `quantity` other than 1 gives 400 / 10001 at its path under `items[i]`; a price above `inputs.maxPrice` 409 / 11002 at `items[i].inputs.maxPrice`; an offer the airline no longer sells 409 / 11003 at `items[i]`; an unknown, expired or another partner's `publicId`, or a search itinerary `id`, 400 / 11004 at `items[i]`. An unsupported `currency` gives 400 / 10001 at `currency`.