Activities

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

Search activities

Request
query Parameters
available_from
string <date>

Filter activities by their available dates. Only activities with at least one available date after this parameter value are returned.

Must be used together with available_to parameter.

available_language_in
Array of strings (Language code)

Filter activities to those which accommodate at least one of the specified languages.

Example: available_language_in=en,it
available_to
string <date>

Filter activities by their available dates. Only activities with at least one available date before this parameter value are returned.

Must be used together with available_from parameter.

category_in
Array of strings (Category code)

Filter results to those which use at least one of the specified categories.

Example: category_in=new-activities
city_in
Array of integers (City ID)

Filter results to those which are connected to at least one of the specified cities.

coordinates
string(-)?\d{1,3}(\.\d+)?,(-)?\d{1,3}(\.\d+)?

Filter results to those located near the specified latitude and longitude. Separate the coordinates with a comma.

Must be used together with the distance parameter.

Example: coordinates=45.7386,-9.3641
country_in
Array of strings (Country ISO code)

Filter results to those which are connected to at least one of the specified countries.

Example: country_in=IT,US
default_price_range
string^\d{1,5}(.\d{1,2})?,\d{1,5}(.\d{1,2})?$

Filter results by price. Results will contain pricing which falls between the two specified amounts.

Parameter requires two values, a lower and upper bound, separated by a comma. Each value must be a float or integer. Parameter accepts up to two decimal digits.

This parameter uses the currency value in the X-Musement-Currency header.

Example: default_price_range=0,34.23
distance
string^\d{1,1000}(KM|M)$

Filter results to activities located within the specified radius around a pair of coordinates. Parameter must include one of the following units:

  • KM: kilometers
  • M: miles

Must be used together with the coordinates parameter.

Example: distance=5KM
discounted
string

Filter results by discount:

  • NO: return activities without discounts.
  • YES: only return activities with discounts.
Enum: NO YES
duration_range
string^\d{1,5}(.\d{1,2})?(,\d{1,5}(.\d{1,2})?)?$

Filter results by their duration. Parameter can accept a single lower bound value or both a lower and upper bound separated by a comma.

Parameter values are treated as hours. Values can have up to two decimal places.

Example: duration_range=2,8
extend_content_fields
string
Default: AUTO

Combined with the text parameter, filter results based on the title only or all content properties:

  • AUTO: initially filter results based on titles. If no results are found, extend the search to include other content properties.
  • NO: filter results based on titles only.
  • YES: filter results based on all content properties.
Enum: AUTO NO YES
extend_other_languages
string
Default: AUTO

Combined with the text parameter, filter results based on the Accept-Language header value or all languages:

  • AUTO: initially filter results based on the Accept-Language header value. If no results are found, extend the search to include all languages.
  • NO: filter results based on the Accept-Language header value.
  • YES: filter results based on all languages.
Enum: AUTO YES NO
feature_in
Array of strings (Feature code)

Filter results to activities which use at least one of the specified features.

Example: feature_in=free,skip
fuzziness_level
string
Default: LEVEL-0

Change the "fuzziness" level for the text parameter value. Higher levels are less strict about exact text matches.

Enum: AUTO LEVEL-0 LEVEL-1 LEVEL-2
include_facets
Array of strings

Include specified statistics about activities matching the query. Results appear in the facets property in the response.

Every facet contains details which can be used to modify the /activities query parameters further.

Most facets contain a breakdown of the number of activities which use that value. These numbers account for all activities which match the query, not just those in the response. When querying for prices, facet values contain the relevant price value instead.

Valid parameter values provide:

  • available_language: up to ten languages
  • category: up to ten categories
  • categories_tree: all categories in their tree structure
  • city: up to ten cities
  • country: up to ten countries
  • duration: a breakdown of activity durations:
    • Up to 2 hours
    • 2-4 hours
    • 4-8 hours
    • 8-24 hours
    • Over 24 hours
  • feature: up to 10 features
  • hotel: up to 1000 hotels
  • price: lowest and highest prices
  • seller: up to 10 seller gateways
  • service: up to 10 services
  • vertical: up to 10 verticals
  • vertical_categories: up to 10 verticals
