Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Bookiply Channel API provides interfaces to create and manage traveler bookings on your platform. This page will walk you through the endpoints and the key information needed to interact with them.

For a detailed overview of each of them, please refer to API Specification .

Action

Endpoints

Pre-Booking Price Check

POST /v1/bookings/price-check

Booking Creation

PUT /v1/bookings/{bookingId}

Booking Cancellation

PUT /v1/bookings/{bookingId}/cancel

Booking Updates Polling

GET /v1/updates/bookings

Fetch Booking Details

GET /v1/bookings/{bookingId}

Pre-Booking Price Check

Whenever a customer enters a booking funnel on your website, you should fetch the detailed price breakdown together with all required and optional costs from the Price Check endpoint. That way you:

  • Confirm the property is still available for the requested dates.

  • Ensure that the price you show to the customer is precisely mirroring Bookiply’s Price, including adjustments for additional guests, taxes, children costs, and amenity costs.

  • Reduce the probability of booking rejections.

Booking Creation

After the customer successfully completes the booking on your page, you need to create the booking on the Bookiply’s system.

During the Booking Creation call, Bookiply will validate the booking request and synchronously respond by accepting the booking or specifying the reason for the rejection. Only after you get a successful response from the Booking creation endpoint can you consider the booking fully done and accepted by Bookiply.

Booking Cancellation

You can use the cancellation endpoint to request the cancellation of a booking, initiated by the traveler. The system will verify if the cancellation is possible and synchronously accept or reject the booking.

Cancellations are only possible if the booking has an Arrival Date in the future.

Please be aware that the cancellation fee will be applied in accordance with the cancellation policy selected at the booking time.

Booking Updates Polling & Fetch Booking Details

Post booking, the booking can get modified on Bookiply’s systems based on the traveler’s or homeowner’s request. Partners can stay updated about the booking changes and the latest state of the booking by regularly polling for the changes that happened on their bookings.

Booking Updates & fetch booking details endpoints are designed in the same way as Listing & Pricing ones. Please refer to Getting Started - API Overview for details on how to use it.

  • No labels