Pickup points

The Musement catalog contains activities which may offer customers pickup from their hotel or designated locations. In some cases, this option is presented as extra customer data which can be displayed at checkout.

However, pickup points can also to a type of pickup which must be selected at the beginning of the booking flow since available dates, options and prices can change based on the selected pickup.

Differentiating between the two pickup cases can be confusing, as both may use the same value in an activity's services property:

{
	[...]
	"services": [
		{
			"code": "pick-up",
			"name": "Hotel pick up"
		}
	],
	[...]
}

Partners are expected to use an activity's order_box_elements property to correctly identify the booking flow for an activity.

Activities without pickup points will have the following value:

{
	[...]
	"order_box_elements": [
		"tours-and-activities"
	],
	[...]
}

When an activity does not have pickup points, customers do not select pickup at the beginning of the booking flow.

Activities with pickup points will have the following value:

{
	[...]
	"order_box_elements": [
		"tours-and-activities-with-pickup"
	],
	[...]
}

When an activity has this kind of pickup points, customers must choose a pickup point at the beginning of the booking flow.

To get a list of pickup points for an activity, make the following request:

curl -X GET '{baseUrl}/activities/{activityUuid}/pickups' \
-H 'X-Musement-Application: {applicationValue}' \
-H 'X-Musement-Version: 3.4.0' \
-H 'Authorization: Bearer {accessToken}'

The response contains a list of all the available pickup points:

[
	[...]
	{
		"uuid": "4fd4f187-cecc-4fb1-b619-9f41bfb05c5a",
		"type": "HOTEL",
		"name": "Aguait resort & spa tui sensimar",
		"latitude": 39.695,
		"longitude": 3.45416,
		"tags": [
			{
				"id": "6648"
			}
		]
	},
	{
		"uuid": "f49bd49a-d56b-4cff-a918-3d775c0838c9",
		"type": "PICKUP",
		"name": "Taxi stop hotel melbeach",
		"latitude": 39.65577,
		"longitude": 3.43884,
		"tags": []
	},
	[...]
]

Once a pickup point has been selected, its uuid must be provided for most steps in the booking flow. In the example below, we are requesting available dates for a specific pickup in an activity:

curl -X GET '{baseUrl}/activities/{activityUuid}/dates?pickup={pickupUuid}' \
-H 'X-Musement-Application: {applicationValue}' \
-H 'X-Musement-Version: 3.4.0' \
-H 'Authorization: Bearer {accessToken}'

For more information about the booking flow for activities with pickup points, refer to the dedicated page.