swagger: "2.0"
schemes:
  - https
host: test.api.amadeus.com
basePath: /v1
info:
  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).
  title: Flight Create Orders
  version: 1.9.0
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_amadeus.com_images_en_technology_mobile-tablet_mobile-woman-office-city.jpg.transform_medium_img.jpg
  x-origin:
    - format: swagger
      url: https://raw.githubusercontent.com/amadeus4dev/amadeus-open-api-specification/main/spec/json/FlightCreateOrders_v1_swagger_specification.json
      version: "2.0"
  x-providerName: amadeus.com
  x-release-note:
    1.0.0:
      - Initial version
    1.1.0:
      - Add Co2Emissions information into Create flight-order reply
      - Add language in Contact for the APN feature
    1.2.0:
      - Add new sources "LTC" and "EAC" - **only available in Enterprise**
    1.3.0:
      - Add new airlineRemark subtype "ADVANCED_TICKET_TIME_LIMIT"
    1.4.0:
      - Add new Gender enum "UNSPECIFIED" and "UNDISCLOSED"
      - Add EasyPay credit card brand - **only available in Enterprise**
    1.5.0:
      - Add new General Remark enum "TOUR_CODE"
    1.6.0:
      - Add Margins and Discounts content from Margin Manager product - **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.8.0:
      - Add new source "NDC" - **only available in Enterprise**
    1.9.0:
      - Add FormIdentification into the flight-order
  x-serviceName: amadeus-flight-create-orders
  x-status: validated
  x-tags:
    - "#travel-booking"
    - "#quick-connect"
    - "#mobile-services"
    - "#ama-for-dev"
consumes:
  - application/vnd.amadeus+json
produces:
  - application/vnd.amadeus+json
