Transfer Book

Books a transfer based on the offer returned by Transfer Search, capturing passenger details, pickup, and payment.

Documentation

Specifications

Examples

📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-address-common-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-address-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-agency-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-baggage-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-cancellation-rule-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-contact-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-corporation-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-credit-card-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-discount-code-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-distance-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-equipment-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-error-400-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-error-401-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-error-500-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-extra-service-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-issue-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-location-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-loyalty-number-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-name-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-partner-info-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-passenger-characteristics-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-payment-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-points-and-cash-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-seat-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-service-provider-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-stop-over-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-transfer-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-transfer-order-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-travel-segment-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-travel-segment-location-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/examples/transfer-book-vehicle-example.json

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-address-common-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-address-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-agency-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-baggage-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-cancellation-rule-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-contact-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-contact-with-address-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-corporation-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-credit-card-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-discount-code-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-distance-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-equipment-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-error-400-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-error-401-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-error-500-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-extra-service-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-fee-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-issue-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-location-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-loyalty-number-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-name-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-partner-info-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-passenger-characteristics-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-passenger-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-payment-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-points-and-cash-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-quotation-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-seat-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-service-provider-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-stop-over-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-tax-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-transfer-order-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-transfer-reservation-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-transfer-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-transportation-type-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-travel-segment-location-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-travel-segment-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-book-vehicle-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-address-common-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-address-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-agency-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-baggage-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-cancellation-rule-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-contact-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-contact-with-address-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-corporation-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-credit-card-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-discount-code-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-distance-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-equipment-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-error-400-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-error-401-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-error-500-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-extra-service-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-fee-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-issue-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-location-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-loyalty-number-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-name-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-partner-info-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-passenger-characteristics-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-passenger-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-payment-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-points-and-cash-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-quotation-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-seat-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-service-provider-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-stop-over-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-tax-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-transfer-order-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-transfer-reservation-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-transfer-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-transportation-type-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-travel-segment-location-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-travel-segment-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-structure/transfer-book-vehicle-structure.json

Other Resources

OpenAPI Specification

amadeus-transfer-book-openapi.yml Raw ↑
swagger: '2.0'
info:
  version: 1.11.1
  title: Transfer Booking
  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 for this API it may change dynamically. For your tests, use big cities like LON (London) or NYC (New-York).
host: test.api.amadeus.com
basePath: /v1
schemes:
  - https
consumes:
  - application/vnd.amadeus+json
  - application/json
produces:
  - application/vnd.amadeus+json
  - application/json
