Unified Check Out

Create hotel reservation (Reference payload).

Use the Create Reservation Reference Payload request to book a room using a cached offer from either a preceding Availability or SearchComplete response. The reference payload request sends an offer ID plus traveler details and both form of payment and payment information. NOTE: Results from Availability and SearchComplete are stored in cache for 30 minutes. If the offers expire before you create a reservation, you must send a new request before booking. The Create Reservation Full Payload response uses the same format as the Reference Payload response. The only difference is that the reference payload response returns Reservation/id, which is the offer ID sent in that request. The full payload response does not return this information." Note for query parameters- Hotel APIs that create a new reservation or add to an existing one verify the reservation request with the guarantee type and price returned in preceding workflow steps. If there is any difference, the API does not yet create the reservation but instead returns an error to notify about the change. To accept the change, send the request a second time with the applicable query parameter/s (acceptPriceChangeInd and/or acceptGuaranteeChangeInd). Do not send either of these query parameters in the initial request. If you do not want to proceed with the booking because of the changes, you are not required to send a second booking request with the false value(s). You can simply let these offers expire.

post/hotel/book/reservations/build

Query parameters

acceptPriceChangeIndboolean

Send with true to accept any difference in the current sell price from the total price returned in an earlier response. Default is false; terminates the sell process without booking.

acceptGuaranteeChangeIndboolean

Send with true to accept any difference in the guarantee type from the guarantee type returned in an earlier response. (The guarantee types checked for differences are guarantee required, deposit required, prepay required.) Default is false; terminates the sell process without booking.

applyStrictReservationCommentValidationIndboolean

If true, the user expects that the sell request will be failed if any of the requested reservation comments fail. If indicator is not sent the service will default to false.

roomPerTravelerIndboolean

If true, the multi-room request will be sold as a separate reservation per Traveler. If indicator is not sent the service will create a single reservation for all travelers. Default is false.

Headers

TraceIdstring
Example:TraceID_123456789

Used in hospitality workflows to provide a Unique transaction or tracking id for a single request and response.

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

Identifies the Travelport access group with which the caller is associated

TVP-PCC-Corestring
Example:DU7_1G

Allows user to pass PCC instead of Access Group ID

TVP-Correlation-Idstring uuid
Example:382c74c3-721d-4f34-80e5-57657b6cbc27

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

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

OK - Successful Response - 200

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
    }
  }
}