Skip to content
API reference/
/
Get category tree

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

Get category with city

Request

This endpoint returns a category along with the requested city in the city property, useful when constructing a page for a category in a city.

Path
categoryIdinteger(Category ID)>= 1required

The numeric ID of the category.

cityIdinteger(City ID)>= 1required

The numeric ID of the city.

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-Marketstring(Musement market)

Musement markets contain a modified catalog of activities and prices. Partners are expected to use their assigned market code to view their customized catalog.

An invalid X-Musement-Market value will return a 400 status code response.

Default us
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/categories/{categoryId}/cities/{cityId}' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Market: us' \
  -H 'X-Musement-Version: 3.4.0'

Responses

Category with city

Bodyapplication/json
idinteger>= 1required

The category's numerical ID.

Example: 185
namestringrequired

The category's name, translated based on the Accept-Language header value.

Example: "Activities"
levelstring^\d+?$required

The category's level in the category tree.

Example: "1"
codestringrequired

A unique string code for the category.

Example: "new-activities"
event_image_urlstring(uri)
cover_image_urlstring(uri)
urlstring(uri)required

An automatically generated Musement URL for the category based on the X-Musement-Market header, code property and city property (when present). The URL is only valid for select X-Musement-Market values and categories.

Example: "https://.sbox.musement.com/us/all/activities-c/"
cityobject(City)required
city.​activities_countinteger

The number of available activities for the city.

city.​idinteger>= 1

The city's numeric ID.

city.​codestring

A string identifier for the city, based on the English version of the city name. This property is not affected by the Accept-Language header.

city.​contentstring

A plain text description of the city, translated according to the Accept-Language header value.

city.​content_htmlstring

A description of the city with HTML tags, translated according to the Accept-Language header value.

city.​countryobject(Country)
city.​cover_image_urlstring(uri)

A URL for the city's cover image.

city.​event_countinteger

The number of available activities for the city.

city.​headlinestring

An SEO-friendly version of the city name for a page headline, translated based on the Accept-Language header value.

city.​latitudenumber(float)
city.​longitudenumber(float)
city.​list_countinteger

The number of available Musement list pages for the city.

city.​meta_descriptionstring

An SEO-friendly description of the city, translated based on the Accept-Language header value.

city.​meta_titlestring

An SEO-friendly version of the city name, translated based on the Accept-Language header value.

city.​namestring

The name of city, translated according to the Accept-Language header value.

city.​slugstring

The city slug, used for creating the city URL. Changes based on the value of the Accept-Language value.

city.​time_zonestring

The city's time zone.

Based on PHP's list of valid time zones.
city.​topboolean

When true, the city is considered one of Musement's most popular cities.

Default false
city.​urlstring(uri)

An automatically generated Musement URL for the city based on the X-Musement-Market header and slug property. The URL is only valid for select X-Musement-Market values and cities.

city.​uuidstring(uuid)

The city's UUID.

city.​venue_countinteger

The number of available venues in the city.

city.​weightinteger

A property used for ranking multiple cities by popularity. Top selling cities will have a higher value.

city.​morestringDeprecated

Additional information about the city in plain text, ideal for a "Read more" section, translated based on the Accept-Language header value.

city.​more_htmlstringDeprecated

Additional information about the city with HTML tags, ideal for a "Read more" section, translated based on the Accept-Language header value.

meta_descriptionstring

An SEO-friendly description of the category, translated based on the Accept-Language header value.

meta_titlestring

An SEO-friendly version of the category name to use for search results, translated based on the Accept-Language header value.

headlinestring

An SEO-friendly version of the category name for a page headline, translated based on the Accept-Language header value.

parent_idinteger

The ID of the category's parent, if any.

Response
application/json
{
  "code": "new-activities",
  "id": 185,
  "level": "1",
  "name": "Activities",
  "url": "https://.sbox.musement.com/us/all/activities-c/"
}

Get category tree

Request

Get all categories in their hierarchical tree structure. The response itself is a "fake" category whose children property contains all the real categories.

Headers
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/categories-tree \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'

Responses

Category tree

Bodyapplication/json
childrenArray of objects(Category level 1)required

Level-one categories, which can be considered sub-categories to the root level.

Example: [{"children":[{"children":[{"children":[],"code":"new-helicopter-ride","id":188,"level":"3","name":"Helicopter rides"}],"code":"new-air-activities","id":186,"level":"2","name":"Air activities"}],"code":"new-activities","id":185,"level":"1","name":"Activities"}]
children[].​childrenArray of objects(Category level 2)required

Sub-categories, if any, which belong to the category.

children[].​children[].​childrenArray of objects(Category level 3)required

Sub-categories, if any, which belong to the category.

children[].​children[].​children[].​childrenArray of arrays

Since level-three categories do not have sub-categories, this value is always an empty array.

children[].​children[].​children[].​idinteger>= 1required

The category's numerical ID.

children[].​children[].​children[].​levelstring^\d+?$required

The category's level in the category tree.

children[].​children[].​children[].​namestringrequired

The category's name, translated based on the Accept-Language header value.

children[].​children[].​idinteger>= 1required

The category's numerical ID.

children[].​children[].​levelstring^\d+?$required

The category's level in the category tree.

children[].​children[].​namestringrequired

The category's name, translated based on the Accept-Language header value.

children[].​idinteger>= 1required

The category's numerical ID.

children[].​levelstring^\d+?$required

The category's level in the category tree.

children[].​namestringrequired

The category's name, translated based on the Accept-Language header value.

idintegerrequired

The category's numerical ID. At the root level, this value is fake.

Default 0
levelstringrequired

The category's level in the category tree. At the root level, this value is fake.

Default "0"
Example: "0"
namestringrequired

The category's name, translated based on the Accept-Language header value. At the root level, this value is fake.

Default ""
Response
application/json
{
  "children": [
    { … }
  ],
  "code": "0",
  "id": 0,
  "level": "0",
  "name": ""
}

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

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.