responses:
  "500":
    description: Unexpected error
    schema:
      $ref: "#/definitions/Error_500"
  400_Book:
    description: |
      code    | title                                 
      ------- | ------------------------------------- 
      477     | INVALID FORMAT
      1304    | CREDIT CARD NOT ACCEPTED
      2781    | INVALID LENGTH
      4926    | INVALID DATA RECEIVED
      9112    | TICKETING - TKT
      2668    | PARAMETER COMBINATION INVALID/RESTRICTED
      32171   | MANDATORY DATA MISSING
      34107   | NOT APPLICABLE FARE
      34651   | SEGMENT SELL FAILURE
      34733   | VIRTUAL CARD CREATION FAILED
      36870   | BOOKING FAILED
      37200   | PRICE DISCREPANCY
      38034   | ONE OR MORE SERVICES ARE NOT AVAILABLE
    schema:
      $ref: "#/definitions/Error_400"
  returnFlightOrders:
    description: Successful Operation
    schema:
      example:
        data:
          associatedRecords:
            - creationDateTime: 2018-07-13T20:17:00
              flightOfferId: "1"
              originSystemCode: 1A
              reference: 2ZYVAL
          contacts:
            - address:
                cityName: Sophia Antipolis Cedex
                countryCode: FR
                lines:
                  - 485 route du Pin Montard
                postalCode: "06902"
              companyName: AMADEUS
              emailAddress: support@mail.com
              phones:
                - countryCallingCode: "33"
                  deviceType: FAX
                  number: "480080070"
                - countryCallingCode: "33"
                  deviceType: LANDLINE
                  number: "480080070"
              purpose: STANDARD
          flightOffers:
            - id: "1"
              itineraries:
                - duration: PT2H
                  segments:
                    - aircraft:
                        code: "320"
                      arrival:
                        at: 2018-09-22T12:15:00
                        iataCode: MAD
                        terminal: "4"
                      blacklistedInEU: false
                      carrierCode: IB
                      co2Emissions:
                        - cabin: ECONOMY
                          weight: "100"
                          weightUnit: KG
                      departure:
                        at: 2018-09-22T10:15:00
                        iataCode: ORY
                        terminal: W
                      duration: PT2H
                      id: "1"
                      number: "3403"
                      numberOfStops: 0
                      operating:
                        carrierCode: IB
                - duration: PT1H20M
                  segments:
                    - aircraft:
                        code: "320"
                      arrival:
                        at: 2018-09-26T23:25:00
                        iataCode: LIS
                        terminal: "1"
                      blacklistedInEU: false
                      carrierCode: IB
                      co2Emissions:
                        - cabin: ECONOMY
                          weight: "100"
                          weightUnit: KG
                      departure:
                        at: 2018-09-26T23:05:00
                        iataCode: MAD
                        terminal: "4"
                      duration: PT1H20M
                      id: "20"
                      number: "3118"
                      numberOfStops: 0
                      operating:
                        carrierCode: IB
                - duration: PT4H30M
                  segments:
                    - aircraft:
                        code: "320"
                      arrival:
                        at: 2018-10-04T14:55:00
                        iataCode: MAD
                        terminal: "4"
                      blacklistedInEU: false
                      carrierCode: IB
                      co2Emissions:
                        - cabin: ECONOMY
                          weight: "100"
                          weightUnit: KG
                      departure:
                        at: 2018-10-04T12:35:00
                        iataCode: LIS
                        terminal: "1"
                      duration: PT2H
                      id: "30"
                      number: "3109"
                      numberOfStops: 0
                      operating:
                        carrierCode: IB
                    - aircraft:
                        code: "320"
                      arrival:
                        at: 2018-10-04T18:05:00
                        iataCode: ORY
                        terminal: W
                      blacklistedInEU: false
                      carrierCode: IB
                      co2Emissions:
                        - cabin: ECONOMY
                          weight: "100"
                          weightUnit: KG
                      departure:
                        at: 2018-10-04T16:05:00
                        iataCode: MAD
                        terminal: "4"
                      duration: PT2H30M
                      id: "31"
                      number: "3444"
                      numberOfStops: 0
                      operating:
                        carrierCode: IB
              price:
                additionalServices:
                  - amount: "100"
                    type: CHECKED_BAGS
                  - amount: "166"
                    type: SEATS
                base: "242.00"
                billingCurrency: EUR
                currency: EUR
                fees:
                  - amount: "0"
                    type: SUPPLIER
                  - amount: "6"
                    type: FORM_OF_PAYMENT
                  - amount: "0"
                    type: TICKETING
                grandTotal: "689.21"
                total: "423.21"
              pricingOptions:
                fareType:
                  - PUBLISHED
                includedCheckedBags: false
              source: GDS
              travelerPricings:
                - fareDetailsBySegment:
                    - allotmentDetails:
                        tourName: tour
                        tourReference: ref
                      brandedFare: LIGHTONE
                      cabin: ECONOMY
                      class: A
                      fareBasis: ANNNNF4K
                      includedCheckedBags:
                        quantity: 0
                      isAllotment: true
                      segmentId: "1"
                      sliceDiceIndicator: ABCDEF
                    - allotmentDetails:
                        tourName: tour
                        tourReference: ref
                      brandedFare: LIGHTONE
                      cabin: ECONOMY
                      class: A
                      fareBasis: ANNNNF4K
                      includedCheckedBags:
                        quantity: 0
                      isAllotment: true
                      segmentId: "20"
                      sliceDiceIndicator: ABCDEF
                    - allotmentDetails:
                        tourName: tour
                        tourReference: ref
                      brandedFare: LIGHTONE
                      cabin: ECONOMY
                      class: A
                      fareBasis: ANNNNF4K
                      includedCheckedBags:
                        quantity: 0
                      isAllotment: true
                      segmentId: "30"
                      sliceDiceIndicator: ABCDEF
                    - allotmentDetails:
                        tourName: tour
                        tourReference: ref
                      brandedFare: LIGHTONE
                      cabin: ECONOMY
                      class: A
                      fareBasis: ANNNNF4K
                      includedCheckedBags:
                        quantity: 0
                      isAllotment: true
                      segmentId: "31"
                      sliceDiceIndicator: ABCDEF
                  fareOption: STANDARD
                  price:
                    base: "126"
                    currency: EUR
                    taxes:
                      - amount: "0.94"
                        code: YQ
                      - amount: "41.67"
                        code: CJ
                      - amount: "31.33"
                        code: FR
                    total: "200.94"
                  travelerId: "1"
                  travelerType: ADULT
                - fareDetailsBySegment:
                    - additionalServices:
                        chargeableCheckedBags:
                          quantity: 1
                          weight: 20
                        chargeableSeatNumber: 33D
                      allotmentDetails:
                        tourName: tour
                        tourReference: ref
                      brandedFare: LIGHTONE
                      cabin: ECONOMY
                      class: A
                      fareBasis: ANNNNF4K
                      includedCheckedBags:
                        quantity: 0
                      isAllotment: true
                      segmentId: "1"
                      sliceDiceIndicator: ABCDEF
                    - additionalServices:
                        chargeableCheckedBags:
                          quantity: 1
                          weight: 20
                        chargeableSeatNumber: 28A
                      allotmentDetails:
                        tourName: tour
                        tourReference: ref
                      brandedFare: LIGHTONE
                      cabin: ECONOMY
                      class: A
                      fareBasis: ANNNNF4K
                      includedCheckedBags:
                        quantity: 0
                      isAllotment: true
                      segmentId: "20"
                      sliceDiceIndicator: ABCDEF
                    - additionalServices:
                        chargeableCheckedBags:
                          quantity: 1
                          weight: 20
                        chargeableSeatNumber: 12C
                      allotmentDetails:
                        tourName: tour
                        tourReference: ref
                      brandedFare: LIGHTONE
                      cabin: ECONOMY
                      class: A
                      fareBasis: ANNNNF4K
                      includedCheckedBags:
                        quantity: 0
                      isAllotment: true
                      segmentId: "30"
                      sliceDiceIndicator: ABCDEF
                    - additionalServices:
                        chargeableCheckedBags:
                          quantity: 1
                          weight: 20
                        chargeableSeatNumber: 33D
                      allotmentDetails:
                        tourName: tour
                        tourReference: ref
                      brandedFare: LIGHTONE
                      cabin: ECONOMY
                      class: A
                      fareBasis: ANNNNF4K
                      includedCheckedBags:
                        quantity: 0
                      isAllotment: true
                      segmentId: "31"
                      sliceDiceIndicator: ABCDEF
                  fareOption: STANDARD
                  price:
                    base: "106"
                    currency: EUR
                    taxes:
                      - amount: "0.94"
                        code: YQ
                      - amount: "41.67"
                        code: CJ
                      - amount: "31.33"
                        code: FR
                    total: "180.94"
                  travelerId: "2"
                  travelerType: CHILD
                - associatedAdultId: "1"
                  fareDetailsBySegment:
                    - allotmentDetails:
                        tourName: tour
                        tourReference: ref
                      brandedFare: LIGHTONE
                      cabin: ECONOMY
                      class: A
                      fareBasis: ANNNNF4K
                      includedCheckedBags:
                        quantity: 0
                      isAllotment: true
                      segmentId: "1"
                      sliceDiceIndicator: ABCDEF
                    - allotmentDetails:
                        tourName: tour
                        tourReference: ref
                      brandedFare: LIGHTONE
                      cabin: ECONOMY
                      class: A
                      fareBasis: ANNNNF4K
                      includedCheckedBags:
                        quantity: 0
                      isAllotment: true
                      segmentId: "20"
                      sliceDiceIndicator: ABCDEF
                    - allotmentDetails:
                        tourName: tour
                        tourReference: ref
                      brandedFare: LIGHTONE
                      cabin: ECONOMY
                      class: A
                      fareBasis: ANNNNF4K
                      includedCheckedBags:
                        quantity: 0
                      isAllotment: true
                      segmentId: "30"
                      sliceDiceIndicator: ABCDEF
                    - allotmentDetails:
                        tourName: tour
                        tourReference: ref
                      brandedFare: LIGHTONE
                      cabin: ECONOMY
                      class: A
                      fareBasis: ANNNNF4K
                      includedCheckedBags:
                        quantity: 0
                      isAllotment: true
                      segmentId: "31"
                      sliceDiceIndicator: ABCDEF
                  fareOption: STANDARD
                  price:
                    base: "10"
                    currency: EUR
                    taxes:
                      - amount: "31.33"
                        code: FR
                    total: "41.33"
                  travelerId: "3"
                  travelerType: HELD_INFANT
              type: flight-offer
              validatingAirlineCodes:
                - IB
          id: MlpZVkFMfFdBVFNPTnwyMDE1LTExLTAy
          queuingOfficeId: NCE1A0950
          ticketingAggreement:
            dateTime: 2018-08-21T10:15:00.000
            option: DELAY_TO_CANCEL
          travelers:
            - contact:
                phones:
                  - countryCallingCode: "33"
                    number: "487692704"
              dateOfBirth: 1982-01-16
              documents:
                - documentType: PASSPORT
                  expiryDate: 2009-04-14
                  holder: true
                  issuanceCountry: GB
                  nationality: GB
                  number: "012345678"
              id: "1"
              name:
                firstName: STEPHANE
                lastName: MARTIN
            - dateOfBirth: 2018-03-24
              id: "3"
              name:
                firstName: JULES
                lastName: MARTIN
            - dateOfBirth: 2007-10-11
              id: "2"
              name:
                firstName: EMILIE
                lastName: MARTIN
          type: flight-order
        dictionaries:
          locations:
            CDG:
              cityCode: PAR
              countryCode: FR
            MAD:
              cityCode: MAD
              countryCode: ES
            ORY:
              cityCode: PAR
              countryCode: FR
      properties:
        data:
          $ref: "#/definitions/FlightOrder"
        dictionaries:
          $ref: "#/definitions/Dictionaries"
        meta:
          $ref: "#/definitions/Collection_Meta_Link"
        warnings:
          items:
            $ref: "#/definitions/Issue"
          type: array
      required:
        - data
      title: Success_Booking
      type: object
