Skip to content
LavandaLavanda Developer Docs

Catalog Tools

Tools for managing product groups, products, product services, cancelation policies, and rate modifiers in the Lavanda catalog.

Available Tools

Section titled “Available Tools”

Product Groups

Section titled “Product Groups”

See all Product Groups tools →

Tool Description
get_product_group Get a product group by ID with its associated products, unit type and rate information, publishing window, and cancellation-policy details.
list_product_groups List product groups with filtering, sorting, and cursor-based pagination. Filter by workspace ID(s), activation state (ACTIVE/INACTIVE), or the published shortcut. Each item includes the product count, publishing window, and cancellation-policy details. Use get_product_group for full details (including tags) and list_tags to discover tag keys.
create_product_groups Create one or more product groups. Required fields depend on type: type is always required; STUDENT requires academic year, internal reference, workspace ID, and contract dates (earliest/latest start/end dates); SHORT_TERM_STAY and RESIDENTIAL require internal reference and workspace ID. Optional fields include agreement ID, expiry settings, publishing window, and min/max occupants (a head count, not target occupancy; omit for no limit); student and residential product groups can also set cancellation-policy requirements.
update_product_groups Update one or more product groups (STUDENT, SHORT_TERM_STAY or RESIDENTIAL). You can update fields such as internal reference, academic year, contract dates, workspace, expiry settings, publishing window, and min/max occupants (a head count, not target occupancy; pass null to clear); student and residential product groups can also update cancellation-policy requirements.
update_product_groups_state Activate or deactivate one or more product groups
update_product_group_rate_strategy Set or change how one or more product groups’ rates are calculated (their rate strategy): standalone, derived from the parent, or derived from the unit type base rate calendar, each with an optional percentage modifier.

Product Group Relationships

Section titled “Product Group Relationships”

See all Product Group Relationships tools →

Tool Description
create_product_group_relationships Create one or more parent-child product group relationships in a single all-or-nothing transaction

Products

Section titled “Products”

See all Products tools →

Tool Description
get_product Get a product by ID with its services, rate, and eligible services
create_products Create one or more products
update_products Update one or more products
update_product_rates Update the rate for one or more products
delete_products Delete one or more products by ID
allocate_product_units Allocate units to a product’s availability pool
unallocate_product_units Unallocate units from a product’s availability pool

Product Services

Section titled “Product Services”

See all Product Services tools →

Tool Description
list_product_services List the services currently attached to a product
list_product_eligible_services List services eligible to be attached to a product
add_product_services Attach one or more services to a product
update_product_services Update one or more services attached to a product
remove_product_services Remove one or more services from a product

Cancelation Policies

Section titled “Cancelation Policies”

See all Cancelation Policies tools →

Tool Description
create_cancelation_policies Create one or more workspace-level catalog cancelation policies
get_cancelation_policy Get a single cancelation policy by ID
update_cancelation_policies Update one or more cancelation policies
delete_cancelation_policies Delete one or more cancelation policies by ID

Checklist Item Templates

Section titled “Checklist Item Templates”

See all Checklist Item Templates tools →

Tool Description
create_checklist_item_templates Add checklist item templates to a product group’s checklist template
update_checklist_item_templates Patch checklist item templates on a product group’s checklist template
delete_checklist_item_templates Remove checklist item templates from a product group’s checklist template

Rate Modifiers

Section titled “Rate Modifiers”

See all Rate Modifiers tools →

Tool Description
get_rate_modifier Get a single rate modifier rule by ID
list_rate_modifiers List rate modifier rules with filters, sort, and cursor pagination
get_rate_modifier_settings Get the per-Building rate modifier caps
create_rate_modifiers Create one or more rate modifier rules
update_rate_modifiers Update one or more rate modifier rules
delete_rate_modifiers Soft-delete one or more rate modifier rules by ID
upsert_rate_modifier_settings Create or update the per-Building rate modifier caps
Section titled “Related Documentation”