Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CartAvailableBookableItem

Item that can be booked through addCartBookableItem.

Hierarchy

Index

Properties

description

description: string

Short optional description.

disabled

disabled: boolean

Whether the item should appear disabled or hidden.

disabledDescription

disabledDescription: string

Message detailing why disabled is set. Might not be available.

id

id: string

ID of the item.

listDurationRange

listDurationRange: CartDurationRange

Displayed duration range of a bookable item.

listPriceRange

listPriceRange: CartPriceRange

Displayed price range of the item before tax.

The final price may differ based on customizations made to the item before checking out. For instance, bookable items may have variants and options that can be chosen and affect the price.

name

name: string

Short human-readable name.

Methods

getLocationVariants

  • List of locations offering the selected bookable item.

    This is affected by:

    • Staff / staff role settings set for the services in the cart
    • The "Bookable online" option for a specific service/location pair
    • The "Enable online booking" option for a location

    Location has to be chosen before checking out the cart.

    Returns Promise<CartAvailableBookableItemLocationVariant[]>

getOptionGroups

getStaffVariants

  • List of optional staff variants that can be chosen. Variants may have different pricing and timing.

    When there’s no preference, the first one available is assigned based on the selected time. The business can also enforce this, in which case this list is empty.

    Returns Promise<CartAvailableBookableItemStaffVariant[]>

Generated using TypeDoc