Skip to content
API reference/
/
Get participant info sche...

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

Get languages for activity

Request

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

For more info, check out our guide.
Path
activityUuidstring(uuid)required

The UUID of the activity.

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/activities/{activityUuid}/metadata/languages' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'

Responses

Languages for activity

Bodyapplication/json
languagesArray of strings(Language code)unique

A list of languages that might be used during the reservation flow.

Example: ["us"]
Response
application/json
{
  "languages": [
    "us"
  ]
}

Get participant info schema for activity

Request

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.

For more info, check out our guide.
Path
activityUuidstring(uuid)required

The UUID of the activity.

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.
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-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/activities/{activityUuid}/participants-info/schema' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'

Responses

Participant info for activity

Bodyapplication/json
titlestringrequired

The type of item:

  • cart_customer_guest: Customer info for cart
  • cart_item_participants_info: Participant info for cart item
  • form: Extra customer data
  • participant: Participant info
Enum"cart_customer_guest""cart_item_participants_info""form""participant"
Example: "participant"
typestringrequired
Value"object"
Example: "object"
propertiesobjectrequired
Example: {"firstname":{"type":"string","title":"First name","propertyOrder":1},"lastname":{"type":"string","title":"Last name","propertyOrder":2}}
properties.​property name*objectadditional property

Each property varies depending on the activity configuration.

requiredArray of stringsrequired

A list of properties which require values in order to complete a reservation.

Example: ["firstname","lastname"]
Response
application/json
{
  "title": "participant",
  "type": "object",
  "properties": {
    "property1": { … },
    "property2": { … },
    "firstname": { … },
    "lastname": { … }
  },
  "required": [
    "firstname",
    "lastname"
  ]
}

Get refund policies for activity

Request

Returns an array of refund policies for the activity.

Activities without refund policies are non-refundable. Depending on the configuration, an activity without refund policies will return either an empty or array or a 404 status code response.

A 404 status code response could also mean the activity does not exist.

For more info, check out our guide.
Path
activityUuidstring(uuid)required

The UUID of the activity.

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/activities/{activityUuid}/refund-policies' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'

Responses

Refund policies for activity

Bodyapplication/jsonArray [
currency_codestring

A currency code from the /currencies endpoint. Present when type is ABSOLUTE.

periodstringrequired

The minimum amount of time, following ISO 8601, before a scheduled reservation can be cancelled and still obtain a refund.

Example: "P2D"
typestringrequired

The type of refund policy:

  • ABSOLUTE: A specific amount is refunded in the currency_code value.
  • PERCENTAGE: A percentage of the product price is refunded.
Enum"ABSOLUTE""PERCENTAGE"
Example: "PERCENTAGE"
uuidstring(uuid)required

The refund policy's UUID.

Example: "e9d85f7d-6e48-11e8-8a05-02bc4b6113e8"
valuenumber(float)required

The refund policy amount. Depending on the type property, this could be a percentage or a specific currency amount.

Example: 100
]
Response
application/json
[
  {
    "period": "P2D",
    "type": "PERCENTAGE",
    "uuid": "e9d85f7d-6e48-11e8-8a05-02bc4b6113e8",
    "value": 100
  }
]

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

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.