SeatMap Display

swagger: '2.0'
info:
  version: 1.9.2
  title: Seatmap Display
  x-status: validated
  x-tags:
    - '#online-retail'
    - '#mobile-services'
    - '#ama-for-dev'
  x-release-note:
    '1.9':
      - Add new usbType with a new enum in the PowerAmenity
    '1.8':
      - Add new input parameter seatNumberServiceBookingStatusRequired - **available only in Enterprise**
      - Add new output parameter seatNumberServiceBookingStatus - **available only in Enterprise**
    '1.7':
      - Add new ENUM value for Power Amenity
    '1.6':
      - Add Medias in seat amenity to carry rich content
      - Add field for number of seats available
      - Support flightOrderId as input parameter in GET as replacement for DEPRECATED flight-orderId
    '1.5':
      - Document warnings and new error codes
      - Document new premium seat characteristic (1A_AQC_PREMIUM_SEAT)
    '1.4':
      - Add the Operating flight in the response for codeshare awareness, aligned with flight offer
    '1.3':
      - Add support of Light Ticketing Carrier (LTC) and Extended Air Choice (EAC) as flight offer source - **available only in Enterprise**
    '1.2':
      - Retrieve the Amenities per cabin
    '1.1':
      - Add the posibility to includes traveler information in the display seat map from offer to benefits from discount and FF.
      - Align flight Offer model with Feb-20 release
    '1.0':
      - first version
  description: |-
    Before using this API, we recommend you read our **[Authorization Guide](https://developers.amadeus.com/self-service/apis-docs/guides/authorization-262)** for more information on how to generate an access token. 

    Please also be aware that our test environment is based on a subset of the production, if you are not returning any results try with big cities/airports like LON (London) or NYC (New-York).
host: test.api.amadeus.com
basePath: /v1
schemes:
  - https
consumes:
  - application/vnd.amadeus+json
produces:
  - application/vnd.amadeus+json
paths:
  /shopping/seatmaps:
    get:
      tags:
        - Display SeatMaps
      operationId: getSeatmapFromOrder
      summary: Amadeus Returns All the Seat Maps of a Given Order.
      parameters:
        - $ref: '#/parameters/orderId'
        - $ref: '#/parameters/oldOrderId'
      responses:
        '200':
          $ref: '#/responses/SeatMap'
        '400':
          $ref: '#/responses/400_Order'
        '404':
          $ref: '#/responses/404'
        default:
          $ref: '#/responses/500'
      description: ''
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      tags:
        - Display SeatMaps
      operationId: getSeatmapFromFlightOffer
      summary: Amadeus Returns All the Seat Maps of a Given FlightOffer.
      parameters:
        - $ref: '#/parameters/getOverride'
        - name: body
          in: body
          required: true
          schema:
            title: flightOffers
            required:
              - data
            properties:
              data:
                type: array
                minItems: 1
                maxItems: 6
                items:
                  $ref: '#/definitions/FlightOffer'
              included:
                title: Travelers_map
                properties:
                  travelers:
                    description: Map of travelers
                    additionalProperties:
                      $ref: '#/definitions/Traveler'
            example: &id001
              data:
                - type: flight-offer
                  id: '1'
                  source: GDS
                  instantTicketingRequired: false
                  nonHomogeneous: false
                  oneWay: false
                  lastTicketingDate: '2023-08-01'
                  numberOfBookableSeats: 9
                  itineraries:
                    - duration: PT1H30M
                      segments:
                        - departure:
                            iataCode: NCE
                            terminal: '2'
                            at: '2023-08-01T06:45:00'
                          arrival:
                            iataCode: ORY
                            terminal: '2'
                            at: '2023-08-01T08:15:00'
                          carrierCode: AF
                          number: '6201'
                          aircraft:
                            code: '320'
                          operating:
                            carrierCode: AF
                          duration: PT1H30M
                          id: '1'
                          numberOfStops: 0
                          blacklistedInEU: false
                    - duration: PT1H25M
                      segments:
                        - departure:
                            iataCode: ORY
                            terminal: '3'
                            at: '2023-08-18T06:35:00'
                          arrival:
                            iataCode: NCE
                            terminal: '2'
                            at: '2023-08-18T08:00:00'
                          carrierCode: AF
                          number: '6200'
                          aircraft:
                            code: '320'
                          operating:
                            carrierCode: AF
                          duration: PT1H25M
                          id: '4'
                          numberOfStops: 0
                          blacklistedInEU: false
                  price:
                    currency: EUR
                    total: '274.60'
                    base: '80.00'
                    fees:
                      - amount: '0.00'
                        type: SUPPLIER
                      - amount: '0.00'
                        type: TICKETING
                    grandTotal: '274.60'
                    additionalServices:
                      - amount: '60.00'
                        type: CHECKED_BAGS
                  pricingOptions:
                    fareType:
                      - PUBLISHED
                    includedCheckedBagsOnly: false
                  validatingAirlineCodes:
                    - AF
                  travelerPricings:
                    - travelerId: '1'
                      fareOption: STANDARD
                      travelerType: ADULT
                      price:
                        currency: EUR
                        total: '137.30'
                        base: '40.00'
                      fareDetailsBySegment:
                        - segmentId: '1'
                          cabin: ECONOMY
                          fareBasis: XS50MALG
                          brandedFare: LIGHT
                          class: X
                          includedCheckedBags:
                            quantity: 0
                        - segmentId: '4'
                          cabin: ECONOMY
                          fareBasis: XS50MALG
                          brandedFare: LIGHT
                          class: X
                          includedCheckedBags:
                            quantity: 0
                    - travelerId: '2'
                      fareOption: STANDARD
                      travelerType: ADULT
                      price:
                        currency: EUR
                        total: '137.30'
                        base: '40.00'
                      fareDetailsBySegment:
                        - segmentId: '1'
                          cabin: ECONOMY
                          fareBasis: XS50MALG
                          brandedFare: LIGHT
                          class: X
                          includedCheckedBags:
                            quantity: 0
                        - segmentId: '4'
                          cabin: ECONOMY
                          fareBasis: XS50MALG
                          brandedFare: LIGHT
                          class: X
                          includedCheckedBags:
                            quantity: 0
                          id: '1'
                          source: GDS
                          instantTicketingRequired: false
                          nonHomogeneous: false
                          oneWay: false
                          lastTicketingDate: '2020-03-04'
                          numberOfBookableSeats: 7
                          itineraries:
                            - duration: PT24H20M
                              segments:
                                - departure:
                                    iataCode: NCE
                                    terminal: '2'
                                    at: '2020-09-28T17:55:00'
                                  arrival:
                                    iataCode: SVO
                                    terminal: E
                                    at: '2020-09-28T22:40:00'
                                  carrierCode: SU
                                  number: '2361'
                                  aircraft:
                                    code: '321'
                                  operating:
                                    carrierCode: SU
                                  duration: PT3H45M
                                  id: '49'
                                  numberOfStops: 0
                                  blacklistedInEU: false
                                - departure:
                                    iataCode: SVO
                                    terminal: D
                                    at: '2020-09-29T09:20:00'
                                  arrival:
                                    iataCode: JFK
                                    terminal: '1'
                                    at: '2020-09-29T12:15:00'
                                  carrierCode: SU
                                  number: '100'
                                  aircraft:
                                    code: 77W
                                  operating:
                                    carrierCode: SU
                                  duration: PT9H55M
                                  id: '50'
                                  numberOfStops: 0
                                  blacklistedInEU: false
                            - duration: PT15H35M
                              segments:
                                - departure:
                                    iataCode: JFK
                                    terminal: '1'
                                    at: '2020-10-01T19:20:00'
                                  arrival:
                                    iataCode: SVO
                                    terminal: D
                                    at: '2020-10-02T11:45:00'
                                  carrierCode: SU
                                  number: '103'
                                  aircraft:
                                    code: 77W
                                  operating:
                                    carrierCode: SU
                                  duration: PT9H25M
                                  id: '133'
                                  numberOfStops: 0
                                  blacklistedInEU: false
                                - departure:
                                    iataCode: SVO
                                    terminal: E
                                    at: '2020-10-02T13:55:00'
                                  arrival:
                                    iataCode: NCE
                                    terminal: '2'
                                    at: '2020-10-02T16:55:00'
                                  carrierCode: SU
                                  number: '2360'
                                  aircraft:
                                    code: '321'
                                  operating:
                                    carrierCode: SU
                                  duration: PT4H
                                  id: '134'
                                  numberOfStops: 0
                                  blacklistedInEU: false
                          price:
                            currency: EUR
                            total: '567.49'
                            base: '150.00'
                            fees:
                              - amount: '0.00'
                                type: SUPPLIER
                              - amount: '0.00'
                                type: TICKETING
                            grandTotal: '567.49'
                          pricingOptions:
                            fareType:
                              - PUBLISHED
                            includedCheckedBagsOnly: true
                          validatingAirlineCodes:
                            - SU
                          travelerPricings:
                            - travelerId: '1'
                              fareOption: STANDARD
                              travelerType: ADULT
                              price:
                                currency: EUR
                                total: '567.49'
                                base: '150.00'
                              fareDetailsBySegment:
                                - segmentId: '49'
                                  cabin: ECONOMY
                                  fareBasis: RVULA
                                  brandedFare: ER
                                  class: R
                                  includedCheckedBags:
                                    quantity: 1
                                - segmentId: '50'
                                  cabin: ECONOMY
                                  fareBasis: RVULA
                                  brandedFare: ER
                                  class: R
                                  includedCheckedBags:
                                    quantity: 1
                                - segmentId: '133'
                                  cabin: ECONOMY
                                  fareBasis: RVULA
                                  brandedFare: ER
                                  class: R
                                  includedCheckedBags:
                                    quantity: 1
                                - segmentId: '134'
                                  cabin: ECONOMY
                                  fareBasis: RVULA
                                  brandedFare: ER
                                  class: R
                                  includedCheckedBags:
                                    quantity: 1
          x-example: *id001
      responses:
        '200':
          $ref: '#/responses/SeatMap'
        '400':
          $ref: '#/responses/400_flightOffer'
        default:
          $ref: '#/responses/500'
      description: ''
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
parameters:
  orderId:
    name: flightOrderId
    description: identifier of the order
    required: false
    in: query
    type: string
    x-example: MlpZVkFMfFdBVFNPTnwyMDE1LTExLTAy
  oldOrderId:
    name: flight-orderId
    description: DEPRECATED identifier of the order , kept for backward compatibility
    required: false
    in: query
    type: string
    x-example: MlpZVkFMfFdBVFNPTnwyMDE1LTExLTAy
  getOverride:
    name: X-HTTP-Method-Override
    description: the HTTP method to apply
    required: true
    in: header
    type: string
    default: GET
definitions:
  FlightSegment:
    type: object
    description: defining a flight segment; including both operating and marketing details when applicable
    properties:
      departure:
        $ref: '#/definitions/FlightEndPoint'
      arrival:
        $ref: '#/definitions/FlightEndPoint'
      carrierCode:
        type: string
        description: providing the airline / carrier code
        minLength: 1
        maxLength: 2
        example: DL
      number:
        type: string
        description: the flight number as assigned by the carrier
        minLength: 1
        maxLength: 4
        example: '212'
      aircraft:
        $ref: '#/definitions/AircraftEquipment'
      operating:
        $ref: '#/definitions/OperatingFlight'
      duration:
        type: string
        description: stop duration in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) PnYnMnDTnHnMnS format, e.g. PT2H10M
        example: PT2H10M
      stops:
        type: array
        description: information regarding the different stops composing the flight segment. E.g. technical stop, change of gauge...
        items:
          $ref: '#/definitions/FlightStop'
  FlightEndPoint:
    type: object
    description: departure or arrival information
    properties:
      iataCode:
        description: '[IATA airline codes](http://www.iata.org/publications/Pages/code-search.aspx)'
        type: string
        example: JFK
      terminal:
        description: terminal name / number
        type: string
        example: T2
      at:
        description: local date and time in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) YYYY-MM-ddThh:mm±hh:mm format, e.g. 2017-02-10T20:40:00+02:00
        type: string
        format: date-time
        example: '2017-10-23T20:00:00+02:00'
  FlightStop:
    description: details of stops for direct or change of gauge flights
    type: object
    properties:
      iataCode:
        description: '[IATA airline codes](http://www.iata.org/publications/Pages/code-search.aspx)'
        type: string
        example: JFK
      newAircraft:
        $ref: '#/definitions/AircraftEquipment'
      duration:
        type: string
        description: stop duration in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) PnYnMnDTnHnMnS format, e.g. PT2H10M
        example: PT2H10M
      arrivalAt:
        description: arrival at the stop in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) YYYY-MM-ddThh:mm±hh:mm format, e.g. 2017-02-10T20:40:00+02:00
        type: string
        format: date-time
        example: '2017-10-23T20:00:00+02:00'
      departureAt:
        description: departure from the stop in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) YYYY-MM-ddThh:mm±hh:mm format, e.g. 2017-02-10T20:40:00+02:00
        type: string
        format: date-time
        example: '2017-10-23T20:00:00+02:00'
  AircraftEquipment:
    description: information related to the aircraft
    properties:
      code:
        type: string
        description: |
          IATA aircraft code (http://www.flugzeuginfo.net/table_accodes_iata_en.php)
        pattern: '[a-zA-Z0-9]{3}'
        example: '318'
  OperatingFlight:
    type: object
    description: information about the operating flight
    properties:
      carrierCode:
        type: string
        description: providing the airline / carrier code
        minLength: 1
        maxLength: 2
        example: DL
      number:
        type: string
        description: the flight number as assigned by the carrier
        minLength: 1
        maxLength: 4
        example: '212'
      suffix:
        type: string
        description: the flight number suffix as assigned by the carrier
        minLength: 1
        maxLength: 4
        example: string-value
  FlightOffer:
    title: Flight-offer
    type: object
    required:
      - type
      - id
    properties:
      type:
        type: string
        description: the resource name
        example: flight-offer
      id:
        description: Id of the flight offer
        type: string
        example: '1'
      source:
        $ref: '#/definitions/FlightOfferSource'
      instantTicketingRequired:
        description: If true, inform that a ticketing will be required at booking step.
        type: boolean
        example: false
      disablePricing:
        description: BOOK step ONLY - If true, allows to book a PNR without pricing. Only for the source "GDS"
        type: boolean
        example: false
      nonHomogeneous:
        description: If true, upon completion of the booking, this pricing solution is expected to yield multiple records (a record contains booking information confirmed and stored, typically a Passenger Name Record (PNR), in the provider GDS or system)
        type: boolean
        example: false
      oneWay:
        description: If true, the flight offer fulfills only one originDestination and has to be combined with other oneWays to complete the whole journey.
        type: boolean
        example: false
      paymentCardRequired:
        description: If true, a payment card is mandatory to book this flight offer
        type: boolean
        example: false
      lastTicketingDate:
        description: If booked on the same day as the search (with respect to timezone), this flight offer is guaranteed to be thereafter valid for ticketing until this date (included). Unspecified when it does not make sense for this flight offer (e.g. no control over ticketing once booked). YYYY-MM-DD format, e.g. 2019-06-07
        type: string
        example: '2018-06-19T00:00:00.000Z'
      numberOfBookableSeats:
        description: Number of seats bookable in a single request. Can not be higher than 9.
        type: number
        example: 9
        minimum: 1
        maximum: 9
      itineraries:
        type: array
        minItems: 1
        maxItems: 250
        items:
          title: Itineraries
          type: object
          properties:
            duration:
              description: duration in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) PnYnMnDTnHnMnS format, e.g. PT2H10M for a duration of 2h10m
              type: string
              example: PT2H10M
            segments:
              title: Segments
              type: array
              minItems: 1
              maxItems: 9
              items:
                $ref: '#/definitions/Segment'
          required:
            - segments
      price:
        $ref: '#/definitions/Extended_Price'
      pricingOptions:
        title: PricingOptions
        type: object
        properties:
          fareType:
            description: type of fare of the flight-offer
            $ref: '#/definitions/PricingOptionsFareType'
          corporateCodes:
            type: array
            description: Allow Corporate negotiated fares using one or more corporate number (corporate code).
            items:
              type: string
            example:
              - '123456'
          includedCheckedBagsOnly:
            type: boolean
            description: If true, returns the flight-offers with included checked bags only
            example: true
          refundableFare:
            type: boolean
            description: If true, returns the flight-offers with refundable fares only
            example: true
          noRestrictionFare:
            type: boolean
            description: If true, returns the flight-offers with no restriction fares only
            example: true
          noPenaltyFare:
            type: boolean
            description: If true, returns the flight-offers with no penalty fares only
            example: true
      validatingAirlineCodes:
        description: This option ensures that the system will only consider these airlines.
        type: array
        minItems: 1
        maxItems: 9
        items:
          type: string
        example:
          - AF
      travelerPricings:
        title: TravelerPricings
        description: Fare information for each traveler/segment
        type: array
        minItems: 1
        maxItems: 18
        items:
          title: TravelerPricing
          required:
            - travelerId
            - fareOption
            - travelerType
            - fareDetailsBySegment
          properties:
            travelerId:
              type: string
              example: '1'
              description: Id of the traveler
            fareOption:
              $ref: '#/definitions/TravelerPricingFareOption'
            travelerType:
              $ref: '#/definitions/TravelerType'
            associatedAdultId:
              type: string
              description: if type="HELD_INFANT", corresponds to the adult traveler's id who will share the seat
              example: '12345'
            price:
              description: price detail of the traveler
              $ref: '#/definitions/Price'
            fareDetailsBySegment:
              type: array
              minItems: 1
              maxItems: 18
              items:
                title: FareDetailsBySegment
                description: Fare details of the segment
                required:
                  - segmentId
                properties:
                  segmentId:
                    type: string
                    example: '1'
                    description: Id of the segment
                  cabin:
                    $ref: '#/definitions/TravelClass'
                  fareBasis:
                    description: Fare basis specifying the rules of a fare. Usually, though not always, is composed of the booking class code followed by a set of letters and digits representing other characteristics of the ticket, such as refundability, minimum stay requirements, discounts or special promotional elements.
                    type: string
                    example: ANNNNF4K
                    pattern: '[[A-Z0-9]{1,18}'
                  brandedFare:
                    description: The name of the Fare Family corresponding to the fares. Only for the GDS provider and if the airline has fare families filled
                    type: string
                    example: LIGHTONE
                  class:
                    description: The code of the booking class, a.k.a. class of service or Reservations/Booking Designator (RBD)
                    type: string
                    example: A
                    pattern: '[A-Z]{1}'
                  isAllotment:
                    description: True if the corresponding booking class is in an allotment
                    type: boolean
                    example: true
                  allotmentDetails:
                    title: AllotmentDetails
                    type: object
                    properties:
                      tourName:
                        type: string
                        example: Sample Name
                      tourReference:
                        type: string
                        example: string-value
                  sliceDiceIndicator:
                    $ref: '#/definitions/SliceDiceIndicator'
                  includedCheckedBags:
                    title: includedCheckedBags
                    $ref: '#/definitions/BaggageAllowance'
                    description: Details of the included checked bags
                  additionalServices:
                    type: object
                    title: AdditionalServicesRequest
                    properties:
                      chargeableCheckedBags:
                        title: chargeableCheckedBags
                        $ref: '#/definitions/BaggageAllowance'
                        description: Details of chargeable checked bags
                      chargeableSeatNumber:
                        type: string
                        description: seat number
                        example: 33D
                        pattern: '[1-9][0-9]{0,2}[A-Z]?'
                      otherServices:
                        type: array
                        description: Other services to add
                        items:
                          $ref: '#/definitions/ServiceName'
                        example:
                          - PRIORITY_BOARDING
      fareRules:
        description: Fare rules of the flight offer
        $ref: '#/definitions/FareRules'
  FlightOfferSource:
    description: source of the flight offer
    type: string
    enum:
      - GDS
    example: GDS
  Segment:
    allOf:
      - type: object
        properties:
          id:
            description: Id of the segment
            type: string
            example: 1
          numberOfStops:
            description: Number of stops
            type: integer
            example: 0
          blacklistedInEU:
            description: |
              When the flight has a marketing or/and operating airline that is identified as blacklisted by the European Commission. 

              To improve travel safety, the European Commission regularly updates the list of the banned carriers from operating in Europe. It allows any Travel Agency located in the European Union to easily identify and hide any travel recommendation based on some unsafe airlines. 
              The [list of the banned airlines](https://ec.europa.eu/transport/sites/transport/files/air-safety-list_en.pdf) is published in the Official Journal of the European Union, where they are included as annexes A and B to the Commission Regulation. The blacklist of an airline can concern all its flights or some specific aircraft types pertaining to the airline   
            type: boolean
            example: false
          co2Emissions:
            description: Co2 informations
            type: array
            minItems: 1
            items:
              title: Co2Emission
              $ref: '#/definitions/Co2Emission'
      - $ref: '#/definitions/FlightSegment'
  Extended_Price:
    type: object
    title: Price
    description: price information
    allOf:
      - type: object
        properties:
          margin:
            description: BOOK step ONLY - The price margin percentage (plus or minus) that the booking can tolerate. When set to 0, then no price magin is tolerated.
            type: string
            example: '1.00'
          grandTotal:
            description: Total amount paid by the user (including fees and selected additional services).
            type: string
            example: '987.00'
          billingCurrency:
            description: Currency of the payment. It may be different than the requested currency
            type: string
            example: EUR
          additionalServices:
            type: array
            title: AdditionalServices
            items:
              title: AdditionalService
              type: object
              properties:
                amount:
                  type: string
                  example: '332.70'
                type:
                  $ref: '#/definitions/AdditionalServiceType'
      - $ref: '#/definitions/Price'
  PricingOptionsFareType:
    type: array
    description: type of fare of the flight-offer
    items:
      type: string
      enum:
        - PUBLISHED
        - NEGOTIATED
        - CORPORATE
    example:
      - PUBLISHED
  TravelerPricingFareOption:
    description: |
      option specifying a group of fares, which may be valid under certain conditons
      Can be used to specify special fare discount for a passenger
    type: string
    enum:
      - STANDARD
      - INCLUSIVE_TOUR
      - SPANISH_MELILLA_RESIDENT
      - SPANISH_CEUTA_RESIDENT
      - SPANISH_CANARY_RESIDENT
      - SPANISH_BALEARIC_RESIDENT
      - AIR_FRANCE_METROPOLITAN_DISCOUNT_PASS
      - AIR_FRANCE_DOM_DISCOUNT_PASS
      - AIR_FRANCE_COMBINED_DISCOUNT_PASS
      - AIR_FRANCE_FAMILY
      - ADULT_WITH_COMPANION
      - COMPANION
    example: STANDARD
  TravelerType:
    type: string
    description: |
      traveler type
      age restrictions : CHILD < 12y, HELD_INFANT < 2y, SEATED_INFANT < 2y, SENIOR >=60y
    enum:
      - ADULT
      - CHILD
      - SENIOR
      - YOUNG
      - HELD_INFANT
      - SEATED_INFANT
      - STUDENT
    example: ADULT
  TravelClass:
    description: quality of service offered in the cabin where the seat is located in this flight. Economy, premium economy, business or first class
    type: string
    enum:
      - ECONOMY
      - PREMIUM_ECONOMY
      - BUSINESS
      - FIRST
    example: PREMIUM_ECONOMY
  SliceDiceIndicator:
    description: slice and Dice indicator, such as Local Availability, Sub OnD(Origin and Destination) 1 Availability and Sub OnD 2 Availability
    type: string
    enum:
      - LOCAL_AVAILABILITY
      - SUB_OD_AVAILABILITY_1
      - SUB_OD_AVAILABILITY_2
  BaggageAllowance:
    description: baggageAllowance
    type: object
    properties:
      excessRate:
        $ref: '#/definitions/ElementaryPrice'
      quantity:
        type: integer
        description: Total number of units
        example: 1
      weight:
        type: integer
        description: Weight of the baggage allowance
        example: 20
      weightUnit:
        type: string
        description: Code to qualify unit as pounds or kilos
        example: KG
  Ele

# --- truncated at 32 KB (432 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/openapi/amadeus-seatmap-display-openapi.yml