swagger: '2.0' info: version: 1.10.0 title: Flight Order Management x-tags: - '#online-retail' - '#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 BookingStatus information - Add included Meals content - Add extra bags options on Get Flight Order - **only available in Enterprise** - Add Margins and Discounts content from Margin Manager product - **only available in Enterprise** 1.5.0: - Add new Gender enum "UNSPECIFIED" and "UNDISCLOSED" - Add EasyPay credit card brand - **only available in Enterprise** 1.4.0: - Add new airlineRemark subtype "ADVANCED_TICKET_TIME_LIMIT" 1.3.0: - Add new sources "LTC" and "EAC" - **only available in Enterprise** 1.2.0: - Add PATCH flight Order End point - **only available in Enterprise** 1.1.0: - Add Delete flight Order End point - Add Patch flight Order End Point - **only available in Enterprise** 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/{flight-orderId}: parameters: - $ref: '#/parameters/flight-orderId' get: tags: - Booking operationId: getFlightOrder summary: Amadeus Retrieve a Given Flight Order responses: '200': $ref: '#/responses/returnFlightOrders' '400': $ref: '#/responses/400_GET_Order' '404': $ref: '#/responses/404' default: $ref: '#/responses/500' description: '' delete: tags: - Booking operationId: cancelFlightOrder summary: Amadeus Cancel a Given Flight Order responses: '204': $ref: '#/responses/204' '400': $ref: '#/responses/400_DELETE_Order' '404': $ref: '#/responses/404' default: $ref: '#/responses/500' description: '' 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_404: type: object properties: errors: type: array items: $ref: '#/definitions/Issue' required: - errors example: errors: - status: 404 code: 1797 title: NOT FOUND detail: no response found for this query parameter source: parameter: airport 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 code: description: an application-specific error code type: integer format: int64 title: description: a short summary of the error type: string detail: description: explanation of the error type: string 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 parameter: description: a string indicating which URI query parameter caused the issue type: string example: description: a string indicating an example of the right value type: string 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' bookingStatus: description: booking status of the segment type: string enum: - CONFIRMED - WAITLISTED - CANCELLED - PENDING - DENIED example: CONFIRMED segmentType: description: type of the segment type: string enum: - ACTIVE - PASSIVE - GHOST - STAFF example: GHOST isFlown: type: boolean description: indicator set to true if segment is flown example: true 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 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: includedCheckedBags $ref: '#/definitions/BaggageAllowance' description: Details of the included checked bags additionalServices: type: object title: AdditionalServicesRequest properties: chargeableCheckedBags: title: chargeableCheckedBags description: Details of chargeable checked bags $ref: '#/definitions/ChargeableCheckdBags' chargeableSeat: title: chargeableSeat description: Details of chargeable seat $ref: '#/definitions/ChargeableSeat' chargeableSeatNumber: type: string description: DEPRECATED - use the chargeableSeat attribute - seat number example: 33D pattern: '[1-9][0-9]{0,2}[A-Z]?' otherServices: type: array description: Other services to add items: $ref: '#/definitions/ServiceName' example: - PRIORITY_BOARDING Segment: allOf: - type: object properties: id: description: Id of the segment type: string example: 1 numberOfStops: description: Number of stops type: integer example: 0 blacklistedInEU: description: | When the flight has a marketing or/and operating airline that is identified as blacklisted by the European Commission. To improve travel safety, the European Commission regularly updates the list of the banned carriers from operating in Europe. It allows any Travel Agency located in the European Union to easily identify and hide any travel recommendation based on some unsafe airlines. The [list of the banned airlines](https://ec.europa.eu/transport/sites/transport/files/air-safety-list_en.pdf) is published in the Official Journal of the European Union, where they are included as annexes A and B to the Commission Regulation. The blacklist of an airline can concern all its flights or some specific aircraft types pertaining to the airline type: boolean example: false co2Emissions: description: Co2 informations type: array minItems: 1 items: title: Co2Emission $ref: '#/definitions/Co2Emission' - $ref: '#/definitions/FlightSegment' TravelerType: type: string description: | traveler type age restrictions : CHILD < 12y, HELD_INFANT < 2y, SEATED_INFANT < 2y, SENIOR >=60y enum: - ADULT - CHILD - SENIOR - YOUNG - HELD_INFANT - SEATED_INFANT - STUDENT example: ADULT AdditionalServiceType: type: string description: additional service type enum: - CHECKED_BAGS - MEALS - SEATS - OTHER_SERVICES example: CHECKED_BAGS FlightOfferSource: description: source of the flight offer type: string enum: - GDS example: GDS PricingOptionsFareType: type: array description: type of fare of the flight-offer items: type: string enum: - PUBLISHED example: - PUBLISHED TravelerPricingFareOption: description: | option specifying a group of fares, which may be valid under certain conditons Can be used to specify special fare discount for a passenger type: string enum: - STANDARD - INCLUSIVE_TOUR - SPANISH_MELILLA_RESIDENT - SPANISH_CEUTA_RESIDENT - SPANISH_CANARY_RESIDENT - SPANISH_BALEARIC_RESIDENT - AIR_FRANCE_METROPOLITAN_DISCOUNT_PASS - AIR_FRANCE_DOM_DISCOUNT_PASS - AIR_FRANCE_COMBINED_DISCOUNT_PASS - AIR_FRANCE_FAMILY - ADULT_WITH_COMPANION - COMPANION example: STANDARD SliceDiceIndicator: description: slice and Dice indicator, such as Local Availability, Sub OnD(Origin and Destination) 1 Availability and Sub OnD 2 Availability type: string enum: - LOCAL_AVAILABILITY - SUB_OD_AVAILABILITY_1 - SUB_OD_AVAILABILITY_2 AllotmentDetails: title: AllotmentDetails type: object 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 ChargeableCheckdBags: description: Details of chargeable checked bags allOf: - $ref: '#/definitions/BaggageAllowance' - type: object properties: id: description: Id of the chargeable bag type: string example: '1' ChargeableSeat: description: Details of chargeable seat type: object properties: id: description: Id of the chargeable seat type: string example: '1' number: type: string description: seat number example: 33D pattern: '[1-9][0-9]{0,2}[A-Z]?' Dictionaries: type: object properties: locations: $ref: '#/definitions/LocationEntry' aircraft: $ref: '#/definitions/AircraftEntry' currencies: $ref: '#/definitions/CurrencyEntry' carriers: $ref: '#/definitions/CarrierEntry' LocationValue: properties: cityCode: type: string description: City code associated to the airport example: PAR countryCode: type: string description: Country code of the airport example: FR ElementaryPrice: description: elementaryPrice type: object properties: amount: type: string description: Amount of the fare. could be alpha numeric. Ex- 500.20 or 514.13A, 'A'signifies additional collection. currencyCode: type: string description: Currency type of the fare. BaggageAllowance: description: baggageAllowance type: object properties: quantity: type: integer description: Total number of units example: 1 weight: type: integer description: Weight of the baggage allowance example: 20 weightUnit: type: string description: Code to qualify unit as pounds or kilos example: KG ServiceName: description: type of service type: string enum: - PRIORITY_BOARDING - AIRPORT_CHECKIN example: PRIORITY_BOARDING FlightOrder: title: FlightOrderCreateQuery type: object description: input parameter to create a flight order required: - type - flightOffers properties: type: description: the resource name type: string example: flight-order id: description: unique identifier of the flight order type: string example: MlpZVkFMfFdBVFNPTnwyMDE1LTExLTAy readOnly: true queuingOfficeId: description: office Id where to queue the order type: string example: NCE1A0955 ownerOfficeId: description: office Id where will be transfered the ownership of the order type: string example: NCE1A0955 associatedRecords: description: list of associated record type: array readOnly: true items: $ref: '#/definitions/AssociatedRecord' flightOffers: description: list of flight offer type: array minItems: 1 maxItems: 6 items: $ref: '#/definitions/FlightOffer' travelers: description: list of travelers type: array minItems: 1 maxItems: 18 items: $ref: '#/definitions/Traveler' remarks: description: list of global remarks $ref: '#/definitions/Remarks' formOfPayments: description: list of form of payments type: array minItems: 1 maxItems: 6 items: $ref: '#/definitions/FormOfPayment' ticketingAgreement: $ref: '#/definitions/TicketingAgreement' automatedProcess: description: list of automatic queuing type: array minItems: 0 maxItems: 31 items: $ref: '#/definitions/AutomatedProcess' contacts: description: list of general contact information type: array items: $ref: '#/definitions/Contact' tickets: description: list of tickets readOnly: true type: array items: $ref: '#/definitions/AirTravelDocument' formOfIdentifications: description: list of forms of identifications applicable to travelers by airline type: array items: $ref: '#/definitions/FormOfIdentification' Stakeholder: type: object description: stakeholder definition properties: id: description: item identifier type: string dateOfBirth: type: string format: date description: The date of birth in ISO 8601 format (yyyy-mm-dd) gender: $ref: '#/definitions/StakeholderGender' name: $ref: '#/definitions/Name' documents: type: array description: Advanced Passenger Information - regulatory identity documents - SSR DOCS & DOCO elements items: $ref: '#/definitions/IdentityDocument' StakeholderGender: type: string description: Gender for individual enum: - MALE - FEMALE - UNSPECIFIED - UNDISCLOSED title: Gender example: FEMALE IdentityDocument: title: traveler documents description: documents of the traveler allOf: - $ref: '#/definitions/Document' - type: object properties: documentType: $ref: '#/definitions/DocumentType' validityCountry: type: string 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}' birthCountry: type: string 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}' holder: type: boolean description: boolean to specify if the traveler is the holder of the document example: true Document: type: object description: the information that are found on an ID document properties: number: type: string description: The document number (shown on the document) . E.g. QFU514563221J issuanceDate: type: string description: Date at which the document has been issued. format: date expiryDate: type: string description: Date after which the document is not valid anymore. format: date issuanceCountry: type: string 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}' issuanceLocation: type: string 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 nationality: type: string 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}' birthPlace: type: string description: Birth place as indicated on the document DocumentType: type: string description: the nature/type of the document enum: - VISA - PASSPORT - IDENTITY_CARD - KNOWN_TRAVELER - REDRESS example: VISA EmergencyContact: type: object description: emergency contact number properties: addresseeName: type: string description: Adressee name (e.g. in case of emergency purpose it corresponds to name of the person to be contacted). pattern: '[a-zA-Z -]' countryCode: type: string description: Country code of the country (ISO3166-1). E.g. "US" for the United States pattern: '[A-Z]{2}' number: type: string description: Phone number. Composed of digits only. The number of digits depends on the country. pattern: '[0-9]{1,15}' text: type: string description: additional details LoyaltyProgram: title: LoyaltyProgram description: loyalty program information type: object properties: programOwner: type: string description: loyalty program airline code example: AF id: type: string description: loyalty program number example: '12357466574' FormOfIdentification: type: object description: alternative means of identifying stakeholders for eTicket. properties: identificationType: type: string description: Type of identification enum: - DRIVERS_LICENSE - PASSPORT - NATIONAL_IDENTITY_CARD - BOOKING_CONFIRMATION - TICKET - OTHER_ID example: PASSPORT carrierCode: type: string description: providing the airline / carrier code minLength: 1 maxLength: 2 example: DL number: type: string 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 travelerIds: description: Ids of the concerned travelers type: array items: type: string example: '1' flightOfferIds: description: Id of the concerned flightOffers type: array minItems: 1 maxItems: 6 items: type: string example: '1' title: FormOfIdentification Discount: title: Discount description: traveler discount type: object properties: subType: $ref: '#/definitions/DiscountType' cityName: type: string description: city of residence example: MADRID travelerType: $ref: '#/definitions/DiscountTravelerType' cardNumber: type: string description: resident card number example: 12568215Z pattern: '[0-9A-Z][0-9]{0,12}[A-Z]' certificateNumber: type: string description: resident certificate number example: 12568215Z pattern: '[0-9A-Z][0-9]{0,12}[A-Z]' DiscountType: description: type of discount applied type: string enum: - SPANISH_RESIDENT - AIR_FRANCE_DOMESTIC - AIR_FRANCE_COMBINED - AIR_FRANCE_METROPOLITAN example: SPANISH_RESIDENT DiscountTravelerType: description: type of discount applied type: string enum: - SPANISH_CITIZEN - EUROPEAN_CITIZEN - GOVERNMENT_WORKER - MILITARY - MINOR_WITHOUT_ID example: SPANISH_CITIZEN Traveler: title: traveler element description: the traveler of the trip allOf: - $ref: '#/definitions/Stakeholder' - type: object properties: emergencyContact: description: emergency contact $ref: '#/definitions/EmergencyContact' loyaltyPrograms: description: list of loyalty program followed by the traveler type: array minItems: 0 maxItems: 10 items: $ref: '#/definitions/LoyaltyProgram' discountEligibility: description: list of element that allow a discount. type: array minItems: 0 maxItems: 10 items: $ref: '#/definitions/Discount' contact: $ref: '#/definitions/Contact' Contact: description: contact information allOf: - $ref: '#/definitions/ContactDictionary' - type: object properties: phones: description: Phone numbers type: array maxItems: 3 items: $ref: '#/definitions/Phone' companyName: description: Name of the company type: string example: AMADEUS emailAddress: type: string description: Email address (e.g. john@smith.com) example: support@mail.com ContactPurpose: description: the purpose for which this contact is to be used type: string enum: - STANDARD - INVOICE - STANDARD_WITHOUT_TRANSMISSION ContactDictionary: description: represents a contact type: object properties: addresseeName: description: the name of the person addressed by these contact details $ref: '#/definitions/Name' address: $ref: '#/definitions/Address' language: description: the preferred language of communication with this Contact type: string purpose: $ref: '#/definitions/ContactPurpose' Name: title: name description: name allOf: - $ref: '#/definitions/BaseName' - type: object properties: secondLastName: description: second last name type: string BaseName: type: object 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 Phone: type: object description: phone information properties: deviceType: $ref: '#/definitions/PhoneDeviceType' countryCallingCode: type: string description: Country calling code of the phone number, as defined by the International Communication Union. Examples - "1" for US, "371" for Latvia. pattern: '[0-9+]{2,5}' number: type: string description: Phone number. Composed of digits only. The number of digits depends on the country. pattern: '[0-9]{1,15}' PhoneDeviceType: type: string description: Type of the device (Landline, Mobile or Fax) enum: - MOBILE - LANDLINE - FAX Address: type: object description: address information properties: lines: type: array description: Line 1 = Street address, Line 2 = Apartment, suite, unit, building, floor, etc items: type: string postalCode: type: string description: 'Example: 74130' countryCode: type: string description: country code [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) pattern: '[a-zA-Z]{2}' cityName: type: string description: 'Full city name. Example: Dublin' pattern: '[a-zA-Z -]{1,35}' stateName: type: string description: Full state name postalBox: type: string description: E.g. BP 220 TicketingAgreement: title: Ticketing Agreement description: ticketing agreement type: object properties: option: $ref: '#/definitions/TicketingAgreementOption' delay: description: Delay before applying automatic process if no issuance in days type: string dateTime: description: Exact date to apply automatic process if no issuance. YYYY-MM-DD format, e.g. 2019-06-07 type: string readOnly: true example: '2017-10-23' segmentIds: description: Ids of the impacted segments type: array readOnly: true items: type: string example: '1' 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. type: string enum: - CONFIRM - DELAY_TO_QUEUE - DELAY_TO_CANCEL example: DELAY_TO_QUEUE AutomatedProcessCommon: type: object description: Provides information on ticketing arrangements and Amadeus Time Limits properties: code: $ref: '#/definitions/AutomatedProcessCode' queue: title: Queue type: object description: Identifies the queue onto which PNR must be automatically placed upon process execution. properties: number: type: string category: type: string text: type: string description: Free text AutomatedProcess: title: Automated Process description: automatic process applied to the Order allOf: - $ref: '#/definitions/AutomatedProcessCommon' - type: object properties: delay: description: Delay before applying process in days type: string officeId: description: Office into which the process must be triggered. type: string example: NCE1A0955 dateTime: type: string format: date-time description: Datetime limit at which the process takes action in case issuance is not done. AutomatedProcessCode: type: string description: queuing action to be taken enum: - IMMEDIATE - DELAYED - ERROR example: IMMEDIATE Remarks: title: Remarks description: remarks type: object properties: general: description: list of general remarks type: array minItems: 0 maxItems: 200 items: $ref: '#/definitions/GeneralRemark' airline: description: list of airline remarks type: array minItems: 0 maxItems: 200 items: $ref: '#/definitions/AirlineRemark' GeneralRemark: title: GeneralRemark type: object required: - subType - text properties: subType: $ref: '#/definitions/GeneralRemarkType' category: description: remark category type: string example: Z pattern: '[A-Z]{1}' text: description: remark free text type: string example: PASSENGER NEED ASSISTANCE travelerIds: description: Id of the concerned traveler type: array items: type: string example: '1' flightOfferIds: description: Id of the concern flightOffers type: array minItems: 1 maxItems: 6 items: type: string example: '1' GeneralRemarkType: description: general remark type type: string enum: - GENERAL_MISCELLANEOUS - CONFIDENTIAL - INVOICE - QUALITY_CONTROL - BACKOFFICE - FULFILLMENT - ITINERARY - TICKETING_MISCELLANEOUS - TOUR_CODE example: GENERAL_MISCELLANEOUS AirlineRemark: title: AirlineRemark type: object required: - subType - airlineCode - text properties: subType: $ref: '#/definitions/AirlineRemarkType' keyword: description: keyword code - only applicable for subType Keyword type: string example: PARK 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. type: string example: AF text: description: remark free text type: string example: CAR PARK travelerIds: description: Id of the concerned traveler type: array items: type: string example: '1' flightOfferIds: description: Id of the concern flightOffers type: array minItems: 1 maxItems: 6 items: type: string example: '1' AirlineRemarkType: description: airline remark type type: string enum: - OTHER_SERVICE_INFORMATION - KEYWORD - OTHER_SERVICE - CLIENT_ID - ADVANCED_TICKET_TIME_LIMIT example: KEYWORD FormOfPayment: title: Form Of Payment description: form of payment used type: object properties: b2bWallet: description: payment with the solution B2B Wallet $ref: '#/definitions/B2bWallet' creditCard: description: payment with a credit card $ref: '#/definitions/CreditCard' other: description: payment with an other method $ref: '#/definitions/OtherMethod' B2bWallet: title: B2bWallet type: object description: b2b wallet properties: cardId: readOnly: true description: card identifier type: string example: '1245365895336' cardUsageName: description: card usage name type: string cardFriendlyName: description: card name type: string example: CB1 pattern: '[a-zA-Z0-9]{1,35}' reportingData: type: array title: reportingData items: title: reportingData type: object properties: name: type: string example: reconcil1 value: type: string example: data1 virtualCreditCardDetails: readOnly: true $ref: '#/definitions/VirtualCreditCardDetails' flightOfferIds: description: Id of the concern flightOffers type: array minItems: 1 maxItems: 6 items: type: string example: '1' VirtualCreditCardDetails: description: detail information of the virtual card allOf: - $ref: '#/definitions/CreditCardCommon' - $ref: '#/definitions/ElementaryPrice' CreditCard: title: creditCard type: object description: credit card allOf: - $ref: '#/definitions/CreditCardCommon' - type: object properties: securityCode: description: card security code type: string example: '123' flightOfferIds: description: Id of the concern flightOffers type: array minItems: 1 maxItems: 6 items: type: string example: '1' CreditCardCommon: title: creditCardCommon type: object description: credit card common attribute properties: brand: $ref: '#/definitions/CreditCardBrand' holder: description: card holder as on the card type: string example: MR DUPON DAMIEN number: description: card number type: string example: '4012999999999999' pattern: '[a-zA-Z0-9]{1,35}' expiryDate: description: credit card expiration date following [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (YYYY-MM format, e.g. 2012-08) type: string example: 2021-08 CreditCardBrand: description: credit card brand type: string enum: - VISA - AMERICAN_EXPRESS - MASTERCARD - VISA_ELECTRON - VISA_DEBIT - MASTERCARD_DEBIT - MAESTRO - DINERS - EASYPAY example: VISA OtherMethod: title: creditCard type: object description: other payment method properties: method: $ref: '#/definitions/OtherPaymentMethod' flightOfferIds: description: Id of the concern flightOffers type: array minItems: 1 maxItems: 6 items: type: string example: '1' OtherPaymentMethod: description: other payment method type: string enum: - ACCOUNT - CHECK - CASH - NONREFUNDABLE example: CASH AssociatedRecordCommon: type: object description: describes the relation between the current reservation and another one properties: reference: type: string 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. creationDate: type: string 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' originSystemCode: type: string description: Designates the system which has originated the referenced reservation. minLength: 2 maxLength: 3 AssociatedRecord: title: associated record description: record associated to the order allOf: - $ref: '#/definitions/AssociatedRecordCommon' - type: object properties: flightOfferId: type: string description: id of the impacted flight offer example: '1' AirTravelDocument: title: AirTravelDocument description: ticket information allOf: - $ref: '#/definitions/AirTravelDocumentCommon' - type: object properties: travelerId: type: string description: id of the impacted traveler example: '1' segmentIds: description: Ids of the impacted segments type: array items: type: string example: '1' AirTravelDocumentCommon: type: object properties: documentType: type: string description: Type of the travel document enum: - ETICKET - PTICKET - EMD - MCO documentNumber: type: string 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. documentStatus: type: string description: Status of the travel document contained in the fare element enum: - ISSUED - REFUNDED - VOID - ORIGINAL - EXCHANGED responses: '204': description: Successfully Deleted '404': description: Not Found schema: $ref: '#/definitions/Error_404' '500': description: Unexpected error schema: $ref: '#/definitions/Error_500' returnFlightOrders: description: Successful Operation schema: title: Success_Booking type: object required: - data properties: meta: $ref: '#/definitions/Collection_Meta_Link' warnings: type: array items: $ref: '#/definitions/Issue' data: $ref: '#/definitions/FlightOrder' dictionaries: $ref: '#/definitions/Dictionaries' example: data: type: flight-order id: MlpZVkFMfFdBVFNPTnwyMDE1LTExLTAy queuingOfficeId: NCE1A0950 associatedRecords: - reference: 2ZYVAL creationDateTime: '2018-07-13T20:17:00' originSystemCode: 1A flightOfferId: '1' travelers: - id: '1' dateOfBirth: '1982-01-16' name: firstName: STEPHANE lastName: MARTIN contact: phones: - countryCallingCode: '33' number: '487692704' documents: - documentType: PASSPORT number: '012345678' expiryDate: '2009-04-14' issuanceCountry: GB nationality: GB holder: true - id: '3' dateOfBirth: '2018-03-24' name: firstName: JULES lastName: MARTIN - id: '2' dateOfBirth: '2007-10-11' name: firstName: EMILIE lastName: MARTIN flightOffers: - id: '1' type: flight-offer source: GDS itineraries: - duration: PT2H segments: - id: '1' duration: PT2H aircraft: code: '320' numberOfStops: 0 blacklistedInEU: false carrierCode: IB operating: carrierCode: IB number: '3403' departure: at: '2018-09-22T10:15:00' terminal: W iataCode: ORY arrival: at: '2018-09-22T12:15:00' terminal: '4' iataCode: MAD co2Emissions: - weight: '100' weightUnit: KG cabin: ECONOMY - duration: PT1H20M segments: - id: '20' duration: PT1H20M aircraft: code: '320' numberOfStops: 0 blacklistedInEU: false carrierCode: IB operating: carrierCode: IB number: '3118' departure: at: '2018-09-26T23:05:00' terminal: '4' iataCode: MAD arrival: at: '2018-09-26T23:25:00' terminal: '1' iataCode: LIS co2Emissions: - weight: '100' weightUnit: KG cabin: ECONOMY - duration: PT4H30M segments: - id: '30' duration: PT2H aircraft: code: '320' numberOfStops: 0 blacklistedInEU: false carrierCode: IB operating: carrierCode: IB number: '3109' departure: at: '2018-10-04T12:35:00' terminal: '1' iataCode: LIS arrival: at: '2018-10-04T14:55:00' terminal: '4' iataCode: MAD co2Emissions: - weight: '100' weightUnit: KG cabin: ECONOMY - id: '31' duration: PT2H30M aircraft: code: '320' numberOfStops: 0 blacklistedInEU: false carrierCode: IB operating: carrierCode: IB number: '3444' departure: at: '2018-10-04T16:05:00' terminal: '4' iataCode: MAD arrival: at: '2018-10-04T18:05:00' terminal: W iataCode: ORY co2Emissions: - weight: '100' weightUnit: KG cabin: ECONOMY price: grandTotal: '689.21' total: '423.21' base: '242.00' currency: EUR billingCurrency: EUR fees: - type: SUPPLIER amount: '0' - type: FORM_OF_PAYMENT amount: '6' - type: TICKETING amount: '0' additionalServices: - type: CHECKED_BAGS amount: '100' - type: SEATS amount: '166' pricingOptions: fareType: - PUBLISHED includedCheckedBags: false validatingAirlineCodes: - IB travelerPricings: - travelerId: '1' fareOption: STANDARD travelerType: ADULT price: currency: EUR total: '200.94' base: '126' taxes: - code: YQ amount: '0.94' - code: CJ amount: '41.67' - code: FR amount: '31.33' fareDetailsBySegment: - segmentId: '1' cabin: ECONOMY fareBasis: ANNNNF4K brandedFare: LIGHTONE class: A isAllotment: true allotmentDetails: tourName: tour tourReference: ref sliceDiceIndicator: ABCDEF includedCheckedBags: quantity: 0 - segmentId: '20' cabin: ECONOMY fareBasis: ANNNNF4K brandedFare: LIGHTONE class: A isAllotment: true allotmentDetails: tourName: tour tourReference: ref sliceDiceIndicator: ABCDEF includedCheckedBags: quantity: 0 - segmentId: '30' cabin: ECONOMY fareBasis: ANNNNF4K brandedFare: LIGHTONE class: A isAllotment: true allotmentDetails: tourName: tour tourReference: ref sliceDiceIndicator: ABCDEF includedCheckedBags: quantity: 0 - segmentId: '31' cabin: ECONOMY fareBasis: ANNNNF4K brandedFare: LIGHTONE class: A isAllotment: true allotmentDetails: tourName: tour tourReference: ref sliceDiceIndicator: ABCDEF includedCheckedBags: quantity: 0 - travelerId: '2' fareOption: STANDARD travelerType: CHILD price: currency: EUR total: '180.94' base: '106' taxes: - code: YQ amount: '0.94' - code: CJ amount: '41.67' - code: FR amount: '31.33' fareDetailsBySegment: - segmentId: '1' cabin: ECONOMY fareBasis: ANNNNF4K brandedFare: LIGHTONE class: A isAllotment: true allotmentDetails: tourName: tour tourReference: ref sliceDiceIndicator: ABCDEF includedCheckedBags: quantity: 0 additionalServices: chargeableCheckedBags: quantity: 1 weight: 20 chargeableSeatNumber: 33D - segmentId: '20' cabin: ECONOMY fareBasis: ANNNNF4K brandedFare: LIGHTONE class: A isAllotment: true allotmentDetails: tourName: tour tourReference: ref sliceDiceIndicator: ABCDEF includedCheckedBags: quantity: 0 additionalServices: chargeableCheckedBags: quantity: 1 weight: 20 chargeableSeatNumber: 28A - segmentId: '30' cabin: ECONOMY fareBasis: ANNNNF4K brandedFare: LIGHTONE class: A isAllotment: true allotmentDetails: tourName: tour tourReference: ref sliceDiceIndicator: ABCDEF includedCheckedBags: quantity: 0 additionalServices: chargeableCheckedBags: quantity: 1 weight: 20 chargeableSeatNumber: 12C - segmentId: '31' cabin: ECONOMY fareBasis: ANNNNF4K brandedFare: LIGHTONE class: A isAllotment: true allotmentDetails: tourName: tour tourReference: ref sliceDiceIndicator: ABCDEF includedCheckedBags: quantity: 0 additionalServices: chargeableCheckedBags: quantity: 1 weight: 20 chargeableSeatNumber: 33D - travelerId: '3' fareOption: STANDARD travelerType: HELD_INFANT associatedAdultId: '1' price: currency: EUR total: '41.33' base: '10' taxes: - code: FR amount: '31.33' fareDetailsBySegment: - segmentId: '1' cabin: ECONOMY fareBasis: ANNNNF4K brandedFare: LIGHTONE class: A isAllotment: true allotmentDetails: tourName: tour tourReference: ref sliceDiceIndicator: ABCDEF includedCheckedBags: quantity: 0 - segmentId: '20' cabin: ECONOMY fareBasis: ANNNNF4K brandedFare: LIGHTONE class: A isAllotment: true allotmentDetails: tourName: tour tourReference: ref sliceDiceIndicator: ABCDEF includedCheckedBags: quantity: 0 - segmentId: '30' cabin: ECONOMY fareBasis: ANNNNF4K brandedFare: LIGHTONE class: A isAllotment: true allotmentDetails: tourName: tour tourReference: ref sliceDiceIndicator: ABCDEF includedCheckedBags: quantity: 0 - segmentId: '31' cabin: ECONOMY fareBasis: ANNNNF4K brandedFare: LIGHTONE class: A isAllotment: true allotmentDetails: tourName: tour tourReference: ref sliceDiceIndicator: ABCDEF includedCheckedBags: quantity: 0 ticketingAggreement: option: DELAY_TO_CANCEL dateTime: '2018-08-21T10:15:00.000' contacts: - companyName: AMADEUS purpose: STANDARD phones: - deviceType: FAX countryCallingCode: '33' number: '480080070' - deviceType: LANDLINE countryCallingCode: '33' number: '480080070' emailAddress: support@mail.com address: lines: - 485 route du Pin Montard postalCode: '06902' cityName: Sophia Antipolis Cedex countryCode: FR dictionaries: locations: CDG: cityCode: PAR countryCode: FR ORY: cityCode: PAR countryCode: FR MAD: cityCode: MAD countryCode: ES 400_GET_Order: description: | code | title ------- | ------------------------------------- 477 | INVALID FORMAT 4926 | INVALID DATA RECEIVED 32171 | MANDATORY DATA MISSING schema: $ref: '#/definitions/Error_400' 400_DELETE_Order: description: | code | title ------- | ------------------------------------- 4926 | INVALID DATA RECEIVED 32171 | MANDATORY DATA MISSING schema: $ref: '#/definitions/Error_400' parameters: flight-orderId: name: flight-orderId description: identifier of the flight order required: true in: path type: string x-example: eJzTd9f3s4gKC%2FMEAAt8Ans%3D x-generatedAt: '2023-02-01T12:57:32.468Z'