Component: MEETING_TYPE_SETTINGS

Abstract

Meeting settings define how customers are picked up, dropped off and/or can meet on predefined location.

Values for this component can be set via ExperienceComponentsDto.meetingType which is of ExperienceMeetingSettingsDto type. This object is mandatory on product creation.

Note (1): changes in settings of this component will lock/unlock various relevant settings at rate level, which in turn might lock/unlock settings at pricing level.

Attributes of `ExperienceMeetingSettingsDto`

Attribute JSON path	Attribute JSON path	Data type	Mandatory	Settable	Notes
`type`		`ExperienceMeetingTypeDto`	✓	✓	Setting for switching between different pickup / meet on location options
`meetingPointPlaceGroupId`		`long`	Must be absent if `type == PICK_UP`. Otherwise (if meet on location is possible) one of `(meetingPointPlaceGroupId, meetingPointAddresses)` must be provided	✓	Must refer to a valid place group id.
`meetingPointAddresses`		Array of `ExperienceMeetingPointDto`	Must be absent if `type == PICK_UP`. Otherwise (if meet on location is possible) one of `(meetingPointPlaceGroupId, meetingPointAddresses)` must be provided	✓	A list of addresses where travelers could be meeting up before the experience. Note: make sure the complete list of addresses is sent on update as all omitted entries will be removed
	`id`	`long`	Mandatory if this particular address item is updated, otherwise should be omitted		ID of this address item
	`title`	`string`	✓	✓	Can’t be empty string
	`address`	`AddressDto`	✓	✓
`allPickupPlaceGroups`		`boolean`	This is a mandatory field if pickup is enabled (`type` is either `PICK_UP` or `MEET_ON_LOCATION_OR_PICK_UP`), otherwise should be omitted	✓	If set to `true`, this will infer that all pickup place groups (currently linked against the product as well as those created in the future) will be applicable for this product. If set to false, `pickupPlaceGroupIds` must contain specific IDs applicable for this product
`pickupPlaceGroupIds`		Array of `long`s	Mandatory if `allPickupPlaceGroups == false`, otherwise should be omitted	✓	A set of place group IDs applicable for pickup service of this product
`pickupMinutesBefore`		`int`	This can only be used if `pickupTimeLocationBased == false` (which provides pickup settings per each pickup place). Either this, or `pickupTimeByLocation` is mandatory if pickup is enabled (`type` is either `PICK_UP` or `MEET_ON_LOCATION_OR_PICK_UP`)	✓	How much time before departure does the pick-up start (in minutes)? Can be negative if pickup is serviced after start time
`pickupTimeWindow`		`int`	Mandatory if `type` is either `PICK_UP` or `MEET_ON_LOCATION_OR_PICK_UP`, otherwise should be omitted	✓	How much time (in minutes) does your service allow for pickup?
`pickupTimeLocationBased`		`boolean`	Mandatory if `type` is either `PICK_UP` or `MEET_ON_LOCATION_OR_PICK_UP`, otherwise should be omitted	✓	If `false`, pickup time applies for all locations identically (as specified via `pickupMinutesBefore`). If `true`, one must provide pick up times for each location via `pickupTimeByLocation`
`pickupTimeByLocation`		Array of `ExperiencePickupTimeByLocationDto`s	Mandatory if `pickupTimeLocationBased == true`, otherwise should be omitted	✓
	`placeId`	`long`	✓	✓	Points to pickup place ID
	`minBeforeStart`	`int`	✓	✓	how much time (in minutes) is a pickup serviced for this location? Can be negative if pick up is planned after the start time
`pickupAllotment`		`boolean`	Mandatory if `type` is either `PICK_UP` or `MEET_ON_LOCATION_OR_PICK_UP`, otherwise should be omitted	✓	If `false`, this pickup service can always be booked. If `true`, only a certain number of items of this pickup service can be booked. If `true`, the relevant allotment number should be provided via `ExperienceRecurrenceRuleDto::maxCapacityForPickup`
`customPickupAllowed`		`boolean`	Mandatory if `type` is either `PICK_UP` or `MEET_ON_LOCATION_OR_PICK_UP`, otherwise should be omitted	✓	If `true`, one can allow the customer to enter custom pickup location. The customer will then fill out an address to be picked up at. If `false`, only designated addresses are allowed for pick up
`showPickupMessageOnTicket`		`boolean`	Mandatory if `type` is either `PICK_UP` or `MEET_ON_LOCATION_OR_PICK_UP`, otherwise should be omitted	✓	If enabled (`true`), this will show a custom message to the customer’s ticket depending on the customer’s pick-up preference
`showNoPickupMessageOnTicket`		`boolean`	Mandatory if `type` is either `PICK_UP` or `MEET_ON_LOCATION_OR_PICK_UP`, otherwise should be omitted	✓	If enabled (`true`), ticket will display a custom message in case if no pickup is purchased/selected.
`noPickupMessage`		`string`	Mandatory if `showNoPickupMessageOnTicket == true`	✓	Message to display in case if `showNoPickupMessageOnTicket == true`. HTML format.
`dropoffService`		`boolean`	✓	✓	If `true`, this enables dropoff service for this product. Disables if `false`
`customDropoffAllowed`		`boolean`	Mandatory if `dropoffService` is true, otherwise should be omitted	✓	If enabled (`true`), one can allow the customer to enter custom dropoff location. The customer will then fill out an address to be dropped off at
`dropoffPlacesSameAsPickup`		`boolean`	Mandatory if `dropoffService` is `true`	✓	If enabled (`true`), this will make use place IDs for dropoff using the same settings as for pickup. `dropoffPlaceGroupIds` should be provided otherwise. This flag can't be enabled if `allDropoffPlaceGroups` is enabled. Nor it can be enabled if `type=MEET_ON_LOCATION`
`allDropoffPlaceGroups`		`boolean`	Mandatory if `dropoffService` is `true`	✓	If set to `true`, this will infer that all dropoff place groups (currently linked against the product as well as those created in the future) will be applicable for this product. If set to `false`, `dropoffPlaceGroupIds` must contain specific IDs applicable for dropoffs of this product. If set to `true`, `dropoffPlaceGroupIds` must be absent. This is a mandatory field if dropoff is enabled `dropoffService` is `true`). This flag can't be enabled if `dropoffPlacesSameAsPickup` is enabled
`dropoffPlaceGroupIds`		Array of `long`s	Mandatory if `dropoffService` is `true` and `dropoffPlacesSameAsPickup` is `false` and `allDropoffPlaceGroups` is `false`, otherwise should be omitted	✓	A set of place group IDs applicable for dropoff for this product. Only sent/accepted if `dropoffPlacesSameAsPickup` is `false`

Abstract

Attributes of ExperienceMeetingSettingsDto

Attributes of `ExperienceMeetingSettingsDto`