Skip to content

list_oversell_rules

List cancelation-driven oversell rules for a unit type on its OTA channels (e.g. Booking.com). Returns each rule’s effective date span, lead-time window, cancelation probability, aversion, max-oversell cap, priority and enabled state. Filter by channel or enabled state.

Parameter Type Required Description
unitTypeId string Yes The ID of the unit type (multi-unit group) to list rules for
channel OversellRuleChannel No Filter to a single OTA channel (e.g. BOOKING_COM) - OversellRuleChannel
enabled boolean No Filter by enabled state. Omit to return both enabled and disabled rules.
first number No Number of results to return (forward pagination). Maximum 25. Use with “after” for paging.
after string No Cursor for forward pagination. Pass the “endCursor” from previous page’s pageInfo.
last number No Number of results to return (backward pagination). Maximum 25. Use with “before” for reverse paging.
before string No Cursor for backward pagination. Pass the “startCursor” from previous page’s pageInfo.
Value Description
BOOKING_COM Booking.com — the only OTA channel supported by oversell rules in v1
Field Type Description
content ContentItem[] Array of content items returned by the tool - ContentItem
isError boolean Whether the tool execution resulted in an error
Field Type Description
type 'text' Content type (currently only ‘text’ is supported)
text string The text content to display