Component: ITINERARY
Abstract
Itinerary (aka agenda) items is an ordered list of events or activities for the customers have a better idea of what they will be doing during the experience.
Values for this component can be set via ExperienceComponentsDto.itinerary which is an array of ExperienceItineraryDto type.
Note (1): make sure a complete list of itineraries on update (if updating itinerary at all) as omitted entries will be deleted.
Note (2): depending on box settings and box being enabled, itinerary may be retrieved of box or boxed product.
Attributes of ExperienceItineraryDto
Attribute JSON path | Data type | Mandatory | Settable | Notes |
id | long | Mandatory on update, should be omitted on create | ID of this itinerary item | |
title | string | ✓ | ✓ | |
excerpt | string | ✓ | ||
description | string | ✓ | ||
address | AddressDto | ✓ | ||
photos | Array of longs | A list of photo IDs (reference to PhotoDto::id) that are active and assigned to this experience product. Photos must already exist before referencing |
Attributes of AddressDto
Attribute JSON path | Data type | Mandatory | Settable | Notes |
id | long | Mandatory on update, should be omitted on create | ID of this address | |
addressLine1 | string | ✓ | ||
addressLine2 | string | ✓ | ||
addressLine3 | string | ✓ | ||
city | string | ✓ | ||
state | string | ✓ | ||
postalCode | string | ✓ | ||
countryCode | string | ✓ | ||
latitude | double | ✓ | ||
longitude | double | ✓ | ||
googlePlaceId | string | ✓ |
Data normalization
The system will attempt to do location normalization on each create and/or update of ExperienceItineraryDto::address providing address data had changed.
The normalization algorithm is as follows:
- If the
addressobject hasgooglePlaceId, the system will attempt to do an internal Place API lookup and backfill/overwrite all other fields
- Otherwise, if the address object has
latitudeandlongitudebut notgooglePlaceIdthen the system will attempt to do an internal Place API lookup and backfill/overwrite the following fields: - Country code
- City
- State
The partial backfill is used because it is impossible to resolve other elements reliably.
- Otherwise if neither
placeIdnorlatitude/longitudeare set, the system will not attempt any backfill and keep the fields as they are supplied
Note: we highly recommend using placeId above all other alternatives as this option uniquely identifies the place and allows better product placement in areas such as Bokun Marketplace, Google TTD and so on. Note that individual features, such as Google TTD, might have their own recommendations on placeId specifics which are not described in this manual.