About Add-On Groups

Add-on groups let you organize related add-ons into logical groups from which customers can select when booking services. For example, you might create an "Equipment Rentals" group containing add-ons like "yoga mat" and "resistance bands" for a fitness class, or a "Service Extensions" group with add-ons like "10-minute extension" and "20-minute extension" for a massage appointment. Add-ons for Bookings services must be included in a group before customers can book them.

With add-on groups, you can:

• Organize add-ons into logical groups.
• Set how many different add-ons customers can select from a group.
• Customize the order add-ons appear to customers.
• Manage customer instructions that guide add-on selection.

Before you begin

It's important to note the following points before starting to code:

• Create add-ons first using the Add-Ons API before organizing them into groups.
• Each add-on group is associated with a single service, but you can include add-ons in multiple groups across different services.
• You can mix duration-based and quantity-based add-ons in the same group.
• Keep within these limits: 3 add-on groups per service and 7 add-ons per group. Exceeding these limits results in validation errors.
• Deleting an add-on automatically removes it from all groups where it's included.
• Booking objects include details about selected add-ons, preserving add-on information at the time of booking.

Use cases

• Create bookable add-ons for a new group.
• Add add-ons to an existing group.
• Modify add-ons in eCommerce carts.

Terminology

• Add-on: An optional extra for a Wix Bookings service for an extra cost. Add-ons are either duration-based to extend booking time or quantity-based to be purchased in multiple units up to a maximum quantity per add-on. Add-ons must be included in groups before customers can select them.
• Add-on group: A collection of related add-ons linked to a booking service. Groups define the maximum number of different add-ons customers can select from the group and include customer-facing information like prompts and display order.
• Prompt: Optional instructional text displayed to customers to explain the add-on group's purpose and selection rules.
• Display order: The sequence in which add-ons appear to customers within a group, determined by their order in the group's addOnIds array.

See also

For complete add-on management, see:

• Add-Ons API: Create and manage individual add-ons that can be organized into groups.
• Bookings API: Handle customer bookings that include selected add-ons from groups.