Items Enum: available_language category categories_tree city country duration feature hotel price seller service venue vertical vertical_categories
Example: include_facets=feature,service
limit
integer <= 100
Default: 10

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

offset
integer >= 0
Default: 0

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

pickup_in
Array of strings <uuid> (Pickup UUID)

Filter results to activities which use at least one of the specified pickups.

preferred_seller_boost
integer
Default: 1000

A numeric value to increase the boost for activities whose seller gateway matches the preferred_seller_code parameter.

preferred_seller_code
string (Seller gateway code)

Activities connected to the specified seller gateway are "boosted" - treated as if they have a higher relevance value. When sorting by -relevance (from highest to lowest), these activities are more likely to appear first.

Example: preferred_seller_code=Direct
seller_in
Array of strings (Seller gateway code)

Filter results to activities which use any of the specified seller gateways.

Example: seller_in=Direct
text
string

Filter results by key words.

text_operator
string
Default: AUTO

Change how the text parameter filters results when multiple words are used:

  • AND: results must contain all the key words.
  • AUTO: filters by AND first. If there are no results, extend to include OR results.
  • OR: results must contain at least one of the key words.
Enum: AND AUTO OR
service_in
Array of strings (Service code)

Filter results to activities which use at least one of the specified services.

Example: service_in=pick-up,pet-friendly
sort_by
Array of strings

Sort results by one or more criteria.

Results are sorted from lowest to highest value by default. To sort from highest to lowest, add - in front of the value.

Sorting by distance requires the coordinates parameter.

Items Enum: -distance -price -rating -relevance -relevance-category -relevance-city -relevance-external -relevance-venue distance price rating relevance relevance-category relevance-city relevance-external relevance-venue
Example: sort_by=price,-rating
temporary
string

Filter results based on their temporary property:

  • NO: return results with a temporary value of false.
  • YES: return results with a temporary value of true.
Enum: NO YES
venue_in
Array of integers (Venue ID)

Filter results to activities which are connected to at least one of the specified venues.

vertical_in
Array of strings (Vertical code)
Deprecated

Filter results to those which are connected to at least one of the specified verticals.

Example: vertical_in=sightseeing
zero_terms_query
string
Default: NONE

If set to ALL, if all of the stop words have been removed, search will be performed, if set to 'NONE' will not

Enum: NONE ALL
header Parameters
Accept-Language
string (Language code)
Default: en-US

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

X-Musement-Application
string (Application value)

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

X-Musement-Currency
string (Currency code)
Default: USD

A valid currency code from the /currencies endpoint. Default value may vary depending on the X-Musement-Market header value.

X-Musement-Market
string (Musement market)
Default: us

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.

