A collection of endpoints which can be used to search the catalog for relevant activities.
Musement API (3.5.0)
For merchant or affiliate partners wishing to use the Musement API.
See the Authentication section for details on how to authenticate with the API.
GET /activities/{activityUuid}/dates/{date}- Added
availability,max_buyandmin_buyproperties to timeslots. For more info, check out our guide
- Added
Download OpenAPI description
Overview
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
Query
Filter results to those which take place on or after the specified date.
When absent, today's date is used by default.
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.
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
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.
Headers
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
A partner's application value, used for analyzing API usage and to identify areas of improvement.
A valid currency code from the /currencies endpoint. Default value may vary depending on the X-Musement-Market header value.
Default USD
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
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
- Mock serverhttps://partner-api.musement.com/_mock/reference/openapi/activities/{activityUuid}/dates
- Sandbox serverhttps://sandbox.musement.com/api/v3/activities/{activityUuid}/dates
- Production serverhttps://api.musement.com/api/v3/activities/{activityUuid}/dates
- curl
- C#
- Node.js
curl -i -X GET \
'https://partner-api.musement.com/_mock/reference/openapi/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'Dates for activity
A discount to subtract from the the "base price" due to promotions or special events.
Example: {"currency":"USD","formatted_value":"$ 10.00","formatted_iso_value":"$10.00","value":10}
The price for partners based on commercial agreements. Appears for authenticated requests.
Example: {"currency":"USD","formatted_value":"$ 10.00","formatted_iso_value":"$10.00","value":10}
The base price with a service fee, but no discount.
Example: {"currency":"USD","formatted_value":"$ 10.00","formatted_iso_value":"$10.00","value":10}
The base price with a discount, but no service fee.
Example: {"currency":"USD","formatted_value":"$ 10.00","formatted_iso_value":"$10.00","value":10}
The final price for customers.
Example: {"currency":"USD","formatted_value":"$ 10.00","formatted_iso_value":"$10.00","value":10}
The base price with a discount, but no service fee.
Example: {"currency":"USD","formatted_value":"$ 10.00","formatted_iso_value":"$10.00","value":10}
A preview of the final price for customers when custom discounts are provided via the discounts[] query parameter.
Example: [{"currency":"USD","formatted_value":"$ 10.00","formatted_iso_value":"$10.00","value":10}]
An extra fee to add to the base price to cover additional costs for creating a reservation.
Example: {"currency":"USD","formatted_value":"$ 10.00","formatted_iso_value":"$10.00","value":10}
When true, the date is no longer available and should not be shown to customers.
Example: false
Response
application/json
[ { "day": "1985-11-05", "discount_amount": { … }, "merchant_price": { … }, "original_retail_price": { … }, "original_retail_price_without_service_fee": { … }, "retail_price": { … }, "retail_price_without_service_fee": { … }, "retail_prices_with_custom_discount": [ … ], "service_fee": { … }, "sold_out": false } ]
Request
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.
A 422 status code response means the requested date is not available, either temporarily or permanently. Customers are encouraged to try a different date.
Query
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
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.
Headers
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
A partner's application value, used for analyzing API usage and to identify areas of improvement.
A valid currency code from the /currencies endpoint. Default value may vary depending on the X-Musement-Market header value.
Default USD
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
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
- Mock serverhttps://partner-api.musement.com/_mock/reference/openapi/activities/{activityUuid}/dates/{date}
- Sandbox serverhttps://sandbox.musement.com/api/v3/activities/{activityUuid}/dates/{date}
- Production serverhttps://api.musement.com/api/v3/activities/{activityUuid}/dates/{date}
- curl
- C#
- Node.js
curl -i -X GET \
'https://partner-api.musement.com/_mock/reference/openapi/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
application/json
[ { "groups": [ … ] } ]