Amadeus Solutions Display SeatMaps API

openapi: 3.2.0
info:
  version: 1.2.0
  title: Branded Fares Upsell Display SeatMaps API
  x-tags:
  - '#quick-connect'
  - '#online-retail'
  - '#mobile-services'
  - '#ama-for-dev'
  x-status: validated
  x-release-note:
    1.2.0:
    - Add chargeableSeat element
    - Add lastTicketingDateTime
    1.1.0:
    - Add Margins and Discounts content from Margin Manager product - **only available in Enterprise**
    1.0.0:
    - First version of Branded Fares Upsell
  description: "\nBefore 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. \n\nPlease 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)."
servers:
- url: https://test.api.amadeus.com/v1
tags:
- name: Display SeatMaps
paths:
  /shopping/seatmaps:
    get:
      tags:
      - Display SeatMaps
      operationId: getSeatmapFromOrder
      summary: Amadeus Returns All the Seat Maps of a Given Order.
      parameters:
      - $ref: '#/components/parameters/orderId'
      - $ref: '#/components/parameters/oldOrderId'
      responses:
        '200':
          $ref: '#/components/responses/SeatMap'
        '400':
          $ref: '#/components/responses/400_Order'
        '404':
          $ref: '#/components/responses/404'
        default:
          $ref: '#/components/responses/500'
      description: ''
    post:
      tags:
      - Display SeatMaps
      operationId: getSeatmapFromFlightOffer
      summary: Amadeus Returns All the Seat Maps of a Given FlightOffer.
      parameters:
      - $ref: '#/components/parameters/getOverride'
      responses:
        '200':
          $ref: '#/components/responses/SeatMap'
        '400':
          $ref: '#/components/responses/400_flightOffer'
        default:
          $ref: '#/components/responses/500'
      description: ''
      requestBody:
        content:
          application/vnd.amadeus+json:
            schema:
              title: flightOffers
              required:
              - data
              properties:
                data:
                  type: array
                  minItems: 1
                  maxItems: 6
                  items:
                    $ref: '#/components/schemas/FlightOffer'
                included:
                  title: Travelers_map
                  properties:
                    travelers:
                      description: Map of travelers
                      additionalProperties:
                        $ref: '#/components/schemas/Traveler'
              example:
                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
        required: true
