View as Markdown
Booking Experts icon

Booking Experts ACTION

List RentableType Availabilities

List availabilities of a RentableType you have access to. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Booking Experts account once, then configure and run List RentableType Availabilities from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "booking_experts-list-rentabletype-availabilities",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    booking_experts: { authProvisionId: "apn_xxxxxxx" },
    channelId: "Channel ID",
    rentableTypeId: "Rentable Type ID",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List RentableType Availabilities inputs
Property Type Description
channelId Channel ID string
The ID of a channel
Required Dynamic
rentableTypeId Rentable Type ID string
The ID of a rentable type
Required Dynamic
startDate Start Date string
The start date of the availability. Yields availability for the given date range. Format: YYYY-MM-DD
Optional
endDate End Date string
The end date of the availability. Will be capped to 2 years in the future. Max LOS is capped to 30. Format: YYYY-MM-DD
Optional
fields Fields string[]
Fieldset. A list of attributes to return. See the documentation
Optional
include Include string[]
Includes list. A list of resources to include. See the documentation
Optional
multibookSafetyMargin Multi-book Safety Margin integer
Specifies a custom multibook safety margin (must be a positive number). A common problem that occurs when dealing with accommodations instead of hotelrooms is that a single accommodation must be available for all consecutive days for a given start date and LOS. The safety margin helps to prevent overbookings by transforming the available stock. When specified, the safety margin is subtracted from the actual stock. It is only applied to RentableType availabilities with capacity of 3 or more, as this issue cannot occur otherwise.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
booking_experts-list-rentabletype-availabilities
Version
1.0.2
App
Booking Experts
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes