Booking Workflow

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 .

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.

Sample request

{
  "listingId": "0a06a7b4-ad8f-4454-ba6f-c05c998504a2",
  "unitTypeId": "be49ebc5-37d1-49f8-bb6e-d5fe26c5b7bc",
  "arrivalDate": "2022-10-20",
  "departureDate": "2022-10-29",
  "guestDetails": {
    "adultsCount": 1,
    "childrenCount": 1,
    "babiesCount": 1,
    "petsCount": 0,
    "childrenAges": [
      10,
      1
    ]
  }
}

Note: The guest details require the count of adults, children, babies and pets. For every child and baby, there should be a corresponding age in childrenAges array.

Guest rules:

• Guests are categorised based on the following conditions:

  • Babies: less than 2 years old (ages considered as baby are 0 and 1).

  • Children: greater than or equal to 2 years and less than 18 years (ages considered as children are 2 to 17).

  • Adults: greater than or equal to 18 years of age.

• There is no price differentiation between adults and children, however age information is useful for the host.

• Babies are always free.

Booking Creation

After the customer successfully completes the booking on your page, you need to create the booking in 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 completed 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.

Booking Updates Polling & Fetch Booking Details

Post booking, the booking can be modified in 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 to their bookings.

The Booking Updates and Fetch Booking Details endpoints are designed in the same way as the Listing and Pricing endpoints. Please refer to Getting Started - API Overview for details on how to use it.