Passive Segments Guide

Hotel rooms booked outside of the Travelport+ system and then added to an existing Travelport PNR/booking file, or used to create a new Travelport+ booking, are called passive segments. You can also use passive segments to create a placeholder, or a retention segment to keep the reservation active in the system past the other travel dates on the booking..

This guide discusses how to create and manage passive hotel segments in the JSON Hotel APIs. For agents who are familiar with Travelport+ terminal entries for creating passive reservations, it also compares those terminal entries to the corresponding data in the JSON passive hotel APIs. Implementation and object-level details are covered in the Hotel API References.

Related Content: JSON Hotel APIs Guide

In this guide:

Basic Concepts

Segments booked outside Travelport+ are called passive because the Travelport+ booking file provides only information about the booking. The segment is not linked to the supplier's system. Any changes made to a passive segment in the JSON APIs or another Travelport+ product are not sent to the supplier's system, and any changes made by the supplier are not sent to the passive segment in the PNR/booking file.

Adding details about a hotel booked outside of the Travelport+ system allows you to keep all information about an itinerary in one place. For example, you could use a passive hotel segment to record booking data for a hotel room that was booked directly for blocked room space at a convention. While that part of the reservation is not booked through Travelport+, the passive segment allows the itinerary to reflect all of the reservation information for the trip.

Or, a passive segment can simply be a placeholder that has only dates. You might want to add a placeholder if you do not have all booking details. Or, you can send only dates to add a dummy or retentionsegment, 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.

Passive Segment Support in the JSON Hotel APIs

The following JSON Hotel APIs support creating, adding, and modifying passive segments as follows.

Capability

API Reference for details

Notes

Create a new reservation for a passive segment

Create Hotel Passive Segment API Reference

Creates a booking file for in the Hotel APIs for a room booked outside the JSON APIs. No booking takes place in the Hotel APIs, and no information about this booking is sent to the supplier.

Passive hotel segments are confirmed with a status code of MK, which is returned in the response in Receipt/OfferStatus/code.

The Travelport+ reservation identifier, aka locator code or PNR, is returned in Receipt/Confirmation/Locator/value. The associated sourceContext is Travelport.

Add passive segment to existing reservation

Add Hotel Passive Segment API Reference

You can add either of the following to an existing reservation made with the JSON Hotel APIs:

  • A room booked outside the JSON APIs. You must send full room, rate, and supplier details. This type of passive segment is confirmed with a status code of MK.

  • A placeholder segment (see next section below), sending only dates. This type of passive segment is confirmed with a status code of AK, returned in the response in Receipt/OfferStatus/code.

The request payload to add a passive hotel segment to an existing reservation is the same as for the Create request. The endpoints are different, with the Add endpoint sending the reservation locator code of the reservation to add the segment to.

Modify passive segment/s

Modify Passive Segment API Reference

Updates details about a passive segment on a JSON Hotel APIs reservation.

Remember that none of the changes made through the JSON APIs are sent to the supplier.

Confirmed Passive vs Placeholder/Retention Segments

When you add a passive segment to an existing booking, you can create that segment as either a confirmed segment with full booking details, or as a placeholder segment that includes only a date range. For example, you might add a placeholder segment when full details are not available. 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.

  • Full segment details create a passive hotel segment with a status of MK (confirmed passive).

  • Segments with only dates create a passive placeholder segment with a status of AK.