Skip to content
/Additional searches

Musement API (3.5.0)

For merchant or affiliate partners wishing to use the Musement API.

Find out more about Musement API

Authentication

See the Authentication section for details on how to authenticate with the API.

Release notes

2024-06-18

Endpoints

  • GET /activities/{activityUuid}/dates/{date}
    • Changed default min_buy value from -1 to 1

2024-02-21

Endpoints

  • Added GET /orders/{orderUuid}/refunds
    • Returns an array of paid refunds for an order

2024-02-20

Endpoints

  • GET /activities/{activityUuid}/dates/{date}
    • Added availability, max_buy and min_buy properties to timeslots. For more info, check out our guide
Download OpenAPI description
openapi.json
openapi.yaml
Overview
API distribution team
api-distribution@tui.com
License
Apache 2.0
Terms of Service
Languages
Servers
Mock server
https://partner-api.musement.com/_mock/reference/openapi
Sandbox server
https://sandbox.musement.com/api/v3
Production server
https://api.musement.com/api/v3

Searching activities

A collection of endpoints which can be used to search the catalog for relevant activities.

Operations

Activity info

A collection of endpoints which can be used to provide information to customers about a specific activity.

Operations

Pickups

Some activities require selecting a pickup location as part of the booking flow.

Operations

Dates

A collection of endpoints for selecting available dates and products.

Operations

Carts

A collection of endpoints for managing a customer's cart during the booking flow.

Operations

Customer info

When making a reservation, different steps must be taken to provide information about the customers. This collection includes endpoints for submitting info about the lead booker, extra customer data and participant info.

Operations

Orders

A collection of endpoints for managing orders as part of the booking flow.

Operations

Payments

A collection of endpoints regarding payment during the booking flow. Partners have multiple payment options at their disposal, depending on agreements with the Strategic partnerships team.

Operations

Cancellations

It is possible to cancel reservations, provided that the activity in question is refundable.

Operations

Activities

Activities can be any tour, attraction or experience that customers can reserve via the Musement API.

Operations

Categories

Categories group activities based on similar characteristics.

Operations

Cities

Cities are different types of destinations: islands, natural landmarks, beaches, actual cities and more.

Operations

Countries

A collection of endpoints related to countries in the Musement catalog.

Operations

Lists

Lists are collections of Musement activities and third-party destinations grouped together based on editorial themes.

Operations

Venues

Venues are popular attractions or landmarks.

Operations

Additional searches

A collection of additional endpoints which can be used to search parts of the catalog.

Operations

Autocomplete

Request

This endpoint is ideal for creating a list of choices as part of an autocomplete feature.

Using any of the parameters that ends with _limit will return that items for that resource in the response. It is possible to include multiple parameters to return multiple resources.

Query
activity_limitinteger>= 0

Limit the maximum number of activities to include in the response.

A positive value is required in order to receive activities in the response.

activity_offsetinteger>= 0

Exclude the first N activities from the response, where N is the specified integer value.

Default 0
category_limitinteger>= 0

Limit the maximum number of categories to include in the response.

A positive value is required in order to receive categories in the response.

category_offsetinteger>= 0

Exclude the first N categories from the response, where N is the specified integer value.

Default 0
city_limitinteger>= 0

Limit the maximum number of cities to include in the response.

A positive value is required in order to receive cities in the response.

city_offsetinteger>= 0

Exclude the first N cities from the response, where N is the specified integer value.

Default 0
coordinatesstring(-)?\d{1,3}(\.\d+)?,(-)?\d{1,3}(\.\d+)?

Filter results using latitude and longitude, separated by a comma.

By itself, this parameter does not affect the results. Use the sort_by parameter to get results closest (or farthest) from the specified coordinates.

Results that do not contain coordinate data will not be affected by this parameter.

country_limitinteger>= 0

Limit the maximum number of countries to include in the response.

A positive value is required in order to receive countries in the response.

country_offsetinteger>= 0

Exclude the first N countries from the response, where N is the specified integer value.

Default 0
hotel_limitinteger>= 0

Limit the maximum number of hotels to include in the response.

