5. Questions#
In this step, the flow proceeds by retrieving a list of information required from the supplier for billing and administrative reasons, necessary to have confirmation of the booking, and the booking gets updated with it.
getQuestions#
Given the booking ID, retrieves the list of questions to be answered for the booking to be confirmable. The questions are divided in questions about the customer (under the optional customer property), relative to the booking ( under the optional booking property) or questions about the participants (under the optional participants property).
Path
POST GET /booking-flow/v1/bookings/:bookingId/questions
Input body example
none
Output body example
{
"id": "60cdd167-e2ff-4746-b609-c2bee07d9985",
"availabilityDateTime": "2023-12-19T11:00Z",
"resellerRef": "MY_COMPANY",
"status": "ON_HOLD",
"paymentStatus": "ON_HOLD",
"creationDate": "2023-12-14T08:53:05.349043Z",
"availability": {
"id": "01d0597b-a819-478b-b32d-f99290b70e88",
"availabilityDate": "2023-12-19",
"availabilityOptions": [
{
"label": "Ticket Type",
"level": "0",
"id": "24deeda6-bcda-4c04-9659-e2ca2b2beedc",
"selectedOptionId": "528446",
"optionChoices": {
"528446": "Eiffel ,2 Day Bus Pass &Cruise"
}
},
{
"label": "Start Time",
"level": "1",
"id": "01d28c41-0b26-4d3a-a0ec-229125e07c63",
"selectedOptionId": "420013_20231219",
"optionChoices": {
"420013_20231219": "12:00"
}
}
],
"unitOptions": [
{
"label": "Adult",
"id": "143731",
"restrictions": {
"minQuantity": 1,
"maxQuantity": 10,
"accompagniedBy": []
},
"price": {
"retail": 114.9,
"currency": "EUR"
},
"unitQuantity": 2,
"minAge": 13,
"maxAge": 99
},
{
"label": "Child",
"id": "112820",
"restrictions": {
"minQuantity": 1,
"maxQuantity": 10,
"accompagniedBy": []
},
"price": {
"retail": 99.9,
"currency": "EUR"
},
"unitQuantity": 1,
"minAge": 4,
"maxAge": 12
},
{
"label": "Infant",
"id": "112821",
"restrictions": {
"minQuantity": 1,
"maxQuantity": 10,
"accompagniedBy": []
},
"price": {
"retail": 0.0,
"currency": "EUR"
},
"unitQuantity": 0,
"minAge": 0,
"maxAge": 3
}
],
"maxParticipants": 10,
"minParticipants": 1,
"isOptionStepCompleted": true,
"isPricingStepCompleted": true
},
"questions": {
"customer": [
{
"id": "65649496-4230-4b3e-8fb3-9a0ed6409f6a",
"question": "First name",
"dataType": "TEXT"
},
{
"id": "5302ca5a-25de-424a-b402-7a0d2ff11c8a",
"question": "Last name",
"dataType": "TEXT"
},
{
"id": "004d7c3f-6584-4e44-b7b5-aa6d76a8f1b4",
"question": "Email Address",
"dataType": "TEXT",
"dataFormat": "EMAIL_ADDRESS"
},
{
"id": "77e3b045-968d-4c0d-bc71-564696e3001a",
"question": "Phone Number",
"dataType": "TEXT",
"dataFormat": "PHONE_NUMBER"
},
{
"id": "fb22cfef-dfd7-45ee-ae03-7411706b519b",
"question": "Date of birth",
"dataType": "DATE"
}
],
"participants": [
{
"id": "6f830e19-c76c-4b61-a05f-7fa72229082f",
"questions": [
{
"id": "0084f15c-c21c-4f2f-a4df-0b94d9f199c4",
"question": "Date of birth",
"dataType": "DATE"
}
]
},
{
"id": "de974904-b701-4465-9ee3-53eacd5f3c95",
"questions": [
{
"id": "635a5588-2b4e-480e-ae12-ac06df15f9b6",
"question": "Date of birth",
"dataType": "DATE"
}
]
},
{
"id": "f4de002e-f208-4a7c-98e2-b85d8e6ca46f",
"questions": [
{
"id": "05b35fc6-8ebf-4781-88ae-bc0de971dd3f",
"question": "Date of birth",
"dataType": "DATE"
}
]
}
]
},
"cancellation": {
"isCancellable": false,
"cancellationPolicy": []
},
"isQuestionStepComplete": false,
"travelerDetails": {
"externalClientId": "ABCDEF"
}
}
setQuestions#
This endpoint updates the booking with the proper answer to the questions. Unlike the setOptions and setPricing, in these case all of the answers to the questions must be included in the response and this endpoint should ideally be called only once. However, after answers to the questions have been pushed via POST message, some new questions might appear aside the previous ones to provide additional information. In that case, all answers must be again sent in a single call (including the previous answers already provided).
Path
PUT /booking-flow/v1/bookings/:bookingId/questions
Input body example
[
{
"id": "65649496-4230-4b3e-8fb3-9a0ed6409f6a",
"value": "Abraham"
}, {
"id": "5302ca5a-25de-424a-b402-7a0d2ff11c8a",
"value": "Abraham"
}, {
"id": "004d7c3f-6584-4e44-b7b5-aa6d76a8f1b4",
"value": "Abraham@mail.com"
}, {
"id": "77e3b045-968d-4c0d-bc71-564696e3001a",
"value": "0601020304"
}, {
"id": "fb22cfef-dfd7-45ee-ae03-7411706b519b",
"value": "2000-01-01"
}, {
"id": "0084f15c-c21c-4f2f-a4df-0b94d9f199c4",
"value": "2000-01-01"
}, {
"id": "635a5588-2b4e-480e-ae12-ac06df15f9b6",
"value": "2000-01-01"
}, {
"id": "05b35fc6-8ebf-4781-88ae-bc0de971dd3f",
"value": "2000-01-01"
}
]
Output body example
{
"id": "60cdd167-e2ff-4746-b609-c2bee07d9985",
"availabilityDateTime": "2023-12-19T11:00Z",
"resellerRef": "MY_COMPANY",
"status": "ON_HOLD",
"paymentStatus": "ON_HOLD",
"creationDate": "2023-12-14T08:53:05.349043Z",
"updateDate": "2023-12-14T09:02:39.511359739Z",
"availability": {
"id": "01d0597b-a819-478b-b32d-f99290b70e88",
"availabilityDate": "2023-12-19",
"availabilityOptions": [
{
"label": "Ticket Type",
"level": "0",
"id": "24deeda6-bcda-4c04-9659-e2ca2b2beedc",
"selectedOptionId": "528446",
"optionChoices": {
"528446": "Eiffel ,2 Day Bus Pass &Cruise"
}
},
{
"label": "Start Time",
"level": "1",
"id": "01d28c41-0b26-4d3a-a0ec-229125e07c63",
"selectedOptionId": "420013_20231219",
"optionChoices": {
"420013_20231219": "12:00"
}
}
],
"unitOptions": [
{
"label": "Adult",
"id": "143731",
"restrictions": {
"minQuantity": 1,
"maxQuantity": 10,
"accompagniedBy": []
},
"price": {
"retail": 114.9,
"currency": "EUR"
},
"unitQuantity": 2,
"minAge": 13,
"maxAge": 99
},
{
"label": "Child",
"id": "112820",
"restrictions": {
"minQuantity": 1,
"maxQuantity": 10,
"accompagniedBy": []
},
"price": {
"retail": 99.9,
"currency": "EUR"
},
"unitQuantity": 1,
"minAge": 4,
"maxAge": 12
},
{
"label": "Infant",
"id": "112821",
"restrictions": {
"minQuantity": 1,
"maxQuantity": 10,
"accompagniedBy": []
},
"price": {
"retail": 0.0,
"currency": "EUR"
},
"unitQuantity": 0,
"minAge": 0,
"maxAge": 3
}
],
"maxParticipants": 10,
"minParticipants": 1,
"isOptionStepCompleted": true,
"isPricingStepCompleted": true
},
"questions": {
"customer": [
{
"id": "65649496-4230-4b3e-8fb3-9a0ed6409f6a",
"question": "First name",
"value": "Abraham",
"dataType": "TEXT",
"followUpQuestions": []
},
{
"id": "5302ca5a-25de-424a-b402-7a0d2ff11c8a",
"question": "Last name",
"value": "Abraham",
"dataType": "TEXT",
"followUpQuestions": []
},
{
"id": "004d7c3f-6584-4e44-b7b5-aa6d76a8f1b4",
"question": "Email Address",
"value": "Abraham@mail.com",
"dataType": "TEXT",
"dataFormat": "EMAIL_ADDRESS",
"followUpQuestions": []
},
{
"id": "77e3b045-968d-4c0d-bc71-564696e3001a",
"question": "Phone Number",
"value": "0601020304",
"dataType": "TEXT",
"dataFormat": "PHONE_NUMBER",
"followUpQuestions": []
},
{
"id": "fb22cfef-dfd7-45ee-ae03-7411706b519b",
"question": "Date of birth",
"value": "2000-01-01",
"dataType": "DATE",
"followUpQuestions": []
}
],
"participants": [
{
"id": "6f830e19-c76c-4b61-a05f-7fa72229082f",
"questions": [
{
"id": "0084f15c-c21c-4f2f-a4df-0b94d9f199c4",
"question": "Date of birth",
"value": "2000-01-01",
"dataType": "DATE",
"followUpQuestions": []
}
]
},
{
"id": "de974904-b701-4465-9ee3-53eacd5f3c95",
"questions": [
{
"id": "635a5588-2b4e-480e-ae12-ac06df15f9b6",
"question": "Date of birth",
"value": "2000-01-01",
"dataType": "DATE",
"followUpQuestions": []
}
]
},
{
"id": "f4de002e-f208-4a7c-98e2-b85d8e6ca46f",
"questions": [
{
"id": "05b35fc6-8ebf-4781-88ae-bc0de971dd3f",
"question": "Date of birth",
"value": "2000-01-01",
"dataType": "DATE",
"followUpQuestions": []
}
]
}
]
},
"cancellation": {
"isCancellable": false,
"cancellationPolicy": []
},
"isQuestionStepComplete": true,
"travelerDetails": {
"externalClientId": "ABCDEF"
}
}
Questions for the customer are mostly billing and contact related personal information (first name, last name, email, phone number etc).
Questions about the booking might include pickup location and other preferences not tied to any specific participant.
Questions about the participants can be other informations relevant to the activity planning (eg. first names and last names, height/wheight for equipment availability, document numbers, culinary preferences…)
All the questions are localized in the format in which the booking flow has been initiated.
The questions have four possible types defined by their dataType property:
TEXT: free text string
INT: numeric value
DATE: date, formatted YYYY-MM-DD
OPTIONS: a choice of one among N preset values, provided in the optionChoices property.
Additionaly, they can have their format defined by an optional dataFormat property:
DATE: for dates, formatted YYYY-MM-DD
EMAIL_ADDRESS: for email addresses
PHONE_NUMBER: for phone numbers (international prefix required)
All questions are required for the booking to proceed and must be validated based on their dataType and dataFormat. For example, an EMAIL_ADDRESS must follow standard email format validation.
When all of the questions are answered, the setQuestions endpoint will return the isQuestionsStepComplete set to true, and you’ll be able to move to the next step.
Note
The ‘followUpQuestions’ property is currently always empty, but on the next update of the Booking Flow will include the list of questions that are dependent on the answer to the parent question. Please plan your integration accordingly.