codeAPI Overview

Use this page to understand what each Channels Plus API component does and what data it handles.

Reservation Journey

1

Get properties

Call the get properties endpoint to retrieve the available inventory on Channels Plus that matches your booking guest's criteria.

2

Get property

Call the get property endpoint to retrieve the room rates for a specific property that your booking guest is interested in.

3

Lock reservation

Call the lock reservation endpoint once your booking guest has reviewed the room rates and would like to reserve the selected room rate.

4

Confirm reservation

Call the confirm reservation endpoint after your booking guest has provided all necessary details (e.g., payment information) to complete the booking.


Flow Examples

Make a Reservation

Modify Guest Details

Cancel a Reservation


Endpoints

Properties

REST/JSON

Returns an array of shoppable properties on Channels Plus that match the specified search criteria. This endpoint also provides property content, along with the best available deal and non-deal room rate for each property.

Property

REST/JSON

Returns content and available room rates for a specific property that meets the requested occupancy combination.


Lock Reservation

REST/JSON

Temporarily locks one or more room rates at a specific property for a limited period.

Confirm Reservation

REST/JSON

Confirms a locked reservation that is still within the lock period.


Modify Reservation

REST/JSON

Updates guest details and remarks for an existing reservation. Changes that affect pricing cannot be modified. If pricing-related details need to be updated, the reservation must be canceled and rebooked following the same reservation flow.

Cancel Reservation

REST/JSON

Cancel a reservation that is still within the cancellation period.


Reservations List

REST/JSON

Retrieves a list of reservations based on the specified dateType (bookedOn, checkIn, or checkOut) and a date range (fromDate to toDate) of no more than 31 days.

Reservation Detail

REST/JSON

Retrieves detailed information for a specific reservation created via the API.

sparkles

Still have questions?

Last updated

Was this helpful?