paths:
  /booking/flight-orders:
    post:
      description: ""
      operationId: createFligtOrders
      parameters:
        - description: list of element needed to book a flight Order
          in: body
          name: body
          required: true
          schema:
            example:
              data:
                contacts:
                  - address:
                      cityName: Madrid
                      countryCode: ES
                      lines:
                        - Calle Prado, 16
                      postalCode: "28014"
                    addresseeName:
                      firstName: PABLO
                      lastName: RODRIGUEZ
                    companyName: INCREIBLE VIAJES
                    emailAddress: support@increibleviajes.es
                    phones:
                      - countryCallingCode: "34"
                        deviceType: LANDLINE
                        number: "480080071"
                      - countryCallingCode: "33"
                        deviceType: MOBILE
                        number: "480080072"
                    purpose: STANDARD
                flightOffers:
                  - id: "1"
                    instantTicketingRequired: false
                    itineraries:
                      - segments:
                          - aircraft:
                              code: "772"
                            arrival:
                              at: 2020-03-02T12:20:00
                              iataCode: CDG
                              terminal: 2E
                            carrierCode: KL
                            departure:
                              at: 2020-03-01T21:05:00
                              iataCode: GIG
                              terminal: "2"
                            duration: PT11H15M
                            id: "40"
                            number: "2410"
                            numberOfStops: 0
                            operating:
                              carrierCode: AF
                          - aircraft:
                              code: 73H
                            arrival:
                              at: 2020-03-02T15:45:00
                              iataCode: AMS
                            carrierCode: KL
                            departure:
                              at: 2020-03-02T14:30:00
                              iataCode: CDG
                              terminal: 2F
                            duration: PT1H15M
                            id: "41"
                            number: "1234"
                            numberOfStops: 0
                            operating:
                              carrierCode: KL
                          - aircraft:
                              code: 73J
                            arrival:
                              at: 2020-03-02T19:35:00
                              iataCode: MAD
                              terminal: "2"
                            carrierCode: KL
                            departure:
                              at: 2020-03-02T17:05:00
                              iataCode: AMS
                            duration: PT2H30M
                            id: "42"
                            number: "1705"
                            numberOfStops: 0
                            operating:
                              carrierCode: KL
                      - segments:
                          - aircraft:
                              code: 73J
                            arrival:
                              at: 2020-03-05T23:00:00
                              iataCode: AMS
                            carrierCode: KL
                            departure:
                              at: 2020-03-05T20:25:00
                              iataCode: MAD
                              terminal: "2"
                            duration: PT2H35M
                            id: "81"
                            number: "1706"
                            numberOfStops: 0
                            operating:
                              carrierCode: KL
                          - aircraft:
                              code: "772"
                            arrival:
                              at: 2020-03-06T18:35:00
                              iataCode: GIG
                              terminal: "2"
                            carrierCode: KL
                            departure:
                              at: 2020-03-06T10:40:00
                              iataCode: AMS
                            duration: PT11H55M
                            id: "82"
                            number: "705"
                            numberOfStops: 0
                            operating:
                              carrierCode: KL
                    lastTicketingDate: 2020-03-01
                    nonHomogeneous: false
                    paymentCardRequired: false
                    price:
                      base: "8314.00"
                      billingCurrency: USD
                      currency: USD
                      fees:
                        - amount: "0.00"
                          type: SUPPLIER
                        - amount: "0.00"
                          type: TICKETING
                        - amount: "0.00"
                          type: FORM_OF_PAYMENT
                      grandTotal: "8514.96"
                      total: "8514.96"
                    pricingOptions:
                      fareType:
                        - PUBLISHED
                      includedCheckedBagsOnly: true
                    source: GDS
                    travelerPricings:
                      - fareDetailsBySegment:
                          - brandedFare: BUSINESS
                            cabin: BUSINESS
                            class: C
                            fareBasis: CFFBR
                            includedCheckedBags:
                              quantity: 2
                            segmentId: "40"
                          - brandedFare: BUSINESS
                            cabin: BUSINESS
                            class: J
                            fareBasis: CFFBR
                            includedCheckedBags:
                              quantity: 2
                            segmentId: "41"
                          - brandedFare: BUSINESS
                            cabin: BUSINESS
                            class: J
                            fareBasis: CFFBR
                            includedCheckedBags:
                              quantity: 2
                            segmentId: "42"
                          - brandedFare: FULLFLEX
                            cabin: ECONOMY
                            class: Y
                            fareBasis: YFFBR
                            includedCheckedBags:
                              quantity: 1
                            segmentId: "81"
                          - brandedFare: FULLFLEX
                            cabin: ECONOMY
                            class: Y
                            fareBasis: YFFBR
                            includedCheckedBags:
                              quantity: 1
                            segmentId: "82"
                        fareOption: STANDARD
                        price:
                          base: "4749.00"
                          currency: USD
                          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
                          total: "4849.48"
                        travelerId: "1"
                        travelerType: ADULT
                      - fareDetailsBySegment:
                          - brandedFare: BUSINESS
                            cabin: BUSINESS
                            class: C
                            fareBasis: CFFBR
                            includedCheckedBags:
                              quantity: 2
                            segmentId: "40"
                          - brandedFare: BUSINESS
                            cabin: BUSINESS
                            class: J
                            fareBasis: CFFBR
                            includedCheckedBags:
                              quantity: 2
                            segmentId: "41"
                          - brandedFare: BUSINESS
                            cabin: BUSINESS
                            class: J
                            fareBasis: CFFBR
                            includedCheckedBags:
                              quantity: 2
                            segmentId: "42"
                          - brandedFare: FULLFLEX
                            cabin: ECONOMY
                            class: Y
                            fareBasis: YFFBR
                            includedCheckedBags:
                              quantity: 1
                            segmentId: "81"
                          - brandedFare: FULLFLEX
                            cabin: ECONOMY
                            class: Y
                            fareBasis: YFFBR
                            includedCheckedBags:
                              quantity: 1
                            segmentId: "82"
                        fareOption: STANDARD
                        price:
                          base: "3565.00"
                          currency: USD
                          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
                          total: "3665.48"
                        travelerId: "2"
                        travelerType: CHILD
                    type: flight-offer
                    validatingAirlineCodes:
                      - AF
                remarks:
                  general:
                    - subType: GENERAL_MISCELLANEOUS
                      text: ONLINE BOOKING FROM INCREIBLE VIAJES
                ticketingAgreement:
                  delay: 6D
                  option: DELAY_TO_CANCEL
                travelers:
                  - contact:
                      emailAddress: jorge.gonzales833@telefonica.es
                      phones:
                        - countryCallingCode: "34"
                          deviceType: MOBILE
                          number: "480080076"
                    dateOfBirth: 1982-01-16
                    documents:
                      - birthPlace: Madrid
                        documentType: PASSPORT
                        expiryDate: 2025-04-14
                        holder: true
                        issuanceCountry: ES
                        issuanceDate: 2015-04-14
                        issuanceLocation: Madrid
                        nationality: ES
                        number: "00000000"
                        validityCountry: ES
                    gender: MALE
                    id: "1"
                    name:
                      firstName: JORGE
                      lastName: GONZALES
                  - contact:
                      emailAddress: jorge.gonzales833@telefonica.es
                      phones:
                        - countryCallingCode: "34"
                          deviceType: MOBILE
                          number: "480080076"
                    dateOfBirth: 2012-10-11
                    gender: FEMALE
                    id: "2"
                    name:
                      firstName: ADRIANA
                      lastName: GONZALES
                type: flight-order
            properties:
              data:
                $ref: "#/definitions/FlightOrder"
            title: FlightOrderQuery
      responses:
        "201":
          $ref: "#/responses/returnFlightOrders"
        "400":
          $ref: "#/responses/400_Book"
        default:
          $ref: "#/responses/500"
      summary: Create Order associated to the Flight offers.
      tags:
        - Booking