paths:
  /ordering/transfer-orders:
    post:
      tags:
        - Booking
      operationId: createTransferOrder
      summary: Amadeus Performs a Transfer Reservation.
      parameters:
        - in: query
          name: offerId
          type: string
          required: true
          description: transfer offer id from shopping/transfer-offers response
          x-example: '12345'
        - name: body
          in: body
          required: true
          schema:
            title: Body_Reservation
            required:
              - data
            properties:
              data:
                type: object
                title: Body_Reservation_Data
                required:
                  - passengers
                  - payment
                properties:
                  note:
                    description: note to driver
                    type: string
                  flightNumber:
                    description: flight number. Mandatory if service provider has setting "FLIGHT_NUMBER_REQUIRED"
                    type: string
                  passengers:
                    type: array
                    items:
                      $ref: '#/definitions/Passenger'
                  agency:
                    $ref: '#/definitions/Agency'
                  payment:
                    $ref: '#/definitions/Payment'
                  equipment:
                    type: array
                    items:
                      $ref: '#/definitions/Equipment'
                  extraServices:
                    type: array
                    items:
                      $ref: '#/definitions/ExtraService'
                  loyaltyNumber:
                    $ref: '#/definitions/LoyaltyNumber'
                  corporation:
                    $ref: '#/definitions/Corporation'
                  startConnectedSegment:
                    $ref: '#/definitions/TravelSegment'
                  endConnectedSegment:
                    $ref: '#/definitions/TravelSegment'
                example:
                  data:
                    note: Note to driver
                    passengers:
                      - firstName: John
                        lastName: Doe
                        title: MR
                        contacts:
                          phoneNumber: '+33123456789'
                          email: [email protected]
                        billingAddress:
                          line: Avenue de la Bourdonnais, 19
                          zip: '75007'
                          countryCode: FR
                          cityName: Paris
                    agency:
                      contacts:
                        - email:
                            address: [email protected]
                    payment:
                      methodOfPayment: CREDIT_CARD
                      creditCard:
                        number: '4111111111111111'
                        holderName: JOHN DOE
                        vendorCode: VI
                        expiryDate: '1018'
                        cvv: '111'
                    extraServices:
                      - code: EWT
                        itemId: EWT0291
                    equipment:
                      - code: BBS
                    corporation:
                      address:
                        line: 5 Avenue Anatole France
                        zip: '75007'
                        countryCode: FR
                        cityName: Paris
                      info:
                        AU: FHOWMD024
                        CE: 280421GH
                    startConnectedSegment:
                      transportationType: FLIGHT
                      transportationNumber: AF380
                      departure:
                        uicCode: '7400001'
                        iataCode: CDG
                        localDateTime: '2021-03-27T20:03:00'
                      arrival:
                        uicCode: '7400001'
                        iataCode: CDG
                        localDateTime: '2021-03-27T20:03:00'
                    endConnectedSegment:
                      transportationType: FLIGHT
                      transportationNumber: AF380
                      departure:
                        uicCode: '7400001'
                        iataCode: CDG
                        localDateTime: '2021-03-27T20:03:00'
                      arrival:
                        uicCode: '7400001'
                        iataCode: CDG
                        localDateTime: '2021-03-27T20:03:00'
            example: &id001
              data:
                note: Note to driver
                passengers:
                  - firstName: John
                    lastName: Doe
                    title: MR
                    contacts:
                      phoneNumber: '+33123456789'
                      email: [email protected]
                    billingAddress:
                      line: Avenue de la Bourdonnais, 19
                      zip: '75007'
                      countryCode: FR
                      cityName: Paris
                agency:
                  contacts:
                    - email:
                        address: [email protected]
                payment:
                  methodOfPayment: CREDIT_CARD
                  creditCard:
                    number: '4111111111111111'
                    holderName: JOHN DOE
                    vendorCode: VI
                    expiryDate: '1018'
                    cvv: '111'
                extraServices:
                  - code: EWT
                    itemId: EWT0291
                equipment:
                  - code: BBS
                corporation:
                  address:
                    line: 5 Avenue Anatole France
                    zip: '75007'
                    countryCode: FR
                    cityName: Paris
                  info:
                    AU: FHOWMD024
                    CE: 280421GH
                startConnectedSegment:
                  transportationType: FLIGHT
                  transportationNumber: AF380
                  departure:
                    uicCode: '7400001'
                    iataCode: CDG
                    localDateTime: '2021-03-27T20:03:00'
                  arrival:
                    uicCode: '7400001'
                    iataCode: CDG
                    localDateTime: '2021-03-27T20:03:00'
                endConnectedSegment:
                  transportationType: FLIGHT
                  transportationNumber: AF380
                  departure:
                    uicCode: '7400001'
                    iataCode: CDG
                    localDateTime: '2021-03-27T20:03:00'
                  arrival:
                    uicCode: '7400001'
                    iataCode: CDG
                    localDateTime: '2021-03-27T20:03:00'
          x-example: *id001
      responses:
        '201':
          $ref: '#/responses/transfer_order'
        '400':
          $ref: '#/responses/400_createTransferOrder'
        '401':
          $ref: '#/responses/401'
        default:
          $ref: '#/responses/500'
      description: ''
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
definitions:
  Transfer:
    type: object
    required:
      - transferType
      - start
      - serviceProvider
      - vehicle
      - quotation
      - methodsOfPaymentAccepted
    properties:
      transferType:
        type: string
        enum:
          - PRIVATE
          - SHARED
          - TAXI
          - HOURLY
          - AIRPORT_EXPRESS
          - AIRPORT_BUS
        description: |
          amadeus transfer service type

          value           | description                                 
          --------------  | ------------------------
          PRIVATE         | Private transfer from point to point
          SHARED          | Shared transfer from point to point
          TAXI            | Taxi reservation from point to point, price is estimated
          HOURLY          | Chauffeured driven transfer per hour
          AIRPORT_EXPRESS | Express Train from/to Airport
          AIRPORT_BUS     | Express Bus from/to Airport
        example: PRIVATE
      start:
        $ref: '#/definitions/Location'
      end:
        $ref: '#/definitions/Location'
      stopOvers:
        type: array
        items:
          $ref: '#/definitions/StopOver'
      passenegerCharacteristics:
        type: array
        items:
          $ref: '#/definitions/PassengerCharacteristics'
      duration:
        description: transfer duration in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) PnYnMnDTnHnMnS format, e.g. PT2H10M
        type: string
        example: PT2H30M
      vehicle:
        $ref: '#/definitions/Vehicle'
      serviceProvider:
        $ref: '#/definitions/ServiceProvider'
      partnerInfo:
        $ref: '#/definitions/PartnerInfo'
      quotation:
        $ref: '#/definitions/Quotation'
      converted:
        $ref: '#/definitions/Quotation'
      extraServices:
        type: array
        items:
          $ref: '#/definitions/ExtraService'
      equipment:
        type: array
        items:
          $ref: '#/definitions/Equipment'
      cancellationRules:
        type: array
        items:
          $ref: '#/definitions/CancellationRule'
      methodsOfPaymentAccepted:
        type: array
        description: list of payment methods, allowed by provider
        items:
          type: string
          description: Method of payment required when PaymentType equal BT (applicable only for reservation action).
          enum:
            - CREDIT_CARD
            - INVOICE
            - TRAVEL_ACCOUNT
            - PAYMENT_SERVICE_PROVIDER
      discountCodes:
        type: array
        description: list of discount codes
        items:
          $ref: '#/definitions/DiscountCode'
      distance:
        $ref: '#/definitions/Distance'
  TransferReservation:
    description: transfer reservation
    allOf:
      - type: object
        properties:
          confirmNbr:
            type: string
            description: transfer identifier - confirmation number, received from transfer supplier
          status:
            type: string
            description: status of transfer reservation
            enum:
              - CONFIRMED
              - CANCELLED
          note:
            type: string
            description: Note to transfer provider
          methodOfPayment:
            type: string
            description: Method of payment required when PaymentType equal BT (applicable only for reservation action).
            enum:
              - CREDIT_CARD
              - INVOICE
              - TRAVEL_ACCOUNT
              - PAYMENT_SERVICE_PROVIDER
          paymentServiceProvider:
            type: string
            description: payment service provider details will be passed to provider in case "PAYMENT_SERVICE_PROVIDER" method of payment.
            enum:
              - STRIPE_CONNECT
          offerId:
            type: string
            description: offer identifier
      - $ref: '#/definitions/Transfer'
  TransferOrder:
    type: object
    required:
      - type
      - id
      - transfers
    properties:
      type:
        description: the resource name
        type: string
        example: string-value
      id:
        type: string
        description: transfer order identifier
        example: '12345'
      reference:
        type: string
        description: reference of the Trip e.g. YNK4JQ
        example: string-value
      transfers:
        type: array
        description: transfer reservations, included in the order
        items:
          $ref: '#/definitions/TransferReservation'
      passengers:
        type: array
        description: passengers, related to the Transfer Order
        items:
          $ref: '#/definitions/Passenger'
      agency:
        $ref: '#/definitions/Agency'
  AddressCommon:
    description: address of the departure location
    properties:
      line:
        description: Address line with street, number, bulding, etc...
        type: string
        minLength: 1
        maxLength: 70
        example: string-value
      zip:
        description: Post office code number
        type: string
        minLength: 1
        maxLength: 120
        example: string-value
      countryCode:
        description: Country code (two character standard IATA country code)
        type: string
        pattern: '[a-zA-Z]{2}'
        example: FR
      cityName:
        description: City, town or postal station
        type: string
        minLength: 1
        maxLength: 35
        example: Paris
      stateCode:
        description: State code (two character standard IATA state code)
        type: string
        pattern: '[a-zA-Z0-9]{1-2}'
        example: string-value
  Address:
    type: object
    description: address information
    properties:
      line:
        description: Address line with street, number, bulding, etc...
        type: string
        minLength: 1
        maxLength: 70
        example: string-value
      zip:
        description: Post office code number
        type: string
        minLength: 1
        maxLength: 120
        example: string-value
      countryCode:
        description: Country code (two character standard IATA country code)
        type: string
        pattern: '[a-zA-Z]{2}'
        example: FR
      cityName:
        description: City, town or postal station
        type: string
        minLength: 1
        maxLength: 35
        example: Paris
      stateCode:
        description: State code (two character standard IATA state code)
        type: string
        pattern: '[a-zA-Z0-9]{1-2}'
        example: string-value
      latitude:
        description: latitude of the location
        type: number
        format: double
        example: 43.580418
      longitude:
        description: longitude of the location
        type: number
        format: double
        example: 7.125102
  Agency:
    type: object
    description: Agency email information.
    properties:
      contacts:
        type: array
        description: List of contact information
        items:
          type: object
          properties:
            email:
              type: object
              description: Email information.
              title: Email
              properties:
                address:
                  type: string
                  format: email
                  description: Email address (e.g. [email protected])
                  example: [email protected]
  Baggage:
    type: object
    properties:
      count:
        type: integer
        description: baggage capacity
        example: 3
      size:
        type: string
        description: "baggage size\n\ncode   | name                                 \n------ | ---------------------------- \nS \t   | Small\nM \t   | Medium\nL \t   | Large\n"
        enum:
          - S
          - M
          - L
        example: S
  CancellationRule:
    type: object
    description: cancellation rule information
    properties:
      ruleDescription:
        type: string
        description: description of cancellation rule
        example: Sample description text.
      feeType:
        type: string
        enum:
          - PERCENTAGE
          - VALUE
        description: |
          type of fee - percentage of total amount (PERCENTAGE) or fixed amount (VALUE)
        example: PERCENTAGE
      feeValue:
        type: string
        description: value of the fee, e.g. "100" or "12.50"
        example: string-value
      currencyCode:
        type: string
        pattern: '[A-Z]{3}'
        description: currency code of the fee in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format, e.g. USD, EUR
        example: EUR
      metricType:
        type: string
        description: type of metric
        enum:
          - MINUTES
          - HOURS
          - DAYS
          - YEARS
        example: MINUTES
      metricMin:
        type: string
        description: metric min value
        example: string-value
      metricMax:
        type: string
        description: metric max value
        example: string-value
  Contact:
    type: object
    properties:
      phoneNumber:
        type: string
        pattern: ([+]?)[0-9]{1,20}
        description: Contact phone number
        example: '+33123456789'
      email:
        type: string
        format: email
        description: Contact email
        example: [email protected]
  Corporation:
    type: object
    description: information about corporation
    properties:
      address:
        $ref: '#/definitions/AddressCommon'
      info:
        type: object
        description: "corporate information map. Possible keys\n\nkey    | name\n------ | ----------------------------\nAU\t   | Accounting Unit\nON\t   | Order Number\nDC\t   | Department Code\nCC\t   | Company Code\nCN\t   | Company Name\nIA\t   | Internal Account\nCE\t   | Cost Centre\nEN\t   | Employee Number\nPN\t   | Project Number\n"
        additionalProperties:
          type: string
        example:
          AU: Accounting Unit
          'ON': Order Number
          DC: Department Code
          CC: Company Code
          CN: Company Name
          IA: Internal Account
          CE: Cost Centre
          EN: Employee Number
          PN: Project Number
  CreditCard:
    type: object
    description: information about payment card
    required:
      - number
      - holderName
      - vendorCode
      - expiryDate
    properties:
      number:
        type: string
        pattern: '[0-9]{16}'
        description: card number
        example: 1
      holderName:
        type: string
        description: card holder name
        example: Sample Name
      vendorCode:
        type: string
        pattern: '[a-zA-Z]{2}'
        description: card vendor code, e.g VI – VISA, CA – MasterCard, AX – American Express etc
        example: string-value
      expiryDate:
        type: string
        pattern: ^(0[1-9]|1[0-2])[0-9]{2}$
        description: card expiry date in format MMYY, e.g. 0237 for February 2037
        example: '2026-08-15'
      cvv:
        type: string
        pattern: '[a-zA-Z0-9]{3,4}'
        description: cerification calue number, as indicated on the credit card. Only for query
        example: string-value
  DiscountCode:
    type: object
    description: discount object that gives access to negotiated prices
    properties:
      type:
        type: string
        description: describes type of discount
        enum:
          - CD
          - PC
        example: CD
      value:
        type: string
        description: |-
          discount code value. 
          "CD" type stands for corporate discount code - a number generated by provider in case of
            special agreement with a given subscriber is passed (airlines, TMC,
            corporation…). It gives to subscriber access to negotiated prices for
            transfer      
          "PC" - for promotional/campaign discount code - a voucher code generated by the
            provider valid for a given period of time or a given number of usage.
            The code is sent by customer to provider in order to get a discounted
            price.
        example: string-value
  Distance:
    properties:
      value:
        description: great-circle distance between two locations. This distance thus do not take into account traffic conditions; international boundaries; mountains; water; or other elements that might make the a nearby location hard to reach.
        type: integer
        example: 152
      unit:
        description: unit of the distance
        type: string
        example: KM
        enum:
          - KM
          - MI
  Equipment:
    type: object
    description: extra equipment information
    required:
      - code
    properties:
      code:
        type: string
        description: |
          extra equipment codes, which can take following values

          code   | name                                 
          ------ | -------------------------------------  
          BBS    | Baby stroller/Push chair
          BYC    | Bicycle rack
          CBB    | Cargo barrier rack
          CBF    | Cargo barrier front
          CBS    | Booster seat for child under 135cm or up to 12 years
          CSB    | Child seat determined by weight/age of child 1-3 years / 9-18 Kg
          CSI    | Child seat determined by weight/age of child 0-12 month/0-13Kg
          CST    | Child seat determined by weight/age of child 4-7 years/15 – 30 Kg
          SBR    | Snow board racks
          SKB    | Ski box
          SKR    | Ski rack
          TAB    | Travel Tablet 
          WAR    | Wheelchair access ramp
          WHC    | Wheelchair
          WIF    | Wi-Fi access
          CNT    | Charger cable
        enum:
          - BBS
          - BYC
          - CBB
          - CBF
          - CBS
          - CSB
          - CSI
          - CST
          - SBR
          - SKB
          - SKR
          - 'TAB '
          - WAR
          - WHC
          - WIF
          - CNT
        example: BBS
      itemId:
        type: string
        description: extra equipment identifier
        example: '12345'
      description:
        type: string
        description: extra equipment description
        example: Sample description text.
      quotation:
        $ref: '#/definitions/Quotation'
      converted:
        $ref: '#/definitions/Quotation'
      isBookable:
        type: boolean
        description: true if extra equipment is available for booking
        example: true
      taxIncluded:
        type: boolean
        description: true if tax included in extra equipment price
        example: true
      includedInTotal:
        type: boolean
        description: true if extra equipment price is included in total transfer amount
        example: '199.50'
  ExtraService:
    type: object
    required:
      - code
    properties:
      code:
        type: string
        description: |
          extra service code, which can take following values

          code   | name                                 
          ------ | ---------------------------- 
          DSL    | Driver language specified
          EWT    | Extra waiting time
          MAG    | Meet & Greet
          FLM    | Flight monitoring
          NWS    | Newspaper
          CAI    | Cancellation insurance
          WNR    | Wait and Return. Driver waits at destination and brings back the customer to pick-up point
        enum:
          - DSL
          - EWT
          - MAG
          - FLM
          - NWS
          - CAI
          - WNR
        example: DSL
      itemId:
        type: string
        description: extra service identifier
        example: '12345'
      description:
        type: string
        description: extra service description
        example: Sample description text.
      metricType:
        type: string
        description: extra service time metric type
        enum:
          - YEARS
          - DAYS
          - HOURS
          - MINUTES
        example: YEARS
      metricValue:
        type: string
        description: extra service metric value
        example: string-value
      quotation:
        $ref: '#/definitions/Quotation'
      converted:
        $ref: '#/definitions/Quotation'
      isBookable:
        type: boolean
        description: true if extra service is available for booking
        example: true
      taxIncluded:
        type: boolean
        description: true if tax included in extra service price
        example: true
      includedInTotal:
        type: boolean
        description: true if extra service price is included in total transfer amount
        example: '199.50'
  Fee:
    description: single fee information
    allOf:
      - $ref: '#/definitions/PointsAndCash'
      - type: object
        properties:
          currencyCode:
            type: string
            example: USD
          indicator:
            type: string
            description: fee category e.g. "AIRPORT", "CREDITCARD" ,"CANCELLATION"
  Location:
    type: object
    description: location information
    properties:
      dateTime:
        description: |
          date and time specified in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) YYYY-MM-DDThh:mm:ss format e.g. 2017-11-10T10:00:00
          not supported for stopOvers object
        type: string
        example: '2019-11-10T10:30:00'
      locationCode:
        type: string
        description: airport code from [IATA table codes](http://www.iata.org/publications/Pages/code-search.aspx), e.g. CDG.
        pattern: '[A-Za-z]{3}'
        example: CDG
      address:
        $ref: '#/definitions/Address'
      name:
        type: string
        description: Place name e.g. Airport Name, Hotel Name etc.
        example: Sample Name
      googlePlaceId:
        description: Google place id only for google address e.g. ChIJL-DOWeBv5kcRfTbh97PimNc.
        type: string
        example: ChIJrTLr-GyuEmsRBfy61i59si0
      uicCode:
        type: string
        description: UIC code defined by the worldwide railway organization e.g. 8600626
        example: string-value
  StopOver:
    description: Location of the stop over or the several stop over points. It can be defined either using IATA code or Address (address line, zip, country, city, state, latitude, longitude). Vehicle change via stop overs is not supported.
    properties:
      duration:
        description: transfer stop duration in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) PnYnMnDTnHnMnS format, e.g. PT2H10M.
        type: string
        example: PT2H30M
      sequenceNumber:
        description: sequence number of the stop e.g. 3
        type: number
        example: 1
      location:
        $ref: '#/definitions/Location'
  PassengerCharacteristics:
    properties:
      passengerTypeCode:
        description: Passenger type codes e.g. CHD , ADT. CHD is for child and ADT for Adult.
        type: string
        example: child
      age:
        type: integer
        description: Age of the Passenger (Mandatory if typeCode= “CHD”)
        example: 12
  LoyaltyNumber:
    type: object
    properties:
      program:
        type: string
        description: loyalty program name
        example: string-value
      value:
        type: string
        description: loyalty number value
        example: string-value
  Name:
    type: object
    description: description of the name of a physical person
    properties:
      type:
        description: The type of the Name
        type: string
        example: string-value
      firstName:
        description: First name.
        type: string
        example: Marie
      lastName:
        description: Last name.
        type: string
        example: Dupont
      title:
        description: Contains all the suffixes and prefixes that can be appended to a name - Mr, Miss, Pr. - E.g. " Mr".
        type: string
        example: string-value
  Passenger:
    description: passenger data
    allOf:
      - $ref: '#/definitions/Name'
      - type: object
        properties:
          contacts:
            $ref: '#/definitions/Contact'
          billingAddress:
            $ref: '#/definitions/AddressCommon'
  Payment:
    type: object
    description: |
      defines the payment in transfer reservation. For "CREDIT_CARD" - creditCard is mandatory, for "TRAVEL_ACCOUNT" - paymentReference is optional, for "PAYMENT_SERVICE_PROVIDER" - paymentServiceProvider and paymentReference are mandatory.
    properties:
      methodOfPayment:
        type: string
        description: Method of payment required when PaymentType equal BT (applicable only for reservation action).
        enum:
          - CREDIT_CARD
          - TRAVEL_ACCOUNT
          - PAYMENT_SERVICE_PROVIDER
        example: CREDIT_CARD
      paymentReference:
        type: string
        description: payment refence that will be passed to provider in case "TRAVEL_ACCOUNT" method of payment
        example: string-value
      paymentServiceProvider:
        type: string
        description: payment service provider details will be passed to provider in case "PAYMENT_SERVICE_PROVIDER" method of payment.
        enum:
          - STRIPE_CONNECT
        example: STRIPE_CONNECT
      creditCard:
        $ref: '#/definitions/CreditCard'
  PartnerInfo:
    type: object
    description: Information about partner/subprovider. Below settings configuration is not applicable for sub-provider. Fields 'code', 'name' and 'logoUrl' are not mandatory for sub-provider.
    properties:
      serviceProvider:
        $ref: '#/definitions/ServiceProvider'
  PointsAndCash:
    type: object
    properties:
      monetaryAmount:
        type: string
        example: '10.5'
  Quotation:
    description: quotation representing a price valuation and its components. The monetaryAmount at the root are the sum of base and all the taxes/fees/discounts
    allOf:
      - $ref: '#/definitions/PointsAndCash'
      - type: object
        properties:
          currencyCode:
            type: string
            example: USD
          isEstimated:
            type: boolean
            description: indicates if the price is pre-estimated prior to ride. Becomes mandatory for transferType = TAXI
          base:
            description: base price
            allOf:
              - $ref: '#/definitions/PointsAndCash'
          discount:
            description: discount amount of base price
            allOf:
              - $ref: '#/definitions/PointsAndCash'
          taxes:
            description: Taxes breakdown
            type: array
            items:
              $ref: '#/definitions/Tax'
          fees:
            description: Fees breakdown
            type: array
            items:
              $ref: '#/definitions/Fee'
          totalTaxes:
            $ref: '#/definitions/PointsAndCash'
          totalFees:
            $ref: '#/definitions/PointsAndCash'
  Seat:
    type: object
    properties:
      count:
        type: integer
        description: seat capacity
        example: 3
      row:
        type: string
        description: seat row
        example: front
      size:
        type: string
        description: seat size
        example: XL
  ServiceProvider:
    type: object
    description: information about provider
    required:
      - code
      - name
      - logoUrl
    properties:
      code:
        type: string
        pattern: '[a-zA-Z]{3}'
        description: provider code
        example: string-value
      name:
        type: string
        pattern: '[a-zA-Z]{30}'
        description: provider name
        example: Sample Name
      logoUrl:
        type: string
        description: URL to provider logo
        example: https://example.com/resource
      termsUrl:
        type: string
        description: URL to provider's terms and conditions page
        example: https://example.com/resource
      isPreferred:
        type: boolean
        description: indicates if sub-provider is preferred for the travel-seller
        example: true
      contacts:
        $ref: '#/definitions/ContactWithAddress'
      settings:
        type: array
        description: list of provider settings
        items:
          type: string
          description: provider setting
          enum:
            - BILLING_ADDRESS_REQUIRED
            - FLIGHT_NUMBER_REQUIRED
            - CVV_NUMBER_REQUIRED
      businessIdentification:
        description: Information about the Customer stakeholder participating to the described sales summary.
        properties:
          vatRegistrationNumber:
            type: string
            description: VAT (Value Added Tax) Registration Number of the customer applicable ot the current sales.
        example: string-value
  Tax:
    description: single tax information
    allOf:
      - type: obje

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