Flight Create Orders

swagger: '2.0'
info:
  version: 1.10.0
  title: Flight Create Orders
  x-tags:
    - '#travel-booking'
    - '#quick-connect'
    - '#mobile-services'
    - '#ama-for-dev'
  x-status: validated
  x-release-note:
    1.10.0:
      - Add chargeableSeat element
      - Add lastTicketingDateTime
    1.9.0:
      - Add FormIdentification into the flight-order
    1.8.0:
      - Add new source "NDC" - **only available in Enterprise**
    1.7.0:
      - Add new PaymentBrand enum "PYTON" - **only available in Enterprise**
      - Add new OtherPaymentMethod enum "PYTON" - **only available in Enterprise**
      - Add FM Commission - **only available in Enterprise**
    1.6.0:
      - Add Margins and Discounts content from Margin Manager product - **only available in Enterprise**
    1.5.0:
      - Add new General Remark enum "TOUR_CODE"
    1.4.0:
      - Add new Gender enum "UNSPECIFIED" and "UNDISCLOSED"
      - Add EasyPay credit card brand - **only available in Enterprise**
    1.3.0:
      - Add new airlineRemark subtype "ADVANCED_TICKET_TIME_LIMIT"
    1.2.0:
      - Add new sources "LTC" and "EAC" - **only available in Enterprise**
    1.1.0:
      - Add Co2Emissions information into Create flight-order reply
      - Add language in Contact for the APN feature
    1.0.0:
      - Initial 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:
  /booking/flight-orders:
    post:
      tags:
        - Booking
      operationId: createFligtOrders
      summary: Amadeus Create Order Associated to the Flight Offers.
      parameters:
        - name: body
          description: list of element needed to book a flight Order
          in: body
          required: true
          schema:
            title: FlightOrderQuery
            properties:
              data:
                $ref: '#/definitions/FlightOrder'
            example: &id001
              data:
                type: flight-order
                flightOffers:
                  - type: flight-offer
                    id: '1'
                    source: GDS
                    instantTicketingRequired: false
                    nonHomogeneous: false
                    paymentCardRequired: false
                    lastTicketingDate: '2020-03-01'
                    itineraries:
                      - segments:
                          - departure:
                              iataCode: GIG
                              terminal: '2'
                              at: '2020-03-01T21:05:00'
                            arrival:
                              iataCode: CDG
                              terminal: 2E
                              at: '2020-03-02T12:20:00'
                            carrierCode: KL
                            number: '2410'
                            aircraft:
                              code: '772'
                            operating:
                              carrierCode: AF
                            duration: PT11H15M
                            id: '40'
                            numberOfStops: 0
                          - departure:
                              iataCode: CDG
                              terminal: 2F
                              at: '2020-03-02T14:30:00'
                            arrival:
                              iataCode: AMS
                              at: '2020-03-02T15:45:00'
                            carrierCode: KL
                            number: '1234'
                            aircraft:
                              code: 73H
                            operating:
                              carrierCode: KL
                            duration: PT1H15M
                            id: '41'
                            numberOfStops: 0
                          - departure:
                              iataCode: AMS
                              at: '2020-03-02T17:05:00'
                            arrival:
                              iataCode: MAD
                              terminal: '2'
                              at: '2020-03-02T19:35:00'
                            carrierCode: KL
                            number: '1705'
                            aircraft:
                              code: 73J
                            operating:
                              carrierCode: KL
                            duration: PT2H30M
                            id: '42'
                            numberOfStops: 0
                      - segments:
                          - departure:
                              iataCode: MAD
                              terminal: '2'
                              at: '2020-03-05T20:25:00'
                            arrival:
                              iataCode: AMS
                              at: '2020-03-05T23:00:00'
                            carrierCode: KL
                            number: '1706'
                            aircraft:
                              code: 73J
                            operating:
                              carrierCode: KL
                            duration: PT2H35M
                            id: '81'
                            numberOfStops: 0
                          - departure:
                              iataCode: AMS
                              at: '2020-03-06T10:40:00'
                            arrival:
                              iataCode: GIG
                              terminal: '2'
                              at: '2020-03-06T18:35:00'
                            carrierCode: KL
                            number: '705'
                            aircraft:
                              code: '772'
                            operating:
                              carrierCode: KL
                            duration: PT11H55M
                            id: '82'
                            numberOfStops: 0
                    price:
                      currency: USD
                      total: '8514.96'
                      base: '8314.00'
                      fees:
                        - amount: '0.00'
                          type: SUPPLIER
                        - amount: '0.00'
                          type: TICKETING
                        - amount: '0.00'
                          type: FORM_OF_PAYMENT
                      grandTotal: '8514.96'
                      billingCurrency: USD
                    pricingOptions:
                      fareType:
                        - PUBLISHED
                      includedCheckedBagsOnly: true
                    validatingAirlineCodes:
                      - AF
                    travelerPricings:
                      - travelerId: '1'
                        fareOption: STANDARD
                        travelerType: ADULT
                        price:
                          currency: USD
                          total: '4849.48'
                          base: '4749.00'
                          taxes:
                            - amount: '31.94'
                              code: BR
                            - amount: '14.68'
                              code: CJ
                            - amount: '5.28'
                              code: FR
                            - amount: '17.38'
                              code: JD
                            - amount: '0.69'
                              code: OG
                            - amount: '3.95'
                              code: QV
                            - amount: '12.12'
                              code: QX
                            - amount: '14.44'
                              code: RN
                        fareDetailsBySegment:
                          - segmentId: '40'
                            cabin: BUSINESS
                            fareBasis: CFFBR
                            brandedFare: BUSINESS
                            class: C
                            includedCheckedBags:
                              quantity: 2
                          - segmentId: '41'
                            cabin: BUSINESS
                            fareBasis: CFFBR
                            brandedFare: BUSINESS
                            class: J
                            includedCheckedBags:
                              quantity: 2
                          - segmentId: '42'
                            cabin: BUSINESS
                            fareBasis: CFFBR
                            brandedFare: BUSINESS
                            class: J
                            includedCheckedBags:
                              quantity: 2
                          - segmentId: '81'
                            cabin: ECONOMY
                            fareBasis: YFFBR
                            brandedFare: FULLFLEX
                            class: 'Y'
                            includedCheckedBags:
                              quantity: 1
                          - segmentId: '82'
                            cabin: ECONOMY
                            fareBasis: YFFBR
                            brandedFare: FULLFLEX
                            class: 'Y'
                            includedCheckedBags:
                              quantity: 1
                      - travelerId: '2'
                        fareOption: STANDARD
                        travelerType: CHILD
                        price:
                          currency: USD
                          total: '3665.48'
                          base: '3565.00'
                          taxes:
                            - amount: '31.94'
                              code: BR
                            - amount: '14.68'
                              code: CJ
                            - amount: '5.28'
                              code: FR
                            - amount: '17.38'
                              code: JD
                            - amount: '0.69'
                              code: OG
                            - amount: '3.95'
                              code: QV
                            - amount: '12.12'
                              code: QX
                            - amount: '14.44'
                              code: RN
                        fareDetailsBySegment:
                          - segmentId: '40'
                            cabin: BUSINESS
                            fareBasis: CFFBR
                            brandedFare: BUSINESS
                            class: C
                            includedCheckedBags:
                              quantity: 2
                          - segmentId: '41'
                            cabin: BUSINESS
                            fareBasis: CFFBR
                            brandedFare: BUSINESS
                            class: J
                            includedCheckedBags:
                              quantity: 2
                          - segmentId: '42'
                            cabin: BUSINESS
                            fareBasis: CFFBR
                            brandedFare: BUSINESS
                            class: J
                            includedCheckedBags:
                              quantity: 2
                          - segmentId: '81'
                            cabin: ECONOMY
                            fareBasis: YFFBR
                            brandedFare: FULLFLEX
                            class: 'Y'
                            includedCheckedBags:
                              quantity: 1
                          - segmentId: '82'
                            cabin: ECONOMY
                            fareBasis: YFFBR
                            brandedFare: FULLFLEX
                            class: 'Y'
                            includedCheckedBags:
                              quantity: 1
                travelers:
                  - id: '1'
                    dateOfBirth: '1982-01-16'
                    name:
                      firstName: JORGE
                      lastName: GONZALES
                    gender: MALE
                    contact:
                      emailAddress: [email protected]
                      phones:
                        - deviceType: MOBILE
                          countryCallingCode: '34'
                          number: '480080076'
                    documents:
                      - documentType: PASSPORT
                        birthPlace: Madrid
                        issuanceLocation: Madrid
                        issuanceDate: '2015-04-14'
                        number: '00000000'
                        expiryDate: '2025-04-14'
                        issuanceCountry: ES
                        validityCountry: ES
                        nationality: ES
                        holder: true
                  - id: '2'
                    dateOfBirth: '2012-10-11'
                    gender: FEMALE
                    contact:
                      emailAddress: [email protected]
                      phones:
                        - deviceType: MOBILE
                          countryCallingCode: '34'
                          number: '480080076'
                    name:
                      firstName: ADRIANA
                      lastName: GONZALES
                remarks:
                  general:
                    - subType: GENERAL_MISCELLANEOUS
                      text: ONLINE BOOKING FROM INCREIBLE VIAJES
                ticketingAgreement:
                  option: DELAY_TO_CANCEL
                  delay: 6D
                contacts:
                  - addresseeName:
                      firstName: PABLO
                      lastName: RODRIGUEZ
                    companyName: INCREIBLE VIAJES
                    purpose: STANDARD
                    phones:
                      - deviceType: LANDLINE
                        countryCallingCode: '34'
                        number: '480080071'
                      - deviceType: MOBILE
                        countryCallingCode: '33'
                        number: '480080072'
                    emailAddress: [email protected]
                    address:
                      lines:
                        - Calle Prado, 16
                      postalCode: '28014'
                      cityName: Madrid
                      countryCode: ES
          x-example: *id001
      responses:
        '201':
          $ref: '#/responses/returnFlightOrders'
        '400':
          $ref: '#/responses/400_Book'
        default:
          $ref: '#/responses/500'
      description: ''
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
definitions:
  Error_400:
    type: object
    properties:
      errors:
        type: array
        items:
          $ref: '#/definitions/Issue'
    required:
      - errors
    example:
      errors:
        - status: 400
          code: 477
          title: INVALID FORMAT
          detail: invalid query parameter format
          source:
            parameter: airport
            example: CDG
  Error_500:
    type: object
    properties:
      errors:
        type: array
        items:
          $ref: '#/definitions/Issue'
    required:
      - errors
    example:
      errors:
        - status: 500
          code: 141
          title: SYSTEM ERROR HAS OCCURRED
  Issue:
    type: object
    properties:
      status:
        description: the HTTP status code applicable to this error
        type: integer
        example: 1
      code:
        description: an application-specific error code
        type: integer
        format: int64
        example: 1
      title:
        description: a short summary of the error
        type: string
        example: string-value
      detail:
        description: explanation of the error
        type: string
        example: string-value
      source:
        type: object
        title: Issue_Source
        description: an object containing references to the source of the error
        maxProperties: 1
        properties:
          pointer:
            description: a JSON Pointer [RFC6901] to the associated entity in the request document
            type: string
            example: string-value
          parameter:
            description: a string indicating which URI query parameter caused the issue
            type: string
            example: string-value
          example:
            description: a string indicating an example of the right value
            type: string
            example: string-value
  Collection_Meta_Link:
    type: object
    title: Collection_Meta
    properties:
      count:
        type: integer
        example: 1
      links:
        type: object
        title: CollectionLinks
        properties:
          self:
            type: string
            format: uri
            example: https://test.api.amadeus.com/v1/area/resources?...
          next:
            type: string
            format: uri
            example: https://test.api.amadeus.com/v1/area/resources?...
          previous:
            type: string
            format: uri
            example: https://test.api.amadeus.com/v1/area/resources?...
          last:
            type: string
            format: uri
            example: https://test.api.amadeus.com/v1/area/resources?...
          first:
            type: string
            format: uri
            example: https://test.api.amadeus.com/v1/area/resources?...
          up:
            type: string
            format: uri
            example: https://test.api.amadeus.com/v1/area/resources?...
        example:
          self: https://test.api.amadeus.com/v1/area/resources?param=value
  LocationEntry:
    additionalProperties:
      $ref: '#/definitions/LocationValue'
  AircraftEntry:
    additionalProperties:
      description: the manufacturer/model of aircraft
      type: string
  CurrencyEntry:
    additionalProperties:
      type: string
      example: EUR
  CarrierEntry:
    additionalProperties:
      description: the carrier name
      type: string
  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'
  OriginalFlightEndPoint:
    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
  FlightEndPoint:
    title: FlightEndPoint
    description: departure or arrival information
    allOf:
      - $ref: '#/definitions/OriginalFlightEndPoint'
      - type: object
        properties:
          at:
            description: local date and time in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) YYYY-MM-ddThh:mm:ss format, e.g. 2017-02-10T20:40:00
            type: string
            format: date-time
            example: '2017-10-23T20:00:00'
  OriginalFlightStop:
    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
      duration:
        type: string
        description: stop duration in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) PnYnMnDTnHnMnS format, e.g. PT2H10M
        example: PT2H10M
  FlightStop:
    title: FlightStop
    description: details of stops for direct or change of gauge flights
    allOf:
      - $ref: '#/definitions/OriginalFlightStop'
      - type: object
        properties:
          arrivalAt:
            description: arrival at the stop in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) YYYY-MM-ddThh:mm:ss format, e.g. 2017-02-10T20:40:00
            type: string
            format: date-time
            example: '2017-10-23T20:00:00'
          departureAt:
            description: departure from the stop in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) YYYY-MM-ddThh:mm:ss format, e.g. 2017-02-10T20:40:00
            type: string
            format: date-time
            example: '2017-10-23T20:00: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
  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: '#/definitions/Fee'
      taxes:
        type: array
        items:
          $ref: '#/definitions/Tax'
      refundableTaxes:
        description: The amount of taxes which are refundable
        type: string
        example: '200.00'
  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'
  Fee:
    description: a fee
    properties:
      amount:
        type: string
        example: '332.70'
      type:
        $ref: '#/definitions/FeeType'
  FeeType:
    type: string
    description: type of fee
    enum:
      - TICKETING
      - FORM_OF_PAYMENT
      - SUPPLIER
    example: TICKETING
  Tax:
    description: a tax
    type: object
    properties:
      amount:
        type: string
        example: '332.70'
      code:
        type: string
        example: MX
  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
  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: '#/definitions/TravelClass'
  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 can be combined with other oneWays flight-offers to complete the whole journey (one-Way combinable feature).
        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-19'
      lastTicketingDateTime:
        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/time (included). Unspecified when it does not make sense for this flight offer (e.g. no control over ticketing once booked). Information only this attribute is not used in input of pricing request. Local date and time in YYYY-MM-ddThh:mm:ss format, e.g. 2017-02-10T20:40:00
        type: string
        format: date-time
        example: '2018-06-19T15:00:00'
      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'
          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 offers with these airlines as validating carrier.
        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:
                    $ref: '#/definitions/AllotmentDetails'
                  sliceDiceIndicator:
                    $ref: '#/definitions/SliceDiceIndicator'
                  includedCheckedBags:
                    title: includedChecked

# --- truncated at 32 KB (79 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/openapi/amadeus-flight-create-orders-openapi.yml