Addons available for that item.
Total discount amount on the price.
Valid discount code that was applied, either the cart's code or one that was
applied separately to the item. An invalid code results in a null value.
Current item validation errors.
ID of the guest associated with this item.
A null value implies the default guest, i.e. the booking client.
This field is more efficient than guest when only the ID is required.
ID of the item.
Original item details.
Total for the item after discounts and taxes.
Price before discounts and taxes.
Selected starting time for the item.
This value is reserved temporarily. Once the reservation expires, the value
reverts to null and needs to be selected again. See the parent cart’s
expiresAt field for more information.
Total tax amount on the discounted price.
Payment methods available for this item.
Guest associated with this item.
A null value implies the default guest, i.e. the booking client.
Any selected options for the item.
Payment method selected for this item.
Selected staff variant for the item.
You can set the preferred variant when adding the item. Leaving the variant unset indicates no preference.
Once a time is reserved, a variant is automatically set if none was set
earlier. Once the reservation expires, any automatically set value reverts
back to null.
Update the item.
This invalidates existing reservations when the guest, staff variant, or options are updated.
Optional discount code applied to the item. Invalid discount codes are ignored without an error, check discountCode on the selected item to see if the code was valid.
The guest this item is booked for. A null value indicates the cart owner, or current client. When finding available times for bookable items, it's assumed that two items having different guests can be booked simultaneously.
Selected bookable item options. Note that the selections must conform to the option group requirements, e.g. limits on the number of options. Otherwise an error is returned.
The selected bookable item staff variant.
Promise containing the updated cart
Generated using TypeDoc
An item that can be booked at a certain time.