Carts

A collection of endpoints for managing a customer's cart during the booking flow.

Create cart

Creating a cart is a key step in the reservation flow.

It's not necessary to provide customer info at this stage. Customer info can be supplied later using the PUT /carts/{cartUuid}/customer endpoint.

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

If customer info is not available at this stage, the request can be an empty object: {}

object
Responses
200

Cart

503

Error

post/carts
Request samples
application/json
{ }
Response samples
application/json
{
  • "customer": {
    },
  • "discount": {
    },
  • "full_price": {
    },
  • "full_price_without_service_fee": {
    },
  • "items": [
    ],
  • "preferred_payment_gateway": "ADYEN",
  • "promo_code": {
    },
  • "retail_price": {
    },
  • "retail_price_without_service_fee": {
    },
  • "service_fee": {
    },
  • "total_discount": {
    },
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Get cart

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

Cart

404

Resource not found

default

Error

get/carts/{cartUuid}
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/carts/{cartUuid}' \
  -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
{
  • "customer": {
    },
  • "discount": {
    },
  • "full_price": {
    },
  • "full_price_without_service_fee": {
    },
  • "items": [
    ],
  • "preferred_payment_gateway": "ADYEN",
  • "promo_code": {
    },
  • "retail_price": {
    },
  • "retail_price_without_service_fee": {
    },
  • "service_fee": {
    },
  • "total_discount": {
    },
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Add items to cart

While this endpoint accepts multiple items, only the first item is returned.

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

An array of items to add to cart.

Array
language
string (Language code) [a-z]{2}

The selected language (if any).

pickup
string <uuid> (Pickup UUID)

The selected pickup.

This property is required for activities with pickups.

product_identifier
required
string

The product identifier. Depending on the activity configuration, this could be a numeric value or a complex string.

quantity
required
integer >= 1

The number of products to add to cart.

type
required
string

The type of product.

Enum: musement musement-realtime
Responses
200

Cart item

404

Resource not found

410

Gone: something went wrong while adding item to cart

423

Locked: cart cannot be modified due to connected order status

default

Error

post/carts/{cartUuid}/items
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "product": {},
  • "quantity": 1,
  • "status": "PREBOOK_OK",
  • "total_price": {
    },
  • "total_price_without_service_fee": {
    },
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}