Retrieve hotel reservation.

Request

The Retrieve Hotel Reservation API returns all existing data on a reservation. You may retrieve details about a held booking or PNR. While a PNR refers to a held booking that has not been ticketed, the PNR code persists after ticketing to provide the booking records. Once a PNR has been ticketed, you can still use Retrieve to return both booking and ticketing details.

Security

bearerAuth

Path

Identifierstring, <= 128 charactersrequired

Identifier provides the ability to create a globally unique identifier. For the identifier to be globally unique it must have a system provided identifier and the system must be identified using a global naming authority. System identification uses the domain naming system (DNS) to assure they are globally unique and should be an URL. The system provided ID will typically be a primary or surrogate key in a database.

Query

detailViewIndboolean

If true, ReservationDetail will be returned.

identifierTypestring(IdentifierTypeENUM)

The type of identifier key used to retrieve the reservation

Enum:"Reservation""Locator""SupplierLocator""DocumentNumber"

Example:identifierType=Locator

TraceIdstring, [ 10 .. 89 ] characters(^[a-zA-Z-0-9_]*[-]?[+]?$)

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

Example:TraceID_123456789

XAUTH_TRAVELPORT_ACCESSGROUPstring, = 36 characters([a-zA-Z-0-9-_]*)

Identifies the Travelport access group with which the caller is associated

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

TVP-PCC-Corestring^[a-zA-Z\d]{3,4}_\w{2}$

Allows user to pass PCC instead of Access Group ID

Example:DU7_1G

TVP-Correlation-Idstring, (uuid)

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

Example:382c74c3-721d-4f34-80e5-57657b6cbc27

curl -i -X GET \
  'https://api.pp.travelport.net/11/hotel/book/reservations/{Identifier}?detailViewInd=true&identifierType=Locator' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'TVP-Correlation-Id: 382c74c3-721d-4f34-80e5-57657b6cbc27' \
  -H 'TVP-PCC-Core: DU7_1G' \
  -H 'TraceId: TraceID_123456789' \
  -H 'XAUTH_TRAVELPORT_ACCESSGROUP: 19Y88702-C27A-4E5D-829A-89D7016688B1'

Responses

OK - Successful Response - 200

Bodyapplication/json

ReservationResponseobject(ReservationResponse)

The response of a Create Reservation (Reference or Full Payload), Sync Reservation, Modify/Add Reservation, Create/Modify Passive Reservation, Retrieve Reservation, or Cancel Reservation endpoint.
The structure detailed here is the same for all of these API responses. For Post-Commit Workbench Create and Workbench Retrieve the response is structured the same, plus a workbench identifier.
The information returned in the Reservation Retrieve response varies depending on the information that has been added to the reservation at the time of retrieve, whether the reservation has been ticketed, and whether the reservation was created using the Travelport TripServices APIs or another program.

Please note the requests for Workbench Commit (Create Reservation), Post-Commit Workbench Create, and Workbench Retrieve do not support the query parameters available in Reservation Retrieve and do not return the following:

any document override, accounting, historical, and DOCI remarks
any custom rules
brand attributes
baggage dimension and fee details
fare rules
ATPCO RouteHappy flight amenities

For Two-step Commit: In the initial booking workflow, or when adding an offer to an existing reservation, or during an exchange, you can send enableTwoStepCommitInd=true to enable a two-step commit process that returns a warning if specific error scenarios occur. See Two-step Commit in the Guides for more information. If a Two-step Commit is triggered, the booking is not created and the first commit response returns objects that may not return in a typical commit response payload. The payload varies based on the warning that triggered the Two-step Commit, and may include additional objects if seats or other ancillaries were added to the workbench. Because the booking was not committed, Result/status is 'Not Processed'. A descriptive error or warning is returned in Result/Error/Message or Result/Warning/Message. The response to a second commit that creates a booking uses the same structure as a Reservation Retrieve response.

Response

{
  "ReservationResponse": {
    "@type": "response",
    "transactionId": "49f58f5f-c443-43b4-9f5d-be405fd00a01",
    "traceId": "TraceID_123456",
    "correlationId": "49f58f5f-c443-43b4-9f5d-be405fd00a01",
    "reservationStatus": "Success",
    "Result": {
      "@type": "Result",
      "status": "Complete",
      "Error": [ … ],
      "Warning": [ … ]
    },
    "Identifier": {
      "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
      "authority": "TVPT"
    },
    "NextSteps": {
      "baseURI": "www.travelport.com",
      "id": "5",
      "NextStep": [ … ]
    },
    "ReferenceList": [
      null
    ],
    "CurrencyRateConversion": [
      { … }
    ],
    "Pagination": {
      "@type": "Pagination",
      "page": 1,
      "pageSize": 20,
      "totalPages": 5,
      "totalItems": 100
    }
  }
}