Dates

A collection of endpoints for selecting available dates and products.

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
[
  • {
    }
]