A positive value is required in order to receive hotels in the response.

hotel_offsetinteger>= 0

Exclude the first N hotels from the response, where N is the specified integer value.

Default 0
list_limitinteger>= 0

Limit the maximum number of Musement lists to include in the response.

A positive value is required in order to receive lists in the response.

list_offsetinteger>= 0

Exclude the first N Musement lists from the response, where N is the specified integer value.

Default 0
pickup_limitinteger>= 0

Limit the maximum number of pickup points to include in the response.

A positive value is required in order to receive pickup points in the response.

pickup_offsetinteger>= 0

Exclude the first N pickup points from the response, where N is the specified integer value.

Default 0
sort_byArray of strings

Sort results by one or more of the following values:

  • relevance: From lowest to highest relevance value.
  • -relevance: From highest to lowest relevance value.
  • distance: Results closest to the coordinates parameter appear first.
  • -distance: Results farthest from the coordinates parameter appear first.

This parameter will accept two values, separated with a comma.

Items which do not use relevance or coordinates will not be affected by this parameter.

Items Enum"distance""-distance""relevance""-relevance"
textstring>= 3 charactersrequired

Filter results to those which contain specified key words.

venue_limitinteger[ 0 .. 5 ]

Limit the maximum number of venues to include in the response.

A positive value is required in order to receive venues in the response.

Using a value greater than the maximum is ignored and the maximum number of possible results is used instead.

venue_offsetinteger>= 0

Exclude the first N venues from the response, where N is the specified integer value.

Default 0
Headers
Accept-Languagestring(Language code)

The value of this parameter might affect the language of the content in the response, provided a translation in the requested language is available.

Default en-US
X-Musement-Applicationstring(Application value)

A partner's application value, used for analyzing API usage and to identify areas of improvement.

For more info, check out our guide.
X-Musement-Versionstring^[0-9]+?.[0-9]+?.[0-9]+?$

The API version to use for the request.

When absent, the latest version is used by default, however the latest version may not be stable. Partners are encouraged to use the latest stable version: 3.4.0.

Example: 3.4.0
For more info, check out our guide.
curl -i -X GET \
  'https://partner-api.musement.com/_mock/reference/openapi/autocomplete?activity_limit=0&activity_offset=0&category_limit=0&category_offset=0&city_limit=0&city_offset=0&coordinates=string&country_limit=0&country_offset=0&hotel_limit=0&hotel_offset=0&list_limit=0&list_offset=0&pickup_limit=0&pickup_offset=0&sort_by=distance&text=string&venue_limit=5&venue_offset=0' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'

Responses

Autocomplete results

Bodyapplication/jsonArray [
typestring

The type of resource.

Enum"activities""categories""cities""countries""hotels""lists""pickups""venues"
itemsArray of objects

An array of items which match the query and corresponding resource type.

]
Response
application/json
[
  {
    "type": "activities",
    "items": [ … ]
  }
]

Carts

A collection of cart endpoints which are not strictly necessary for the booking flow.

Operations

Metadata

Metadata is used for configuring several activity properties.

Operations

Reviews

Customers may leave reviews about their experience with an activity. Reviews consist of a numeric rating and optional written comment.

Operations

Vouchers

A collection of endpoints to use at the end of the booking flow to retrieve reserved tickets and vouchers.

Operations

Webhooks

A collection of webhook requests that Musement's API can make to a partner's service.

Webhooks

Activities

A collection of deprecated endpoints for activities.

Operations

Carts

A collection of deprecated endpoints for carts.

Operations

Cities

A collection of deprecated endpoints for cities.

Operations

Verticals

Verticals are a type of macro category which group various parts of the catalog together based on similar characteristics.

They are considered deprecated.

Operations

Cities

A collection of endpoints for cities that were removed from the API.

Operations

Countries

A collection of endpoints for countries that were removed from the API.

Operations

Events

A collection of endpoints for events, an older term for activities, that were removed from the API.

Operations

Misc

A collection of various endpoints that were removed from the API.

Operations

Venues

A collection of endpoints for venues that were removed from the API.

Operations
Copyright © TUI Musement. All rights reserved.