Warden API
    Warden External API
    • Warden External API
    • Auth
      • Credential Refresh
        GET
    • Booking Engine
      • Get Property Listings
        GET
      • Get Bed Availability
        POST
      • Get Room Type Listings
        GET
      • Get Plan Options for Channel and Room Types
        POST
      • Generate Plan for Channel and Room Types
        POST
      • Create Booking
        PUT
    • API
      • Get Company Details
        GET
      • Get Channels
        GET
      • Get Bookings
        GET
      • Get Residents
        GET
      • Get Payments
        GET
      • Get Transactions
        GET

    Booking Engine

    The Booking Engine is a set of APIs that walk you through the end-to-end flow of creating a booking for a resident. The endpoints are designed to be called sequentially — each step builds on the output of the previous one.

    Booking Flow#

    Follow these steps in order to create a booking:

    1. Get Property Listings#

    Fetch the list of available properties. Use the id of the property you want to book.

    2. Get Room Type Listings#

    Fetch the room types available at the selected property using propertyId. Use the id of the desired room type.

    3. Get Bed Availability#

    Check real-time bed availability for the selected property and room type(s) across your desired date range. Use propertyId, roomTypeId, and your startDateTime / endDateTime.

    4. Get Plan Options for Channel and Room Types#

    Fetch the available payment plans for the selected room type(s) and date range. Each plan comes with a pre-generated payment schedule and a form that describes its configurable inputs.

    5. Generate Plan for Channel and Room Types#

    Generate the final payment schedule using the selected plan's generatorMethod. Pass this directly from the response of the previous step.

    6. Create Booking#

    Submit the booking with the resident's details and the generated payment plan. On success, Warden creates the booking, assigns a bed, and returns the confirmed booking details.

    Note: You will need a channelId throughout this flow. Obtain this from the Get Channels endpoint in the API section before starting.
    Modified at 2026-05-03 12:43:05
    Previous
    Credential Refresh
    Next
    Get Property Listings
    Built with