Component: AVAILABILITY_RULES
Abstract
Availability rules define the frequency and capacity of product availability.
Each availability rule is linked to (typically) all or (more rarely) specific start times.
Values for this component can be set via ExperienceComponentsDto.availabilityRules which is an array of ExperienceRecurrenceRuleDto type.
Attributes of ExperienceRecurrenceRuleDto
Attribute JSON path | Attribute JSON path | Data type | Mandatory | Settable | Notes |
id | long | On update only, otherwise must be omitted | Not settable. New entries should have this field blank, system will pick the value | ||
recurrenceRule | RecurrenceRuleDto | ✓ | ✓ | The actual rule which contains the frequency etc. Note that all rules must be sent on update as all omitted entries will be removed | |
startDate | string | ✓ | When does this recurrence rule start (year/month/day of month)? Format: RFC 3339, section 5.6, for example, 2023-07-21 | ||
endDate | string | ✓ | When does this recurrence rule stop (year/month/day of month)? Format: RFC 3339, section 5.6, for example, 2023-07-21 | ||
byWeekday | Array of DayOfWeekDto | ✓ | On which day(s) of the week does this event occur? If omitted, it is assumed it occurs on every day of the week.
Note this works in conjunction with byMonth. If both are defined, the result will be a conjunction of these sets. | ||
byMonth | Array of MonthDto | ✓ | On which day(s) of the month does this event occur? If omitted, it is assumed it occurs on every day of the month.
Note this works in conjunction with byWeekday. If both are defined, the result will be a conjunction of these sets. | ||
maxCapacity | int | ✓ | ✓ | What is the maximum number of passengers supplier can accept for this availability rule? | |
maxCapacityForPickup | int | ✓ | Used if pickup is enabled. Sets the amount of available seats in your pick-up service for this rule | ||
mintTotalPax | int | ✓ | If set, the experience will only be bookable if minimum participants is met | ||
allStartTimes | boolean | Mandatory if ExperienceComponentsDto.bookingType == DATE_AND_TIME, otherwise should be omitted | ✓ | If set to true, this rule will apply to all start times; in which case startTimes array should not be sent. If set to false, this rule will apply to specific start times, specified in (now mandatory) startTimes array. | |
startTimes | Array of IdExternalIdDto | Mandatory if ExperienceComponentsDto.bookingType == DATE_AND_TIME and allStartTimes == true | ✓ | The array should contain references to Bokun-local start time ids and/or external IDs. Sending empty startTimes array has the same effect as having allStartTimes == true. | |
guidedLanguages | Array of strings | ✓ | Format: array of guided languages this rule is applicable to. Elements are ISO 639 two letter language codes, for example, en, es. |
Did this answer your question?
😞
😐
🤩