Endpoints and Capabilities

RhomTrip defines a collection of Core Endpoints applicable to most use cases and required for implementation.

RhonTrip API Core Endpoints

Name
Method
Description

Get transfers quotation

POST

This endpoint provides a quotation for a transfer service between two specified locations.

Products (In Progress)

Name
Method
Description

Get Products

GET

Returns a list of Products.

Search Products

GET

Returns a list of Products based on search criteria such as: destinations, countries, currencies.

Get Product

GET

Returns a single Product.

Availability (In Progress)

Name
Method
Description

Availablity Calendar

POST

Returns availability for a given Product & Option as a single object per day. Optimized to be queried for large date ranges and to populate an availability calendar.

Availability Check

POST

Returns availability for a given Product & Option as a single object per start time (or day). You have to perform this step to retrieve an availabilityId required for Bookings.

Name
Method
Description

Booking Reservation

POST

Creates a booking (e.g. while you collect payment and contact information from the customer) for a given transferId. The booking will remain with the status ON_HOLD until Booking Confirmation or when the reservation hold expires.

Booking Confirmation

POST

Confirms previously placed Booking Reservation, finalizing the booking and making it ready to be used.

Booking Update

PATCH

Updates/changes your booking before and after it has been confirmed as long as it hasn't yet been redeemed or within the cancellation cutoff window.

Booking Cancellation

POST

Cancels your booking. You can only cancel a booking if booking.cancellable is TRUE, and is within the booking cancellation cut-off window.

Extend Reservation

POST

Extends the Booking Reservation availability hold if the booking status is ON_HOLD.

Get Booking

GET

Returns the status and details of your existing booking.

Get Bookings

GET

Returns the list of the bookings you made for the given filters.

Capabilities

How to use core extensions

RhomTrip currently supports the following capabilities:

  • Pricing

  • Webhooks

They are enabled by including them in the request header, as mentioned in the previous Headers section. Capabilities are optional but may provide functionality to improve your integration.

Name
ID
Description

octo/pricing

Adds pricing to most endpoints giving you advanced static and dynamic pricing capabilities.

octo/webhooks

Allows you to programmatically create webhooks in RhomTrip System in order to listen out for transfer update, booking updates or availability updates.

You control which capabilities you want to enable by using the Octo-Capabilities header. For example:

Host: {host}
Authorization: Bearer {your_API_key}
Octo-Capabilities: octo/pricing

Last updated