v1

latestOpenAPI 3.0.02026-08-0617434432.8 KB

Unified Check Out

Add passive reservation to a booking.

Use the Add Passive Reservation request to add a passive hotel booking segment to an existing reservation. You can add either of two types of passive segments to an existing reservation: 1) Sending full details of the room in the request adds a single hotel segment with a status of MK (confirmed passive) to the reservation, or, 2) Sending only dates in the request, which adds a placeholder segment to the reservation. You may want to add a placeholder if you do not have all booking details. Or, you can send only dates to add a dummy or retention segment, which can be used to keep the reservation details active in the system after travel is complete, up to the dates on the passive segment. Placeholder segments return a status of AK. (A passive hotel segment is any segment that is booked using anything other than a product that uses the Travelport GDS. Passive segments are informational only. They do not result in a reservation or a change in inventory. Information on a passive segment is not received from or passed to the hotel supplier. Instead, passive segments provide a way to consolidate all booking information, including details from direct hotel bookings or even phone reservations.)

put/hotel/book/reservations/{reservationIdentifier}/passive

Path parameters

reservationIdentifierstring required

Query parameters

Locatorstring

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.

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