components:
  schemas:
    Amenity_Seat:
      type: object
      description: Characteristics for a group of seat, such as Distance from one seat to the another in front or behind it or width space
      properties:
        legSpace:
          description: Space between 2 seats
          type: integer
          example: 33
        spaceUnit:
          type: string
          enum:
          - INCHES
          - CENTIMENTERS
        tilt:
          description: Flatness of a seat
          type: string
          enum:
          - FULL_FLAT
          - ANGLE_FLAT
          - NORMAL
        amenityType:
          type: string
          enum:
          - SEAT
        medias:
          description: list of media associated to the seat (rich content)
          type: array
          items:
            $ref: '#/components/schemas/Amenity_Media'
    AircraftCabinAmenities_Food:
      allOf:
      - $ref: '#/components/schemas/Amenity'
      - type: object
        description: Type of food for a given flight
        properties:
          foodType:
            type: string
            enum:
            - MEAL
            - FRESH_MEAL
            - SNACK
            - FRESH_SNACK
    PhoneDeviceType:
      type: string
      description: Type of the device (Landline, Mobile or Fax)
      enum:
      - MOBILE
      - LANDLINE
      - FAX
    PricingOptionsFareType:
      type: array
      description: type of fare of the flight-offer
      items:
        type: string
        enum:
        - PUBLISHED
        - NEGOTIATED
        - CORPORATE
      example:
      - PUBLISHED
    Error_404:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Issue'
      required:
      - errors
      example:
        errors:
        - status: 404
          code: 1797
          title: NOT FOUND
          detail: no response found for this query parameter
          source:
            parameter: airport
    Deck:
      type: object
      description: deck information
      properties:
        deckType:
          description: A deck is a level on an aircraft. The deck location of the cabin (current possible values are upper or main) The main deck, where passengers are seated on a passenger flight. Upper deck is above the main deck where more passengers are seated.
          type: string
          enum:
          - UPPER
          - MAIN
          - LOWER
        deckConfiguration:
          $ref: '#/components/schemas/DeckConfiguration'
        facilities:
          type: array
          items:
            $ref: '#/components/schemas/Facility'
        seats:
          type: array
          items:
            $ref: '#/components/schemas/Seat'
    Stakeholder:
      type: object
      description: stakeholder definition
      properties:
        id:
          description: item identifier
          type: string
        dateOfBirth:
          type: string
          format: date
          description: The date of birth in ISO 8601 format (yyyy-mm-dd)
        gender:
          $ref: '#/components/schemas/StakeholderGender'
        name:
          $ref: '#/components/schemas/Name'
        documents:
          type: array
          description: Advanced Passenger Information - regulatory identity documents - SSR DOCS & DOCO elements
          items:
            $ref: '#/components/schemas/IdentityDocument'
    Coordinates:
      type: object
      properties:
        x:
          type: integer
          description: coordinate for the Length
        y:
          type: integer
          description: coordinate for the Width
    Traveler:
      title: traveler element
      description: the traveler of the trip
      allOf:
      - $ref: '#/components/schemas/Stakeholder'
      - type: object
        properties:
          emergencyContact:
            description: emergency contact
            $ref: '#/components/schemas/EmergencyContact'
          loyaltyPrograms:
            description: list of loyalty program followed by the traveler
            type: array
            minItems: 0
            maxItems: 10
            items:
              $ref: '#/components/schemas/LoyaltyProgram'
          discountEligibility:
            description: list of element that allow a discount.
            type: array
            minItems: 0
            maxItems: 10
            items:
              $ref: '#/components/schemas/Discount'
          contact:
            $ref: '#/components/schemas/Contact'
    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
    AircraftCabinAmenities_Power:
      allOf:
      - $ref: '#/components/schemas/Amenity'
      - type: object
        description: Type of power outlet for a given flight
        properties:
          powerType:
            type: string
            enum:
            - PLUG
            - USB_PORT
            - ADAPTOR
            - PLUG_OR_USB_PORT
          usbType:
            type: string
            enum:
            - USB_A
            - USB_C
            - USB_A_AND_USB_C
    Co2Emission:
      type: object
      properties:
        weight:
          description: Weight of Co2 emitted for the concerned segment
          type: integer
          example: 90
        weightUnit:
          description: Code to qualify unit as pounds or kilos
          type: string
          example: KG
        cabin:
          $ref: '#/components/schemas/TravelClass'
    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. \n\nTo 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. \nThe [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   \n"
            type: boolean
            example: false
          co2Emissions:
            description: Co2 informations
            type: array
            minItems: 1
            items:
              title: Co2Emission
              $ref: '#/components/schemas/Co2Emission'
      - $ref: '#/components/schemas/FlightSegment'
    StakeholderGender:
      type: string
      description: The gender
      enum:
      - MALE
      - FEMALE
      example: FEMALE
    FeeType:
      type: string
      description: type of fee
      enum:
      - TICKETING
      - FORM_OF_PAYMENT
      - SUPPLIER
      example: TICKETING
    ServiceName:
      description: type of service
      type: string
      enum:
      - PRIORITY_BOARDING
      - AIRPORT_CHECKIN
      example: PRIORITY_BOARDING
    Price:
      properties:
        currency:
          type: string
          example: USD
        total:
          description: Total amount paid by the user
          type: string
          example: '932.70'
        base:
          description: Amount without taxes
          type: string
          example: '632.70'
        fees:
          description: List of applicable fees
          type: array
          items:
            $ref: '#/components/schemas/Fee'
        taxes:
          type: array
          items:
            $ref: '#/components/schemas/Tax'
    AircraftCabinAmenities_Entertainment:
      allOf:
      - $ref: '#/components/schemas/Amenity'
      - type: object
        description: Type of entertainment contents for a given flight
        properties:
          entertainmentType:
            type: string
            enum:
            - LIVE_TV
            - MOVIES
            - AUDIO_VIDEO_ON_DEMAND
            - TV_SHOWS
            - IP_TV
    QualifiedFreeText:
      type: object
      description: Specific type to convey a list of string for specific information type ( via qualifier) in specific character set, or language
      title: QualifiedFreeText
      properties:
        text:
          type: string
          description: Free Text
          example: Do you need and example ?
        lang:
          type: string
          description: see RFC 5646
          example: fr-FR
    Error_400:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Issue'
      required:
      - errors
      example:
        errors:
        - status: 400
          code: 477
          title: INVALID FORMAT
          detail: invalid query parameter format
          source:
            parameter: airport
            example: CDG
    Phone:
      type: object
      description: phone information
      properties:
        category:
          description: Category of the contact element
          type: string
          enum:
          - BUSINESS
          - PERSONAL
          - OTHER
        addresseeName:
          type: string
          description: Adressee name (e.g. in case of emergency purpose it corresponds to name of the person to be contacted).
          pattern: '[a-zA-Z -]'
        deviceType:
          $ref: '#/components/schemas/PhoneDeviceType'
        countryCode:
          type: string
          description: Country code of the country (ISO3166-1). E.g. "US" for the United States
          pattern: '[A-Z]{2}'
        countryCallingCode:
          type: string
          description: Country calling code of the phone number, as defined by the International Communication Union. Examples - "1" for US, "371" for Latvia.
          pattern: '[0-9+]{2,5}'
        areaCode:
          type: string
          description: Corresponds to a regional code or a city code. The length of the field varies depending on the area.
          pattern: '[0-9]{1,4}'
        number:
          type: string
          description: Phone number. Composed of digits only. The number of digits depends on the country.
          pattern: '[0-9]{1,15}'
        extension:
          type: string
          description: Extension of the phone
        text:
          type: string
          description: String containing the full phone number - applicable only when a structured phone (i.e. countryCallingCode + number) is not provided
    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: '#/components/schemas/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: '#/components/schemas/Segment'
            required:
            - segments
        price:
          $ref: '#/components/schemas/Extended_Price'
        pricingOptions:
          title: PricingOptions
          type: object
          properties:
            fareType:
              description: type of fare of the flight-offer
              $ref: '#/components/schemas/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: '#/components/schemas/TravelerPricingFareOption'
              travelerType:
                $ref: '#/components/schemas/TravelerType'
              associatedAdultId:
                type: string
                description: if type="HELD_INFANT", corresponds to the adult traveler's id who will share the seat
              price:
                description: price detail of the traveler
                $ref: '#/components/schemas/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: '#/components/schemas/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
                        tourReference:
                          type: string
                    sliceDiceIndicator:
                      $ref: '#/components/schemas/SliceDiceIndicator'
                    includedCheckedBags:
                      title: includedCheckedBags
                      $ref: '#/components/schemas/BaggageAllowance'
                      description: Details of the included checked bags
                    additionalServices:
                      type: object
                      title: AdditionalServicesRequest
                      properties:
                        chargeableCheckedBags:
                          title: chargeableCheckedBags
                          $ref: '#/components/schemas/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: '#/components/schemas/ServiceName'
                          example:
                          - PRIORITY_BOARDING
        fareRules:
          description: Fare rules of the flight offer
          $ref: '#/components/schemas/FareRules'
    Amenity:
      type: object
      description: 'Base data model related to Amenity, inherited amenities can be created using this baseline for extension ( using type for polymorp

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