X-Musement-Version
string^[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
Responses
200

Activities

default

Error

get/activities
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/activities?available_from=2019-08-24&available_language_in=en%2Cit&available_to=2019-08-24&category_in=new-activities&city_in=0&coordinates=45.7386%2C-9.3641&country_in=IT%2CUS&default_price_range=0%2C34.23&distance=5KM&discounted=NO&duration_range=2%2C8&extend_content_fields=AUTO&extend_other_languages=AUTO&feature_in=free%2Cskip&fuzziness_level=AUTO&include_facets=feature%2Cservice&limit=10&offset=0&pickup_in=497f6eca-6276-4993-bfeb-53cbbbba6f08&preferred_seller_boost=1000&preferred_seller_code=Direct&seller_in=Direct&text=string&text_operator=AND&service_in=pick-up%2Cpet-friendly&sort_by=price%2C-rating&temporary=NO&venue_in=0&vertical_in=sightseeing&zero_terms_query=NONE' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Currency: USD' \
  -H 'X-Musement-Market: us' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
{
  • "data": [
    ],
  • "facets": [
    ],
  • "meta": {
    }
}

Get activity

Request
path Parameters
activityUuid
required
string <uuid>

The UUID of the activity.

header Parameters
Accept-Language
string (Language code)
Default: en-US

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

X-Musement-Application
string (Application value)

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

X-Musement-Currency
string (Currency code)
Default: USD

A valid currency code from the /currencies endpoint. Default value may vary depending on the X-Musement-Market header value.

X-Musement-Market
string (Musement market)
Default: us

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.

X-Musement-Version
string^[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
Responses
200

Activity

403

Forbidden: activity is not accessible to partners

404

Not found: activity with UUID does not exist

default

Error

get/activities/{activityUuid}
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/activities/{activityUuid}' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Currency: USD' \
  -H 'X-Musement-Market: us' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
{
  • "about": "Join this exclusive tour to discover one of the most iconic works ever: Leonardo da Vinci's Last Supper.You will meet your expert guide in Piazza Santa Maria delle Grazie, where you will begin the tour with a brief explanation.Afterward, thanks to your skip-the-line ticket, you'll go inside straight away without having to wait at the entrance so you can be united with one of the most admired paintings in the world, created by one of the greatest geniuses that ever existed.Here your guide will continue to unravel all the mysteries behind this artwork. What's ironic about the location of the painting? How come The Last Supper isn't a fresco? What happened to the eyes of some characters? How is the painting structured? What do the conspiracy theories say? How do we recognize the genius of Leonardo da Vinci?You will find all the answers to these questions and many others on this unmissable tour!",
  • "about_html": "<p>Join this exclusive tour to discover one of the most iconic works ever: Leonardo da Vinci's Last Supper.</p><p>You will meet your expert guide in Piazza Santa Maria delle Grazie, where you will begin the tour with a brief explanation.</p><p>Afterward, thanks to your skip-the-line ticket, you'll go inside straight away without having to wait at the entrance so you can be united with one of the most admired paintings in the world, created by one of the greatest geniuses that ever existed.</p><p>Here your guide will continue to unravel all the mysteries behind this artwork. What's ironic about the location of the painting? How come The Last Supper isn't a fresco? What happened to the eyes of some characters? How is the painting structured? What do the conspiracy theories say? How do we recognize the genius of Leonardo da Vinci?</p><p>You will find all the answers to these questions and many others on this unmissable tour!</p>",
  • "about_markdown": "Join this exclusive tour to discover one of the most iconic works ever: Leonardo da Vinci's Last Supper.\n\nYou will meet your expert guide in Piazza Santa Maria delle Grazie, where you will begin the tour with a brief explanation.\n\nAfterward, thanks to your skip-the-line ticket, you'll go inside straight away without having to wait at the entrance so you can be united with one of the most admired paintings in the world, created by one of the greatest geniuses that ever existed.\n\nHere your guide will continue to unravel all the mysteries behind this artwork. What's ironic about the location of the painting? How come The Last Supper isn't a fresco? What happened to the eyes of some characters? How is the painting structured? What do the conspiracy theories say? How do we recognize the genius of Leonardo da Vinci?\n\nYou will find all the answers to these questions and many others on this unmissable tour!",
  • "automatically_translated": false,
  • "best_price": false,
  • "booking_type": "CALENDAR-TIMESLOTS",
  • "buy_multiplier": 1,
  • "city": {
    },
  • "cutoff_time": "P2D",
  • "daily": false,
  • "description": "Buy your skip-the-line tickets for the Last Supper in Milan. Enjoy a guided tour and discover the mysteries hidden behind one of the most important works ever!",
  • "discount": 0,
  • "duration": "PT45M",
  • "duration_range": {
    },
  • "exclusive": false,
  • "features": [
    ],
  • "flavours": [
    ],
  • "food": [ ],
  • "free_cancellation": true,
  • "giftable": true,
  • "giftcard": false,
  • "group_size": [
    ],
  • "has_extra_customer_data": false,
  • "has_multiple_options": false,
  • "has_passenger_info": true,
  • "has_price_info_on_date": true,
  • "highlights": [
    ],
  • "included": [
    ],
  • "info": "<ul><li>The venue requires us to provide the name and surname of each visitor; this information is mandatory for purchasing the ticket and for entering the Last Supper. If this requirement isn't met, it will not be possible to enter the venue. The name given at the time of booking must correspond to the name on the participant's passport or identity card. Tickets are nominal and cannot be changed once the booking is completed. Each participant must bring with him/her an identity document</li><li>Due to the rules imposed by the supervisor of cultural artifacts for the city of Milan, your visit to the Last Supper cannot exceed 15 minutes</li><li>Dress code: shoulders and knees must be covered and men should wear full-length trousers</li><li>No liquids, including water bottles, are allowed inside the site</li><li>Large bags/backpacks/suitcases are not permitted inside the Last Supper (only very small bags are allowed). There are no cloakrooms for storing these items but there are free lockers available for small items and bottles</li><li>Photos are not allowed</li><li>The tour is run in small groups</li></ul>",
  • "is_available_today": false,
  • "is_available_tomorrow": false,
  • "languages": [
    ],
  • "latitude": 45.4653785,
  • "longitude": 9.1710985,
  • "last_chance": false,
  • "likely_to_sell_out": false,
  • "max_confirmation_time": "P0D",
  • "meeting_point": "At the corner of Piazza Santa Maria delle Grazie and Corso Magenta - in front of the Vigna di Leonardo Ticket Office, at least 15 minutes before the starting time of the tour.",
  • "meeting_point_html": "<p>At the corner of Piazza Santa Maria delle Grazie and Corso Magenta - in front of the Vigna di Leonardo Ticket Office, at least 15 minutes before the starting time of the tour.</p>",
  • "meeting_point_markdown": "At the corner of Piazza Santa Maria delle Grazie and Corso Magenta - in front of the Vigna di Leonardo Ticket Office, at least 15 minutes before the starting time of the tour.",
  • "meta_description": "Buy your skip-the-line tickets for the Last Supper in Milan. Enjoy a guided tour and discover the mysteries hidden behind one of the most important works ever!",
  • "meta_title": "Skip-the-line tickets and guided tour of the Last Supper",
  • "must_see": false,
  • "needs_voucher": false,
  • "not_included": [ ],
  • "numbered_seats": false,
  • "open": false,
  • "order_box_elements": [
    ],
  • "original_retail_price": {
    },
  • "original_retail_price_without_service_fee": {
    },
  • "relevance": 900,
  • "relevance_venue": 10000,
  • "retail_price": {
    },
  • "retail_price_without_service_fee": {
    },
  • "reviews_aggregated_info": {
    },
  • "reviews_avg": 4.5,
  • "reviews_number": 4348,
  • "saves": 0,
  • "seller_gateway": {
    },
  • "service_fee": {
    },
  • "services": [
    ],
  • "slug": "da-vinci-s-last-supper-skip-the-line-tickets-and-guided-tour",
  • "slug_id": "da-vinci-s-last-supper-skip-the-line-tickets-and-guided-tour-497",
  • "sold_out": false,
  • "special_offer": false,
  • "status": "ONLINE",
  • "supplier": {
    },
  • "supplier_currency": "EUR",
  • "temporary": false,
  • "ticket": false,
  • "ticket_not_included": false,
  • "title": "Da Vinci's Last Supper skip-the-line tickets and guided tour",
  • "top_seller": true,
  • "translated": true,
  • "uuid": "0f548def-2046-11e7-9cc9-06a7e332783f",
  • "validity": "P0D",
  • "venues": [
    ],
  • "verticals": [],
  • "voucher_access_usage": "MOBILE",
  • "voucher_always_include_ours": false,
  • "where_text": "<p>Corso Magenta, 65/69, 20123 Milan MI, Italy</p><p> </p>"
}

Get bundles for activity

Bundles are recommendations of other activities to purchase together with the current activity.

Recommendations are based on activities which are often purchased together by other customers. Sometimes a bundle may contain a promotional discount which can be applied to one or both activities when added to cart.

Request
path Parameters
activityUuid
required
string <uuid>

The UUID of the activity.

header Parameters
Accept-Language
string (Language code)
Default: en-US

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

X-Musement-Application
string (Application value)

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

X-Musement-Currency
string (Currency code)
Default: USD

A valid currency code from the /currencies endpoint. Default value may vary depending on the X-Musement-Market header value.

X-Musement-Market
string (Musement market)
Default: us

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.

X-Musement-Version
string^[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
Responses
200

Bundles for activity

403

Forbidden: activity is not accessible to partners

404

Not found: activity does not exist or it has no bundles

default

Error

get/activities/{activityUuid}/bundles
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/activities/{activityUuid}/bundles' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Currency: USD' \
  -H 'X-Musement-Market: us' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[
  • {
    }
]

Get translation for activity

Returns a translation (if it exists) for an activity.

Request
path Parameters
activityUuid
required
string <uuid>

The UUID of the activity.

locale
required
string (Language code) [ 2 .. 5 ] characters
header Parameters
X-Musement-Application
string (Application value)

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

X-Musement-Version
string^[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
Responses
200

Translation for activity

404

One of the resources does not exist

default

Error

get/activities/{activityUuid}/contents/{locale}
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/activities/{activityUuid}/contents/{locale}' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
{
  • "description": "<p>Join this exclusive tour to discover one of the most iconic works ever: Leonardo da Vinci&#39;s Last Supper.</p>\r\n\r\n<p>You will meet your expert guide in Piazza Santa Maria delle Grazie, where you will begin the tour with a brief explanation.</p>\r\n\r\n<p>Afterward, thanks to your skip-the-line ticket, you&#39;ll go inside straight away without having to wait at the entrance so you can be united with one of the most admired paintings in the world, created by one of the greatest geniuses that ever existed.</p>\r\n\r\n<p>Here your guide will continue to unravel all the mysteries behind this artwork. What&#39;s ironic about the location of the painting? How come The Last Supper isn&#39;t a fresco? What happened to the eyes of some characters? How is the painting structured? What do the conspiracy theories say? How do we recognize the genius of Leonardo da Vinci?</p>\r\n\r\n<p>You will find all the answers to these questions and many others on this unmissable tour!</p>",
  • "highlights": "<ul>\r\n\t<li>Admire Leonardo da Vinci&#39;s Last Supper</li>\r\n\t<li>Enter quickly&nbsp;by skipping the line at the entrance</li>\r\n\t<li>Discover the wonders and mysteries&nbsp;hidden behind this work of art</li>\r\n</ul>",
  • "included": "<ul>\r\n\t<li>Exclusive English or Italian-speaking Musement guide</li>\r\n\t<li>Skip-the-line entrance to Leonardo da Vinci&#39;s Last Supper</li>\r\n</ul>",
  • "info": "<ul>\r\n\t<li>The venue requires us to provide the name and surname of each visitor; this information is mandatory for purchasing the ticket and for entering the Last Supper. If this requirement isn&#39;t met, it will not be possible to enter the venue. The name given at the time of booking must correspond to the name on the participant&#39;s passport or identity card. Tickets are nominal and cannot be changed once the booking is completed. Each participant must bring with him/her an identity document</li>\r\n\t<li>Due to the rules imposed by the supervisor of cultural artifacts for the city of Milan, your visit to the Last Supper cannot exceed 15 minutes</li>\r\n\t<li>Dress code: shoulders and knees must be covered and men should wear full-length trousers</li>\r\n\t<li>No liquids,&nbsp;including water bottles, are allowed inside the site</li>\r\n\t<li>Large bags/backpacks/suitcases are not permitted inside the Last Supper (only very small bags are allowed). There are no cloakrooms for storing these items but there are free lockers available for small items and bottles</li>\r\n\t<li>Photos are not allowed</li>\r\n\t<li>The tour is run in small groups</li>\r\n</ul>",
  • "info_voucher": "<ul>\r\n\t<li>Tickets are nominal and cannot be changed once the booking is completed. Shoulders and knees must be covered and men should wear full-length trousers. No liquids,&nbsp;including water bottles, are allowed inside the site. Large bags/backpacks/suitcases are not permitted inside&nbsp;(only very small bags). There are no cloakrooms for storing these items. Free lockers are available for small items and bottles. Photos are not allowed</li>\r\n\t<li>Each participant must bring with him/her an identity document</li>\r\n</ul>",
  • "is_default": true,
  • "is_manually_translated_complete": true,
  • "is_manually_translated_highlights": true,
  • "is_manually_translated_info_voucher": true,
  • "is_manually_translated_meeting_point": true,
  • "is_manually_translated_title": true,
  • "locale": "us",
  • "meeting_point": "<p>At the corner of Piazza Santa Maria delle Grazie&nbsp;and Corso Magenta&nbsp;- in front of the Vigna di Leonardo Ticket Office, at least 15 minutes before the starting time of the tour.</p>",
  • "meta_description": "Buy your skip-the-line tickets for the Last Supper in Milan. Enjoy a guided tour and discover the mysteries hidden behind one of the most important works ever!",
  • "meta_title": "Skip-the-line tickets and guided tour of the Last Supper",
  • "slug": "da-vinci-s-last-supper-skip-the-line-tickets-and-guided-tour",
  • "title": "Da Vinci's Last Supper skip-the-line tickets and guided tour",
  • "translated": true,
  • "where": "<p>Corso Magenta, 65/69, 20123 Milan MI, Italy</p>\r\n\r\n<p>&nbsp;</p>"
}

Search dates in activity

Depending on the activity configuration, this endpoint may return price info in addition to dates.

For activities with pickups, the pickup query parameter must be used.

Request
path Parameters
activityUuid
required
string <uuid>

The UUID of the activity.

query Parameters
date_from
string <date>

Filter results to those which take place on or after the specified date.

When absent, today's date is used by default.

date_to
string <date>

Filter results to those which take place before the specified date.

When absent, a value of roughly one year from today's date is used. The exact default value varies depending on the activity configuration.

discounts[]
Array of numbers <float>

Response will contain a retail_prices_with_custom_discount property which contains a preview of prices after the specified discounts are applied.

Up to two decimal places are permitted.

Example: discounts[]=10&discounts[]=15.5&discounts[]=22.05
pickup
string <uuid> (Pickup UUID)

Filter dates to those which are available for the specified pickup.

Required for activities whose order_box_elements property contains tours-and-activities-with-pickup.

tickets_number
integer

Filter dates to those which have enough seats available for the specified quantity.

Used for activities with select seller gateways.

header Parameters
Accept-Language
string (Language code)
Default: en-US

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

X-Musement-Application
string (Application value)

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

X-Musement-Currency
string (Currency code)
Default: USD

A valid currency code from the /currencies endpoint. Default value may vary depending on the X-Musement-Market header value.

X-Musement-Market
string (Musement market)
Default: us

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.

X-Musement-Version
string^[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
Responses
200

Dates for activity

403

Forbidden: activity is not accessible to partners

404

Not found: activity with UUID does not exist

default

Error

get/activities/{activityUuid}/dates
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/activities/{activityUuid}/dates?date_from=2019-08-24&date_to=2019-08-24&discounts%5B%5D=10%2C15.5%2C22.05&pickup=497f6eca-6276-4993-bfeb-53cbbbba6f08&tickets_number=0' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Currency: USD' \
  -H 'X-Musement-Market: us' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[
  • {
    }
]

Get schedule for date in activity

Returns all options, times, holders, languages and products for the specified date. A product's type and ID, required for adding a product to cart, can be found in the response.

For activities with pickups, the pickup query parameter must be used.

Request
path Parameters
activityUuid
required
string <uuid>

The UUID of the activity.

date
required
string <date>

The specified date.

query Parameters
discounts[]
Array of numbers <float>

Response will contain a retail_prices_with_custom_discount property which contains a preview of prices after the specified discounts are applied.

Up to two decimal places are permitted.

Example: discounts[]=10&discounts[]=15.5&discounts[]=22.05
pickup
string <uuid> (Pickup UUID)

Filter dates to those which are available for the specified pickup.

Required for activities whose order_box_elements property contains tours-and-activities-with-pickup.

tickets_number
integer

Filter dates to those which have enough seats available for the specified quantity.

Used for activities with select seller gateways.

header Parameters
Accept-Language
string (Language code)
Default: en-US

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

X-Musement-Application
string (Application value)

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

X-Musement-Currency
string (Currency code)
Default: USD

A valid currency code from the /currencies endpoint. Default value may vary depending on the X-Musement-Market header value.

X-Musement-Market
string (Musement market)
Default: us

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.

X-Musement-Version
string^[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
Responses
200

Schedule for date

403

Forbidden: activity is not accessible to partners

404

Not found: activity with UUID or date in activity do not exist

default

Error

get/activities/{activityUuid}/dates/{date}
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/activities/{activityUuid}/dates/{date}?discounts%5B%5D=10%2C15.5%2C22.05&pickup=497f6eca-6276-4993-bfeb-53cbbbba6f08&tickets_number=0' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Currency: USD' \
  -H 'X-Musement-Market: us' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[
  • {
    }
]

Get cities for activity

Every activity has one default city which appears in the /activities and /activities/{activityUuid} endpoints. However, an activity may be connected to multiple cities.

This endpoint lists all connected cities and indicates which one is the default.

Request
path Parameters
activityUuid
required
string <uuid>

The UUID of the activity.

header Parameters
Accept-Language
string (Language code)
Default: en-US

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

X-Musement-Application
string (Application value)

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

X-Musement-Version
string^[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
Responses
200

Cities for activity

403

Forbidden: activity is not accessible to partners

404

Not found: activity with UUID does not exist

default

Error

get/activities/{activityUuid}/destinations
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/activities/{activityUuid}/destinations' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[
  • {
    }
]

Get extra customer data schema for activity

Extra customer data is information requested per reservation. You can use this endpoint for a preview of possible fields that might be used during the reservation flow.

The response follows the JSON Schema Specification to describe the info requested for each participant.

Request
path Parameters
activityUuid
required
string <uuid>

The UUID of the activity.

header Parameters
X-Musement-Application
string (Application value)

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

X-Musement-Version
string^[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
Responses
200

Extra customer data for activity

403

Forbidden: activity is not accessible to partners

404

Not found: activity with UUID does not exist

503

Error

get/activities/{activityUuid}/extra-customer-data/schema
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/activities/{activityUuid}/extra-customer-data/schema' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
{
  • "title": "form",
  • "type": "object",
  • "properties": {
    },
  • "required": [
    ]
}

Get flavours for activity

Flavours are tags which provide additional information about an activity's characteristics.

Request
path Parameters
activityUuid
required
string <uuid>

The UUID of the activity.

header Parameters
Accept-Language
string (Language code)
Default: en-US

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

X-Musement-Application
string (Application value)

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

X-Musement-Version
string^[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
Responses
200

Flavours for activity

403

Forbidden: activity is not accessible to partners

404

Not found: activity with UUID does not exist

default

Error

get/activities/{activityUuid}/flavours
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/activities/{activityUuid}/flavours' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[
  • {
    }
]

Get translated languages for activity

This endpoint returns all the languages which have a translation in the activity. When using the Accept-Language header for select activity endpoints, the response contains either the corresponding translation (if available) or the default translation (usually English).

Request
path Parameters
activityUuid
required
string <uuid>

The UUID of the activity.

header Parameters
X-Musement-Application
string (Application value)

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

X-Musement-Version
string^[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
Responses
200

Translated languages for activity

403

Forbidden: activity is not accessible to partners

404

Not found: activity with UUID does not exist

default

Error

get/activities/{activityUuid}/languages
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/activities/{activityUuid}/languages' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[
  • {
    }
]

Get media for activity

The response contains an array of media items for the activity. Items are mainly images, but could also be video.

Depending on the activity configuration, the cover image may or may not be part of the results. If none of the results is the cover image, you can get its URL from the /activities/{activityUuid} endpoint.

Request
path Parameters
activityUuid
required
string <uuid>

The UUID of the activity.

header Parameters
X-Musement-Application
string (Application value)

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

X-Musement-Version
string^[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
Responses
200

Media for activity

403

Forbidden: activity is not accessible to partners

404

Not found: activity with UUID does not exist

default

Error

get/activities/{activityUuid}/media
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/activities/{activityUuid}/media' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[]

Get merchant tags for activity

This endpoint returns a list of merchant tags for an activity. Only merchant tags set up for the authenticated partner using a valid access token are returned.

Some merchant partners request custom tags for activities to better categorize them on their own platform. Partners must define the tags and their criteria with the Strategic partnerships team before Musement can begin assigning tags to activities.

Request
path Parameters
activityUuid
required
string <uuid>

The UUID of the activity.

header Parameters
X-Musement-Application
string (Application value)

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

X-Musement-Market
string (Musement market)
Default: us

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.

X-Musement-Version
string^[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
Responses
200

Merchant tags for activity

403

Forbidden: activity is not accessible to partners

404

Not found: activity with UUID does not exist

default

Error

get/activities/{activityUuid}/merchant-tags
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/activities/{activityUuid}/merchant-tags' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Market: us' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[
  • "Must have"
]

Get languages for activity

Get all languages which may be used for a timeslot in the specified activity.

Request
path Parameters
activityUuid
required
string <uuid>

The UUID of the activity.

header Parameters
X-Musement-Application
string (Application value)

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

X-Musement-Version
string^[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
Responses
200

Languages for activity

403

Forbidden: activity is not accessible to partners

404

Not found: activity with UUID does not exist

default

Error

get/activities/{activityUuid}/metadata/languages
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/activities/{activityUuid}/metadata/languages' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
{
  • "languages": [
    ]
}

Get participant info schema for activity

Participant info is required for each person in a reservation. You can use this endpoint for a preview of possible fields that might be used during the reservation flow.

The response follows the JSON Schema Specification to describe the info requested for each participant.

Request
path Parameters
activityUuid
required
string <uuid>

The UUID of the activity.

header Parameters
X-Musement-Application
string (Application value)

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

Accept-Language
string (Language code)
Default: en-US

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

X-Musement-Version
string^[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
Responses
200

Participant info for activity

403

Forbidden: activity is not accessible to partners

404

Not found: resource does not exist or it does not require participant info

503

Error

get/activities/{activityUuid}/participants-info/schema
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/activities/{activityUuid}/participants-info/schema' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
{
  • "title": "participant",
  • "type": "object",
  • "properties": {
    },
  • "required": [
    ]
}

Get pickups for activity

Some activities require selecting a pickup from this endpoint as part of the reservation flow.

Request
path Parameters
activityUuid
required
string <uuid>

The UUID of the activity.

header Parameters
X-Musement-Application
string (Application value)

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

X-Musement-Version
string^[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
Responses
200

Pickups for activity

403

Forbidden: activity is not accessible to partners

404

Not found: activity with UUID does not exist

default

Error

get/activities/{activityUuid}/pickups
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/activities/{activityUuid}/pickups' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[
  • {
    }
]

Get refund policies for activity

Returns an array of refund policies for the activity.

A 404 status code response can mean the activity does not exist or it does not have refund policies. Activities without refund policies are non-refundable.

Request
path Parameters
activityUuid
required
string <uuid>

The UUID of the activity.

header Parameters
X-Musement-Application
string (Application value)

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

X-Musement-Version
string^[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
Responses
200

Refund policies for activity

403

Forbidden: activity is not accessible to partners

404

Not found: resource or refund policies do not exist

default

Error

get/activities/{activityUuid}/refund-policies
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/activities/{activityUuid}/refund-policies' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[
  • {
    }
]

Get Covid-19 information for activity

Returns an array of Covid-19 requirements. Only those with an is_active property value of true are in effect for the activity.

Informative descriptions for each item are not provided by this endpoint.

Request
path Parameters
activityUuid
required
string <uuid>

The UUID of the activity.

header Parameters
X-Musement-Application
string (Application value)

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

X-Musement-Version
string^[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
Responses
200

Covid-19 information for activity

403

Forbidden: activity is not accessible to partners

404

Not found: activity with UUID does not exist

default

Error

get/activities/{activityUuid}/safety-information
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/activities/{activityUuid}/safety-information' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[
  • {
    }
]

Get taxonomies for activity

Taxonomies provide information about the activity's highlights, inclusions and exclusions.

Request
path Parameters
activityUuid
required
string <uuid>

The UUID of the activity.

header Parameters
Accept-Language
string (Language code)
Default: en-US

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

X-Musement-Application
string (Application value)

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

X-Musement-Version
string^[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
Responses
200

Taxonomies for activity

403

Forbidden: activity is not accessible to partners

404

Not found: activity with UUID does not exist

default

Error

get/activities/{activityUuid}/taxonomies
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/activities/{activityUuid}/taxonomies' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[
  • {
    }
]