definitions:
  AdditionalServiceType:
    description: additional service type
    enum:
      - CHECKED_BAGS
      - MEALS
      - SEATS
      - OTHER_SERVICES
    example: CHECKED_BAGS
    type: string
  Address:
    description: address information
    properties:
      cityName:
        description: "Full city name. Example: Dublin"
        pattern: "[a-zA-Z -]{1,35}"
        type: string
      countryCode:
        description: country code [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
        pattern: "[a-zA-Z]{2}"
        type: string
      lines:
        description: |-
          Line 1 = Street address, Line 2 = Apartment, suite, unit, building, floor, etc 
          Each line is limited to 35 characters
        items:
          type: string
        type: array
      postalBox:
        description: E.g. BP 220
        type: string
      postalCode:
        description: "Example: 74130"
        type: string
      stateName:
        description: Full state name
        type: string
    type: object
  AirTravelDocument:
    allOf:
      - $ref: "#/definitions/AirTravelDocumentCommon"
      - properties:
          segmentIds:
            description: Ids of the impacted segments
            example: "1"
            items:
              type: string
            type: array
          travelerId:
            description: id of the impacted traveler
            example: "1"
            type: string
        type: object
    description: ticket information
    title: AirTravelDocument
  AirTravelDocumentCommon:
    properties:
      documentNumber:
        description: Identifier of the travel document prefixed by its owner code [NALC - 3 digits]. Can either be a primary or a conjunctive document number. Necessary for TicketingReference definition.
        type: string
      documentStatus:
        description: Status of the travel document contained in the fare element
        enum:
          - ISSUED
          - REFUNDED
          - VOID
          - ORIGINAL
          - EXCHANGED
        type: string
      documentType:
        description: Type of the travel document
        enum:
          - ETICKET
          - PTICKET
          - EMD
          - MCO
        type: string
    type: object
  AircraftEntry:
    additionalProperties:
      description: the manufacturer/model of aircraft
      type: string
  AircraftEquipment:
    description: information related to the aircraft
    properties:
      code:
        description: |
          IATA aircraft code (http://www.flugzeuginfo.net/table_accodes_iata_en.php)
        example: "318"
        pattern: "[a-zA-Z0-9]{3}"
        type: string
  AirlineRemark:
    properties:
      airlineCode:
        description: |
          Code of the airline following IATA standard ([IATA table codes](http://www.iata.org/publications/Pages/code-search.aspx))

          When it apply to any airline, value is YY.
        example: AF
        type: string
      flightOfferIds:
        description: Id of the concern flightOffers
        example: "1"
        items:
          type: string
        maxItems: 6
        minItems: 1
        type: array
      keyword:
        description: keyword code - only applicable for subType Keyword
        example: PARK
        type: string
      subType:
        $ref: "#/definitions/AirlineRemarkType"
      text:
        description: remark free text
        example: CAR PARK
        type: string
      travelerIds:
        description: Id of the concerned traveler
        example: "1"
        items:
          type: string
        type: array
    required:
      - subType
      - airlineCode
      - text
    title: AirlineRemark
    type: object
  AirlineRemarkType:
    description: airline remark type
    enum:
      - OTHER_SERVICE_INFORMATION
      - KEYWORD
      - OTHER_SERVICE
      - CLIENT_ID
      - ADVANCED_TICKET_TIME_LIMIT
    example: KEYWORD
    type: string
  AllotmentDetails:
    properties:
      tourName:
        description: The tour name agreed for this specific allotment.
        type: string
      tourReference:
        description: The tour reference agreed for this specific allotment.
        type: string
    title: AllotmentDetails
    type: object
  AssociatedRecord:
    allOf:
      - $ref: "#/definitions/AssociatedRecordCommon"
      - properties:
          flightOfferId:
            description: id of the impacted flight offer
            example: "1"
            type: string
        type: object
    description: record associated to the order
    title: associated record
  AssociatedRecordCommon:
    description: describes the relation between the current reservation and another one
    properties:
      creationDate:
        description: Creation date of the referenced reservation. Date and time in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) YYYY-MM-ddThh:mm:ss.sss format, e.g. 2019-07-09T12:30:00.000
        example: 2019-07-09T12:30:00.000
        type: string
      originSystemCode:
        description: Designates the system which has originated the referenced reservation.
        maxLength: 3
        minLength: 2
        type: string
      reference:
        description: Record locator [Amadeus or OA] with which the current reservation is related. In case of a codeshare relation, it enables to identify the operating PNR.
        type: string
    type: object
  AutomatedProcess:
    allOf:
      - $ref: "#/definitions/AutomatedProcessCommon"
      - properties:
          dateTime:
            description: Datetime limit at which the process takes action in case issuance is not done.
            format: date-time
            type: string
          delay:
            description: Delay before applying process in days
            type: string
          officeId:
            description: Office into which the process must be triggered.
            example: NCE1A0955
            type: string
        type: object
    description: automatic process applied to the Order
    title: Automated Process
  AutomatedProcessCode:
    description: queuing action to be taken
    enum:
      - IMMEDIATE
      - DELAYED
      - ERROR
    example: IMMEDIATE
    type: string
  AutomatedProcessCommon:
    description: Provides information on ticketing arrangements and Amadeus Time Limits
    properties:
      code:
        $ref: "#/definitions/AutomatedProcessCode"
      queue:
        description: Identifies the queue onto which PNR must be automatically placed upon process execution.
        properties:
          category:
            type: string
          number:
            type: string
        title: Queue
        type: object
      text:
        description: Free text
        type: string
    type: object
  B2bWallet:
    description: b2b wallet
    properties:
      cardFriendlyName:
        description: card name
        example: CB1
        pattern: "[a-zA-Z0-9]{1,35}"
        type: string
      cardId:
        description: card identifier
        example: "1245365895336"
        readOnly: true
        type: string
      cardUsageName:
        description: card usage name
        type: string
      flightOfferIds:
        description: Id of the concern flightOffers
        example: "1"
        items:
          type: string
        maxItems: 6
        minItems: 1
        type: array
      reportingData:
        items:
          properties:
            name:
              example: reconcil1
              type: string
            value:
              example: data1
              type: string
          title: reportingData
          type: object
        title: reportingData
        type: array
      virtualCreditCardDetails:
        $ref: "#/definitions/VirtualCreditCardDetails"
        readOnly: true
    title: B2bWallet
    type: object
  BaggageAllowance:
    description: baggageAllowance
    properties:
      quantity:
        description: Total number of units
        example: 1
        type: integer
      weight:
        description: Weight of the baggage allowance
        example: 20
        type: integer
      weightUnit:
        description: Code to qualify unit as pounds or kilos
        example: KG
        type: string
    type: object
  BaseName:
    description: description of the name of a physical person
    properties:
      firstName:
        description: First name.
        type: string
      lastName:
        description: Last name.
        type: string
      middleName:
        description: Middle name(s), for example "Lee" in "John Lee Smith".
        type: string
    type: object
  CarrierEntry:
    additionalProperties:
      description: the carrier name
      type: string
  Co2Emission:
    properties:
      cabin:
        $ref: "#/definitions/TravelClass"
      weight:
        description: Weight of Co2 emitted for the concerned segment
        example: 90
        type: integer
      weightUnit:
        description: Code to qualify unit as pounds or kilos
        example: KG
        type: string
    type: object
  Collection_Meta_Link:
    properties:
      count:
        example: 1
        type: integer
      links:
        example:
          self: https://test.api.amadeus.com/v1/area/resources?param=value
        properties:
          first:
            example: https://test.api.amadeus.com/v1/area/resources?...
            format: uri
            type: string
          last:
            example: https://test.api.amadeus.com/v1/area/resources?...
            format: uri
            type: string
          next:
            example: https://test.api.amadeus.com/v1/area/resources?...
            format: uri
            type: string
          previous:
            example: https://test.api.amadeus.com/v1/area/resources?...
            format: uri
            type: string
          self:
            example: https://test.api.amadeus.com/v1/area/resources?...
            format: uri
            type: string
          up:
            example: https://test.api.amadeus.com/v1/area/resources?...
            format: uri
            type: string
        title: CollectionLinks
        type: object
    title: Collection_Meta
    type: object
  Contact:
    allOf:
      - $ref: "#/definitions/ContactDictionary"
      - properties:
          companyName:
            description: Name of the company
            example: AMADEUS
            type: string
          emailAddress:
            description: Email address (e.g. john@smith.com)
            example: support@mail.com
            type: string
          phones:
            description: Phone numbers
            items:
              $ref: "#/definitions/Phone"
            maxItems: 3
            type: array
        type: object
    description: contact information
  ContactDictionary:
    description: represents a contact
    properties:
      address:
        $ref: "#/definitions/Address"
      addresseeName:
        $ref: "#/definitions/Name"
        description: the name of the person addressed by these contact details
      language:
        description: the preferred language of communication with this Contact
        type: string
      purpose:
        $ref: "#/definitions/ContactPurpose"
    type: object
  ContactPurpose:
    description: |-
      the purpose for which this contact is to be used.
       - STANDARD for standard use, comunication, advertissement etc...
       - INVOICE for your invoice contact, usually its your billing adress. it's mandatory in france when you buy online
       - STANDARD_WITHOUT_TRANSMISSION is standard contact that are not share with third party outside of Amadeus
    enum:
      - STANDARD
      - INVOICE
      - STANDARD_WITHOUT_TRANSMISSION
    type: string
  CreditCard:
    allOf:
      - $ref: "#/definitions/CreditCardCommon"
      - properties:
          flightOfferIds:
            description: Id of the concern flightOffers
            example: "1"
            items:
              type: string
            maxItems: 6
            minItems: 1
            type: array
          securityCode:
            description: card security code
            example: "123"
            type: string
        type: object
    description: credit card
    title: creditCard
    type: object
  CreditCardBrand:
    description: credit card brand
    enum:
      - VISA
      - AMERICAN_EXPRESS
      - MASTERCARD
      - VISA_ELECTRON
      - VISA_DEBIT
      - MASTERCARD_DEBIT
      - MAESTRO
      - DINERS
      - EASYPAY
    example: VISA
    type: string
  CreditCardCommon:
    description: credit card common attribute
    properties:
      brand:
        $ref: "#/definitions/CreditCardBrand"
      expiryDate:
        description: credit card expiration date following [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (YYYY-MM format, e.g. 2012-08)
        example: 2021-08
        type: string
      holder:
        description: card holder as on the card
        example: MR DUPON DAMIEN
        type: string
      number:
        description: card number
        example: "4012999999999999"
        pattern: "[a-zA-Z0-9]{1,35}"
        type: string
    title: creditCardCommon
    type: object
  CurrencyEntry:
    additionalProperties:
      example: EUR
      type: string
  Dictionaries:
    properties:
      aircraft:
        $ref: "#/definitions/AircraftEntry"
      carriers:
        $ref: "#/definitions/CarrierEntry"
      currencies:
        $ref: "#/definitions/CurrencyEntry"
      locations:
        $ref: "#/definitions/LocationEntry"
    type: object
  Discount:
    description: traveler discount
    properties:
      cardNumber:
        description: resident card number
        example: 12568215Z
        pattern: "[0-9A-Z][0-9]{0,12}[A-Z]"
        type: string
      certificateNumber:
        description: resident certificate number
        example: 12568215Z
        pattern: "[0-9A-Z][0-9]{0,12}[A-Z]"
        type: string
      cityName:
        description: city of residence
        example: MADRID
        type: string
      subType:
        $ref: "#/definitions/DiscountType"
      travelerType:
        $ref: "#/definitions/DiscountTravelerType"
    title: Discount
    type: object
  DiscountTravelerType:
    description: type of discount applied
    enum:
      - SPANISH_CITIZEN
      - EUROPEAN_CITIZEN
      - GOVERNMENT_WORKER
      - MILITARY
      - MINOR_WITHOUT_ID
    example: SPANISH_CITIZEN
    type: string
  DiscountType:
    description: type of discount applied
    enum:
      - SPANISH_RESIDENT
      - AIR_FRANCE_DOMESTIC
      - AIR_FRANCE_COMBINED
      - AIR_FRANCE_METROPOLITAN
    example: SPANISH_RESIDENT
    type: string
  Document:
    description: the information that are found on an ID document
    properties:
      birthPlace:
        description: Birth place as indicated on the document
        type: string
      expiryDate:
        description: Date after which the document is not valid anymore.
        format: date
        type: string
      issuanceCountry:
        description: "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the country that issued the document"
        pattern: "[a-zA-Z]{2}"
        type: string
      issuanceDate:
        description: Date at which the document has been issued.
        format: date
        type: string
      issuanceLocation:
        description: A more precise information concerning the place where the document has been issued, when available. It may be a country, a state, a city or any other type of location. e.g. New-York
        type: string
      nationality:
        description: "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the nationality appearing on the document"
        pattern: "[a-zA-Z]{2}"
        type: string
      number:
        description: The document number (shown on the document) . E.g. QFU514563221J
        type: string
    type: object
  DocumentType:
    description: the nature/type of the document
    enum:
      - VISA
      - PASSPORT
      - IDENTITY_CARD
      - KNOWN_TRAVELER
      - REDRESS
    example: VISA
    type: string
  ElementaryPrice:
    description: elementaryPrice
    properties:
      amount:
        description: Amount of the fare. could be alpha numeric. Ex- 500.20 or 514.13A, 'A'signifies additional collection.
        type: string
      currencyCode:
        description: Currency type of the fare.
        type: string
    type: object
  EmergencyContact:
    description: emergency contact number
    properties:
      addresseeName:
        description: Adressee name (e.g. in case of emergency purpose it corresponds to name of the person to be contacted).
        pattern: "[a-zA-Z -]"
        type: string
      countryCode:
        description: Country code of the country (ISO3166-1). E.g. "US" for the United States
        pattern: "[A-Z]{2}"
        type: string
      number:
        description: Phone number. Composed of digits only. The number of digits depends on the country.
        pattern: "[0-9]{1,15}"
        type: string
      text:
        description: additional details
        type: string
    type: object
  Error_400:
    example:
      errors:
        - code: 477
          detail: invalid query parameter format
          source:
            example: CDG
            parameter: airport
          status: 400
          title: INVALID FORMAT
    properties:
      errors:
        items:
          $ref: "#/definitions/Issue"
        type: array
    required:
      - errors
    type: object
  Error_500:
    example:
      errors:
        - code: 141
          status: 500
          title: SYSTEM ERROR HAS OCCURRED
    properties:
      errors:
        items:
          $ref: "#/definitions/Issue"
        type: array
    required:
      - errors
    type: object
  Extended_Price:
    allOf:
      - properties:
          additionalServices:
            items:
              properties:
                amount:
                  example: "332.70"
                  type: string
                type:
                  $ref: "#/definitions/AdditionalServiceType"
              title: AdditionalService
              type: object
            title: AdditionalServices
            type: array
          billingCurrency:
            description: Currency of the payment. It may be different than the requested currency
            example: EUR
            type: string
          grandTotal:
            description: Total amount paid by the user (including fees and selected additional services).
            example: "987.00"
            type: string
          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.
            example: "1.00"
            type: string
        type: object
      - $ref: "#/definitions/Price"
    description: price information
    title: Price
    type: object
  Fee:
    description: a fee
    properties:
      amount:
        example: "332.70"
        type: string
      type:
        $ref: "#/definitions/FeeType"
  FeeType:
    description: type of fee
    enum:
      - TICKETING
      - FORM_OF_PAYMENT
      - SUPPLIER
    example: TICKETING
    type: string
  FlightEndPoint:
    allOf:
      - $ref: "#/definitions/OriginalFlightEndPoint"
      - 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
            example: 2017-10-23T20:00:00
            format: date-time
            type: string
        type: object
    description: departure or arrival information
    title: FlightEndPoint
  FlightOffer:
    properties:
      disablePricing:
        description: BOOK step ONLY - If true, allows to book a PNR without pricing. Only for the source "GDS"
        example: false
        type: boolean
      id:
        description: Id of the flight offer
        example: "1"
        type: string
      instantTicketingRequired:
        description: If true, inform that a ticketing will be required at booking step.
        example: false
        type: boolean
      itineraries:
        items:
          properties:
            duration:
              description: duration in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) PnYnMnDTnHnMnS format, e.g. PT2H10M for a duration of 2h10m
              example: PT2H10M
              type: string
            segments:
              items:
                $ref: "#/definitions/Segment"
              maxItems: 9
              minItems: 1
              title: Segments
              type: array
          required:
            - segments
          title: Itineraries
          type: object
        maxItems: 250
        minItems: 1
        type: array
      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
        example: 2018-06-19T00:00:00.000Z
        type: string
      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)
        example: false
        type: boolean
      numberOfBookableSeats:
        description: Number of seats bookable in a single request. Can not be higher than 9.
        example: 9
        maximum: 9
        minimum: 1
        type: number
      oneWay:
        description: If true, the flight offer fulfills only one originDestination and has to be combined with other oneWays to complete the whole journey.
        example: false
        type: boolean
      paymentCardRequired:
        description: If true, a payment card is mandatory to book this flight offer
        example: false
        type: boolean
      price:
        $ref: "#/definitions/Extended_Price"
      pricingOptions:
        properties:
          fareType:
            $ref: "#/definitions/PricingOptionsFareType"
            description: type of fare of the flight-offer
          includedCheckedBagsOnly:
            description: If true, returns the flight-offers with included checked bags only
            example: true
            type: boolean
          noPenaltyFare:
            description: If true, returns the flight-offers with no penalty fares only
            example: true
            type: boolean
          noRestrictionFare:
            description: If true, returns the flight-offers with no restriction fares only
            example: true
            type: boolean
          refundableFare:
            description: If true, returns the flight-offers with refundable fares only
            example: true
            type: boolean
        title: PricingOptions
        type: object
      source:
        $ref: "#/definitions/FlightOfferSource"
      travelerPricings:
        description: Fare information for each traveler/segment
        items:
          properties:
            associatedAdultId:
              description: if type="HELD_INFANT", corresponds to the adult traveler's id who will share the seat
              type: string
            fareDetailsBySegment:
              items:
                description: Fare details of the segment
                properties:
                  additionalServices:
                    properties:
                      chargeableCheckedBags:
                        $ref: "#/definitions/BaggageAllowance"
                        description: Details of chargeable checked bags
                        title: chargeableCheckedBags
                      chargeableSeatNumber:
                        description: seat number
                        example: 33D
                        pattern: "[1-9][0-9]{0,2}[A-Z]?"
                        type: string
                      otherServices:
                        description: Other services to add
                        example:
                          - PRIORITY_BOARDING
                        items:
                          $ref: "#/definitions/ServiceName"
                        type: array
                    title: AdditionalServicesRequest
                    type: object
                  allotmentDetails:
                    $ref: "#/definitions/AllotmentDetails"
                  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
                    example: LIGHTONE
                    type: string
                  cabin:
                    $ref: "#/definitions/TravelClass"
                  class:
                    description: The code of the booking class, a.k.a. class of service or Reservations/Booking Designator (RBD)
                    example: A
                    pattern: "[A-Z]{1}"
                    type: string
                  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.
                    example: ANNNNF4K
                    pattern: "[[A-Z0-9]{1,18}"
                    type: string
                  includedCheckedBags:
                    $ref: "#/definitions/BaggageAllowance"
                    description: Details of the included checked bags
                    title: includedCheckedBags
                  isAllotment:
                    description: True if the corresponding booking class is in an allotment
                    example: true
                    type: boolean
                  segmentId:
                    description: Id of the segment
                    example: "1"
                    type: string
                  sliceDiceIndicator:
                    $ref: "#/definitions/SliceDiceIndicator"
                required:
                  - segmentId
                title: FareDetailsBySegment
              maxItems: 18
              minItems: 1
              type: array
            fareOption:
              $ref: "#/definitions/TravelerPricingFareOption"
            price:
              $ref: "#/definitions/Price"
              description: price detail of the traveler
            travelerId:
              description: Id of the traveler
              example: "1"
              type: string
            travelerType:
              $ref: "#/definitions/TravelerType"
          required:
            - travelerId
            - fareOption
            - travelerType
            - fareDetailsBySegment
          title: TravelerPricing
        maxItems: 18
        minItems: 1
        title: TravelerPricings
        type: array
      type:
        description: the resource name
        example: flight-offer
        type: string
      validatingAirlineCodes:
        description: This option ensures that the system will only consider these airlines.
        example:
          - AF
        items:
          type: string
        maxItems: 9
        minItems: 1
        type: array
    required:
      - type
      - id
    title: Flight-offer
    type: object
  FlightOfferSource:
    description: source of the flight offer
    enum:
      - GDS
    example: GDS
    type: string
  FlightOrder:
    description: input parameter to create a flight order
    properties:
      associatedRecords:
        description: list of associated record
        items:
          $ref: "#/definitions/AssociatedRecord"
        readOnly: true
        type: array
      automatedProcess:
        description: list of automatic queuing
        items:
          $ref: "#/definitions/AutomatedProcess"
        maxItems: 31
        minItems: 0
        type: array
      contacts:
        description: list of general contact information
        items:
          $ref: "#/definitions/Contact"
        type: array
      flightOffers:
        description: list of flight offer
        items:
          $ref: "#/definitions/FlightOffer"
        maxItems: 6
        minItems: 1
        type: array
      formOfIdentifications:
        description: list of forms of identifications applicable to travelers by airline
        items:
          $ref: "#/definitions/FormOfIdentification"
        type: array
      formOfPayments:
        description: list of form of payments
        items:
          $ref: "#/definitions/FormOfPayment"
        maxItems: 6
        minItems: 1
        readOnly: true
        type: array
      id:
        description: unique identifier of the flight order
        example: MlpZVkFMfFdBVFNPTnwyMDE1LTExLTAy
        readOnly: true
        type: string
      ownerOfficeId:
        description: office Id where will be transfered the ownership of the order
        example: NCE1A0955
        type: string
      queuingOfficeId:
        description: office Id where to queue the order
        example: NCE1A0955
        type: string
      remarks:
        $ref: "#/definitions/Remarks"
        description: list of global remarks
      ticketingAgreement:
        $ref: "#/definitions/TicketingAgreement"
      tickets:
        description: list of tickets
        items:
          $ref: "#/definitions/AirTravelDocument"
        readOnly: true
        type: array
      travelers:
        description: list of travelers
        items:
          $ref: "#/definitions/Traveler"
        maxItems: 18
        minItems: 1
        type: array
      type:
        description: the resource name
        example: flight-order
        type: string
    required:
      - type
      - flightOffers
    title: FlightOrderCreateQuery
    type: object
  FlightSegment:
    description: defining a flight segment; including both operating and marketing details when applicable
    properties:
      aircraft:
        $ref: "#/definitions/AircraftEquipment"
      arrival:
        $ref: "#/definitions/FlightEndPoint"
      carrierCode:
        description: providing the airline / carrier code
        example: DL
        maxLength: 2
        minLength: 1
        type: string
      departure:
        $ref: "#/definitions/FlightEndPoint"
      duration:
        description: stop duration in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) PnYnMnDTnHnMnS format, e.g. PT2H10M
        example: PT2H10M
        type: string
      number:
        description: the flight number as assigned by the carrier
        example: "212"
        maxLength: 4
        minLength: 1
        type: string
      operating:
        $ref: "#/definitions/OperatingFlight"
      stops:
        description: information regarding the different stops composing the flight segment. E.g. technical stop, change of gauge...
        items:
          $ref: "#/definitions/FlightStop"
        type: array
    type: object
  FlightStop:
    allOf:
      - $ref: "#/definitions/OriginalFlightStop"
      - 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
            example: 2017-10-23T20:00:00
            format: date-time
            type: string
          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
            example: 2017-10-23T20:00:00
            format: date-time
            type: string
        type: object
    description: details of stops for direct or change of gauge flights
    title: FlightStop
  FormOfIdentification:
    description: alternative means of identifying stakeholders for eTicket.
    properties:
      carrierCode:
        description: providing the airline / carrier code
        example: DL
        maxLength: 2
        minLength: 1
        type: string
      flightOfferIds:
        description: Id of the concerned flightOffers
        example: "1"
        items:
          type: string
        maxItems: 6
        minItems: 1
        type: array
      identificationType:
        description: Type of identification
        enum:
          - DRIVERS_LICENSE
          - PASSPORT
          - NATIONAL_IDENTITY_CARD
          - BOOKING_CONFIRMATION
          - TICKET
          - OTHER_ID
        example: PASSPORT
        type: string
      number:
        description: identification number relative to the type of identification either ticket number, booking number, passport number, identity card number, drivers licence number, other ID
        example: XN0019390
        type: string
      travelerIds:
        description: Ids of the concerned travelers
        example: "1"
        items:
          type: string
        type: array
    title: FormOfIdentification
    type: object
  FormOfPayment:
    description: form of payment used
    properties:
      b2bWallet:
        $ref: "#/definitions/B2bWallet"
        description: payment with the solution B2B Wallet
      creditCard:
        $ref: "#/definitions/CreditCard"
        description: payment with a credit card
      other:
        $ref: "#/definitions/OtherMethod"
        description: payment with an other method
    title: Form Of Payment
    type: object
  GeneralRemark:
    properties:
      category:
        description: remark category
        example: Z
        pattern: "[A-Z]{1}"
        type: string
      flightOfferIds:
        description: Id of the concern flightOffers
        example: "1"
        items:
          type: string
        maxItems: 6
        minItems: 1
        type: array
      subType:
        $ref: "#/definitions/GeneralRemarkType"
      text:
        description: remark free text
        example: PASSENGER NEED ASSISTANCE
        type: string
      travelerIds:
        description: Id of the concerned traveler
        example: "1"
        items:
          type: string
        type: array
    required:
      - subType
      - text
    title: GeneralRemark
    type: object
  GeneralRemarkType:
    description: general remark type
    enum:
      - GENERAL_MISCELLANEOUS
      - CONFIDENTIAL
      - INVOICE
      - QUALITY_CONTROL
      - BACKOFFICE
      - FULFILLMENT
      - ITINERARY
      - TICKETING_MISCELLANEOUS
      - TOUR_CODE
    example: GENERAL_MISCELLANEOUS
    type: string
  IdentityDocument:
    allOf:
      - $ref: "#/definitions/Document"
      - properties:
          birthCountry:
            description: "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the country of birth"
            example: FR
            pattern: "[a-zA-Z]{2}"
            type: string
          documentType:
            $ref: "#/definitions/DocumentType"
          holder:
            description: boolean to specify if the traveler is the holder of the document
            example: true
            type: boolean
          validityCountry:
            description: "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the country where the document is valid"
            example: IN
            pattern: "[a-zA-Z]{2}"
            type: string
        type: object
    description: documents of the traveler
    title: traveler documents
  Issue:
    properties:
      code:
        description: an application-specific error code
        format: int64
        type: integer
      detail:
        description: explanation of the error
        type: string
      source:
        description: an object containing references to the source of the error
        maxProperties: 1
        properties:
          example:
            description: a string indicating an example of the right value
            type: string
          parameter:
            description: a string indicating which URI query parameter caused the issue
            type: string
          pointer:
            description: a JSON Pointer [RFC6901] to the associated entity in the request document
            type: string
        title: Issue_Source
        type: object
      status:
        description: the HTTP status code applicable to this error
        type: integer
      title:
        description: a short summary of the error
        type: string
    type: object
  LocationEntry:
    additionalProperties:
      $ref: "#/definitions/LocationValue"
  LocationValue:
    properties:
      cityCode:
        description: City code associated to the airport
        example: PAR
        type: string
      countryCode:
        description: Country code of the airport
        example: FR
        type: string
  LoyaltyProgram:
    description: loyalty program information
    properties:
      id:
        description: loyalty program number
        example: "12357466574"
        type: string
      programOwner:
        description: loyalty program airline code
        example: AF
        type: string
    title: LoyaltyProgram
    type: object
  Name:
    allOf:
      - $ref: "#/definitions/BaseName"
      - properties:
          secondLastName:
            description: second last name
            type: string
        type: object
    description: name
    title: name
  OperatingFlight:
    description: information about the operating flight
    properties:
      carrierCode:
        description: providing the airline / carrier code
        example: DL
        maxLength: 2
        minLength: 1
        type: string
    type: object
  OriginalFlightEndPoint:
    description: departure or arrival information
    properties:
      iataCode:
        description: "[IATA airline codes](http://www.iata.org/publications/Pages/code-search.aspx)"
        example: JFK
        type: string
      terminal:
        description: terminal name / number
        example: T2
        type: string
    type: object
  OriginalFlightStop:
    description: details of stops for direct or change of gauge flights
    properties:
      duration:
        description: stop duration in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) PnYnMnDTnHnMnS format, e.g. PT2H10M
        example: PT2H10M
        type: string
      iataCode:
        description: "[IATA airline codes](http://www.iata.org/publications/Pages/code-search.aspx)"
        example: JFK
        type: string
    type: object
  OtherMethod:
    description: other payment method
    properties:
      flightOfferIds:
        description: Id of the concern flightOffers
        example: "1"
        items:
          type: string
        maxItems: 6
        minItems: 1
        type: array
      method:
        $ref: "#/definitions/OtherPaymentMethod"
    title: creditCard
    type: object
  OtherPaymentMethod:
    description: other payment method
    enum:
      - ACCOUNT
      - CHECK
      - CASH
      - NONREFUNDABLE
    example: CASH
    type: string
  Phone:
    description: phone information
    properties:
      countryCallingCode:
        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}"
        type: string
      deviceType:
        $ref: "#/definitions/PhoneDeviceType"
      number:
        description: Phone number. Composed of digits only. The number of digits depends on the country.
        pattern: "[0-9]{1,15}"
        type: string
    type: object
  PhoneDeviceType:
    description: Type of the device (Landline, Mobile or Fax)
    enum:
      - MOBILE
      - LANDLINE
      - FAX
    type: string
  Price:
    properties:
      base:
        description: Amount without taxes
        example: "632.70"
        type: string
      currency:
        example: USD
        type: string
      fees:
        description: List of applicable fees
        items:
          $ref: "#/definitions/Fee"
        type: array
      refundableTaxes:
        description: The amount of taxes which are refundable
        example: "200.00"
        type: string
      taxes:
        items:
          $ref: "#/definitions/Tax"
        type: array
      total:
        description: Total amount paid by the user
        example: "932.70"
        type: string
  PricingOptionsFareType:
    description: type of fare of the flight-offer
    example:
      - PUBLISHED
    items:
      enum:
        - PUBLISHED
      type: string
    type: array
  Remarks:
    description: remarks
    properties:
      airline:
        description: list of airline remarks
        items:
          $ref: "#/definitions/AirlineRemark"
        maxItems: 200
        minItems: 0
        type: array
      general:
        description: list of general remarks
        items:
          $ref: "#/definitions/GeneralRemark"
        maxItems: 200
        minItems: 0
        type: array
    title: Remarks
    type: object
  Segment:
    allOf:
      - properties:
          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   
            example: false
            type: boolean
          co2Emissions:
            description: Co2 informations
            items:
              $ref: "#/definitions/Co2Emission"
              title: Co2Emission
            minItems: 1
            type: array
          id:
            description: Id of the segment
            example: 1
            type: string
          numberOfStops:
            description: Number of stops
            example: 0
            type: integer
        type: object
      - $ref: "#/definitions/FlightSegment"
  ServiceName:
    description: type of service
    enum:
      - PRIORITY_BOARDING
      - AIRPORT_CHECKIN
    example: PRIORITY_BOARDING
    type: string
  SliceDiceIndicator:
    description: slice and Dice indicator, such as Local Availability, Sub OnD(Origin and Destination) 1 Availability and Sub OnD 2 Availability
    enum:
      - LOCAL_AVAILABILITY
      - SUB_OD_AVAILABILITY_1
      - SUB_OD_AVAILABILITY_2
    type: string
  Stakeholder:
    description: stakeholder definition
    properties:
      dateOfBirth:
        description: The date of birth in ISO 8601 format (yyyy-mm-dd)
        format: date
        type: string
      documents:
        description: Advanced Passenger Information - regulatory identity documents - SSR DOCS & DOCO elements
        items:
          $ref: "#/definitions/IdentityDocument"
        type: array
      gender:
        $ref: "#/definitions/StakeholderGender"
      id:
        description: item identifier
        type: string
      name:
        $ref: "#/definitions/Name"
    type: object
  StakeholderGender:
    description: Gender for individual
    enum:
      - MALE
      - FEMALE
      - UNSPECIFIED
      - UNDISCLOSED
    example: FEMALE
    title: Gender
    type: string
  Tax:
    description: a tax
    properties:
      amount:
        example: "332.70"
        type: string
      code:
        example: MX
        type: string
    type: object
  TicketingAgreement:
    description: ticketing agreement
    properties:
      dateTime:
        description: Exact date to apply automatic process if no issuance. YYYY-MM-DD format, e.g. 2019-06-07
        example: 2017-10-23
        readOnly: true
        type: string
      delay:
        description: Delay before applying automatic process if no issuance in days
        type: string
      option:
        $ref: "#/definitions/TicketingAgreementOption"
      segmentIds:
        description: Ids of the impacted segments
        example: "1"
        items:
          type: string
        readOnly: true
        type: array
    title: Ticketing Agreement
    type: object
  TicketingAgreementOption:
    description: |
      Ticketing agreement option
      * **CONFIRM**, when the payment is done
      * **DELAY_TO_QUEUE**, queue the reservation at a wished date if the payment is not done
      * **DELAY_TO_CANCEL**, cancel the reservation at a wished date if the payment is not done

      Queueing and cancellation occurs at local date and time. When no time is specified, reservation is queued or cancelled at 00:00.
    enum:
      - CONFIRM
      - DELAY_TO_QUEUE
      - DELAY_TO_CANCEL
    example: DELAY_TO_QUEUE
    type: string
  TravelClass:
    description: quality of service offered in the cabin where the seat is located in this flight. Economy, premium economy, business or first class
    enum:
      - ECONOMY
      - PREMIUM_ECONOMY
      - BUSINESS
      - FIRST
    example: PREMIUM_ECONOMY
    type: string
  Traveler:
    allOf:
      - $ref: "#/definitions/Stakeholder"
      - properties:
          contact:
            $ref: "#/definitions/Contact"
          discountEligibility:
            description: list of element that allow a discount.
            items:
              $ref: "#/definitions/Discount"
            maxItems: 10
            minItems: 0
            type: array
          emergencyContact:
            $ref: "#/definitions/EmergencyContact"
            description: emergency contact
          loyaltyPrograms:
            description: list of loyalty program followed by the traveler
            items:
              $ref: "#/definitions/LoyaltyProgram"
            maxItems: 10
            minItems: 0
            type: array
        type: object
    description: the traveler of the trip
    title: traveler element
  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
    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
    type: string
  TravelerType:
    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
    type: string
  VirtualCreditCardDetails:
    allOf:
      - $ref: "#/definitions/CreditCardCommon"
      - $ref: "#/definitions/ElementaryPrice"
    description: detail information of the virtual card
x-generatedAt: 2022-08-09T10:48:05.285Z
