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.

Update customer info for cart

Use this endpoint to provide information about the customer and extra customer data (if any).

The request body must match the schema returned by the GET /carts/{cartUuid}/customer/schema endpoint.

Request
path Parameters
cartUuid
required
string <uuid>

The UUID of the cart.

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
Request Body schema: application/json
object

The exact request body can vary, depending on the response of the GET /carts/{cartUuid}/customer/schema endpoint.

Responses
200

Customer

404

Resource not found

423

Locked: cart cannot be modified due to connected order status

default

Error

put/carts/{cartUuid}/customer
Request samples
application/json
{
  • "email": "api-distribution@tui.com",
  • "extra_customer_data": {
    },
  • "firstname": "John",
  • "lastname": "Smith"
}
Response samples
application/json
{
  • "email": "api-distribution@tui.com",
  • "events_related_newsletter": "NO",
  • "extra_customer_data": {
    },
  • "firstname": "John",
  • "lastname": "Smith",
  • "musement_newsletter": "NO",
  • "thirdparty_newsletter": "NO"
}

Get customer info schema for cart

Before creating an order, customer information must be added to cart. The exact information to provide can vary, depending on the selected activity products.

The response follows the JSON Schema Specification to provide a schema of questions and extra customer data (if any) for the customer to answer in order to complete a reservation.

Request
path Parameters
cartUuid
required
string <uuid>

The UUID of the cart.

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-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

Customer questions

404

Resource not found

default

Error

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

Get participant info for cart item

This endpoint returns participant info that has already been provided for a cart item.

Cart items which do not require participant info will return an empty array.

The exact properties for each participant info vary depending on the cart item requirements.

Request
path Parameters
cartUuid
required
string <uuid>

The UUID of the cart.

cartItemUuid
required
string <uuid>

The UUID of the cart item.

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

Participant info for cart item

404

Resource not found

default

Error

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

Update participant info for cart item

Use this endpoint to provide info for each participant in a cart item.

Cart items which do not require participant info will return a 404 status code.

The exact properties for each participant info vary depending on the cart item requirements.

Request
path Parameters
cartUuid
required
string <uuid>

The UUID of the cart.

cartItemUuid
required
string <uuid>

The UUID of the cart item.

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
Request Body schema: application/json

The exact properties for each participant info in the request vary depending on the cart item requirements.

Array
object
Responses
200

Participant info for cart item

404

Not found: a resource does not exist or the cart item does not require participant info

423

Locked: cart cannot be modified due to connected order status

default

Error

put/carts/{cartUuid}/items/{cartItemUuid}/participants
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
[
  • {
    }
]

Get participant info schema for cart item

Each item in a cart may require info for each participant in a reservation.

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

Request
path Parameters
cartUuid
required
string <uuid>

The UUID of the cart.

cartItemUuid
required
string <uuid>

The UUID of the cart item.

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

Participant info schema for cart item

404

Not found: a resource does not exist or the cart item does not require participant info

default

Error

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