A collection of endpoints which can be used to search the catalog for relevant activities.
API reference//
- Remove ticket from cart
Update cart
Replace cart
Add tickets to cart
Remove ticket from cart
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
Headers
Bodyapplication/jsonThe 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/carts/{cartUuid}/tickets
- Sandbox serverhttps://sandbox.musement.com/api/v3/carts/{cartUuid}/tickets
- Production serverhttps://api.musement.com/api/v3/carts/{cartUuid}/tickets
- curl
- C#
- Node.js
curl -i -X POST \
'https://partner-api.musement.com/_mock/reference/openapi/carts/{cartUuid}/tickets' \
-H 'Accept-Language: en-US' \
-H 'Content-Type: application/json' \
-H 'X-Musement-Application: string' \
-H 'X-Musement-Currency: USD' \
-H 'X-Musement-Market: us' \
-H 'X-Musement-Version: 3.4.0' \
-d '{
"tickets": [
{
"product": {
"type": "musement",
"id": "4445092627"
},
"quantity": 2
}
]
}'Cart
The cart's customer info.
Example: {"email":"api-distribution@tui.com","events_related_newsletter":"NO","extra_customer_data":{"1223356a-69a0-4c45-bf51-bd903820d210":{"phone_number":1234567890}},"firstname":"John","lastname":"Smith","musement_newsletter":"NO","thirdparty_newsletter":"NO"}
Discount info for the cart if a promo code has been applied.
Example: {"currency":"USD","formatted_value":"$ 10.00","formatted_iso_value":"$10.00","value":10}
The sum of every product's original_retail_price property value multiplied by the corresponding cart item's quantity.
Example: {"currency":"USD","formatted_value":"$ 10.00","formatted_iso_value":"$10.00","value":10}
The sum of every product's original_retail_price_without_service_fee property value multiplied by the corresponding cart item's quantity.
Example: {"currency":"USD","formatted_value":"$ 10.00","formatted_iso_value":"$10.00","value":10}
This property defines which payment gateway should be used for partners following the split payment flow.
Enum"ADYEN""STRIPE"
This property is the final price for customers. It is the sum of every cart item's total_price property value minus the cart's discount value.
Example: {"currency":"USD","formatted_value":"$ 10.00","formatted_iso_value":"$10.00","value":10}
The sum of every cart item's total_price_without_service_fee property value minus the cart's discount value.
Example: {"currency":"USD","formatted_value":"$ 10.00","formatted_iso_value":"$10.00","value":10}
The sum of every product's service_fee property value.
Example: {"currency":"USD","formatted_value":"$ 10.00","formatted_iso_value":"$10.00","value":10}
The sum of:
- The cart's
discountproperty - Every product's
discount_amountproperty value multiplied by the corresponding cart item'squantity.
Example: {"currency":"USD","formatted_value":"$ 10.00","formatted_iso_value":"$10.00","value":10}
Response
application/json
{ "customer": { "email": "api-distribution@tui.com", "events_related_newsletter": "NO", "extra_customer_data": { … }, "firstname": "John", "lastname": "Smith", "musement_newsletter": "NO", "thirdparty_newsletter": "NO" }, "discount": { "currency": "USD", "formatted_value": "$ 10.00", "formatted_iso_value": "$10.00", "value": 10 }, "full_price": { "currency": "USD", "formatted_value": "$ 10.00", "formatted_iso_value": "$10.00", "value": 10 }, "full_price_without_service_fee": { "currency": "USD", "formatted_value": "$ 10.00", "formatted_iso_value": "$10.00", "value": 10 }, "items": [ { … } ], "preferred_payment_gateway": "ADYEN", "promo_code": { "code": "string" }, "retail_price": { "currency": "USD", "formatted_value": "$ 10.00", "formatted_iso_value": "$10.00", "value": 10 }, "retail_price_without_service_fee": { "currency": "USD", "formatted_value": "$ 10.00", "formatted_iso_value": "$10.00", "value": 10 }, "service_fee": { "currency": "USD", "formatted_value": "$ 10.00", "formatted_iso_value": "$10.00", "value": 10 }, "total_discount": { "currency": "USD", "formatted_value": "$ 10.00", "formatted_iso_value": "$10.00", "value": 10 }, "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f" }
Headers
A partner's application value, used for analyzing API usage and to identify areas of improvement.
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/carts/{cartUuid}/tickets/{ticketUuid}
- Sandbox serverhttps://sandbox.musement.com/api/v3/carts/{cartUuid}/tickets/{ticketUuid}
- Production serverhttps://api.musement.com/api/v3/carts/{cartUuid}/tickets/{ticketUuid}
- curl
- C#
- Node.js
curl -i -X DELETE \
'https://partner-api.musement.com/_mock/reference/openapi/carts/{cartUuid}/tickets/{ticketUuid}' \
-H 'X-Musement-Application: string' \
-H 'X-Musement-Version: 3.4.0'