v1

latestOpenAPI 3.0.02026-08-061029011.1 MB
Booking
Unreleased

Single Payload Booking

As an alternative to the booking workflow that takes place in a workbench session, you can send all booking details and commit a single payload to create a booking. The single payload book request does not support any of the optional steps in the booking workflow, such as adding seats or ancillaries.

post/air/book/reservation/reservations/build

Headers

TraceIdstring
Example:TraceID_123456789

Identifier used to correlate Air API invocations across a multi-call business flows.

XAUTH_TRAVELPORT_ACCESSGROUPstring
Example:19Y88702-C27A-4E5D-829A-89D7016688B1

Identifies the Travelport access group with which the caller is associated

travelportPlusSessionIdentifierstring
Example:49f58f5f-c443-43b4-9f5d-be405fd00a01

travelportPlusSessionIdentifier used to maintain an established agency session

TVP-PCC-Corestring
Example:DU7_1G

Allows user to pass PCC instead of Access Group ID

Request body

Example request

{
  "ReservationQueryBuild": {
    "@type": "ReservationQueryBuild",
    "ReservationBuild": {
      "@type": "ReservationBuildFromProducts",
      "autoDeleteDate": "2011-01-24",
      "receivedFrom": "TW",
      "issuance": "Ticket",
      "Traveler": [
        {
          "@type": "Traveler",
          "Identifier": {
            "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
            "authority": "TVPT"
          }
        }
      ],
      "FormOfPayment": [
        {
          "@type": "FormOfPaymentPaymentCard",
          "Identifier": {
            "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
            "authority": "TVPT"
          },
          "activeInd": true
        }
      ],
      "Payment": [
        {
          "@type": "Payment",
          "Identifier": {
            "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
            "authority": "TVPT"
          }
        }
      ],
      "ReservationComment": [
        {
          "@type": "ReservationComment"
        }
      ],
      "PrimaryContact": [
        {
          "@type": "PrimaryContact",
          "Identifier": {
            "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
            "authority": "TVPT"
          }
        }
      ],
      "SpecialService": [
        {
          "@type": "SpecialService",
          "Identifier": {
            "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
            "authority": "TVPT"
          }
        }
      ],
      "Accounting": {
        "@type": "Accounting",
        "Identifier": {
          "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
          "authority": "TVPT"
        }
      },
      "DocumentOverrides": [
        {
          "@type": "DocumentOverrides",
          "id": "documentoverrides_001",
          "Identifier": {
            "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
            "authority": "TVPT"
          }
        }
      ],
      "Notification": [
        {
          "QueueNumber": [
            {
              "value": 10,
              "category": "CAE",
              "subCategory": "Date Range sub-category",
              "overridePCC": "0XS4"
            }
          ],
          "Comment": "Optional free text"
        }
      ],
      "CustomAuxiliarySegment": [
        {
          "@type": "CustomAuxiliarySegment",
          "id": "aux_001",
          "Identifier": {
            "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
            "authority": "TVPT"
          }
        }
      ],
      "Preference": [
        {
          "@type": "Preference"
        }
      ],
      "ReceiptConfirmation": {
        "@type": "ReceiptConfirmation",
        "id": "3493289238",
        "ReceiptRef": "6773 2389 2239 2832",
        "Identifier": {
          "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
          "authority": "TVPT"
        },
        "dateTime": "2022-08-07T12:12:00Z",
        "Confirmation": {
          "@type": "ConfirmationHold"
        }
      },
      "TravelAgency": {
        "@type": "TravelAgencyDetail",
        "id": "2",
        "TravelOrganizationRef": "TravelAgency_1",
        "Identifier": {
          "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
          "authority": "TVPT"
        },
        "OrganizationName": {
          "id": "2",
          "division": "Travel Division",
          "department": "Adventure department",
          "shortName": "Adventure Inc",
          "code": "AI",
          "codeContext": "ISO",
          "systemOfRecord": [
            "MB"
          ]
        },
        "CorporateCode": "Air Agency"
      },
      "scheduleChangeAcceptedInd": true,
      "overrideMCTInd": true,
      "errorWhenScheduleChangesInd": true,
      "errorWhenOfferPriceChangesInd": true
    }
  }
}

Response

Created - 201

Example response

{
  "ReservationResponse": {
    "Reservation": {
      "@type": "Reservation",
      "id": "REF12873",
      "Identifier": {
        "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
        "authority": "TVPT"
      }
    },
    "@type": "response",
    "transactionId": "49f58f5f-c443-43b4-9f5d-be405fd00a01",
    "traceId": "TraceID_123456",
    "Result": {
      "@type": "Result",
      "status": "Complete",
      "Error": [
        {
          "@type": "ErrorDetail",
          "StatusCode": 200,
          "Message": "No flights found.",
          "NameValuePair": [
            {
              "value": "Sunday",
              "id": "6",
              "name": "Day1"
            }
          ]
        }
      ],
      "Warning": [
        {
          "@type": "WarningDetail",
          "StatusCode": 200,
          "Message": "Customer Loyalty could not be applied.",
          "NameValuePair": [
            {
              "value": "Sunday",
              "id": "6",
              "name": "Day1"
            }
          ]
        }
      ]
    },
    "Identifier": {
      "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
      "authority": "TVPT"
    },
    "NextSteps": {
      "id": "5",
      "NextStep": [
        {
          "value": "www.resourcelocation.com",
          "id": "2",
          "action": "cancel",
          "description": "remove offer from the order"
        }
      ]
    },
    "ReferenceList": [
      {
        "@type": "ReferenceListFlight"
      }
    ],
    "CurrencyRateConversion": [
      {
        "SourceCurrency": {
          "value": "USD",
          "codeAuthority": "ISO 4217",
          "decimalPlace": 4,
          "decimalAuthority": "ISO 4217"
        },
        "TargetCurrency": {
          "value": "USD",
          "codeAuthority": "ISO 4217",
          "decimalPlace": 4,
          "decimalAuthority": "ISO 4217"
        },
        "ConversionRate": {
          "rateAuthority": "ISO 4217",
          "rateAsOf": "2026-08-07T12:12:00Z"
        }
      }
    ],
    "Pagination": {
      "@type": "Pagination",
      "page": 1,
      "pageSize": 20,
      "totalPages": 5,
      "totalItems": 100
    }
  }
}