Carts

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

Create cart

post/carts

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.

Carts without an order are automatically removed after three months.

For more info, check out our guide.
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.

For more info, check out our guide.
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.

For more info, check out our guide.
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
For more info, check out our guide.
Request Body schema: application/json
required

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

object
Responses
200

Cart

default

Error

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

get/carts/{cartUuid}

Returns a cart.

Carts without an order are automatically removed after three months.

Once the cart is connected to a closed order, the cart can only be viewed when the X-Musement-Currency header value matches the cart's original currency. Attempts to access the cart with different currencies will result in a 423 status code response.

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.

For more info, check out our guide.
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.

For more info, check out our guide.
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
For more info, check out our guide.
Responses
200

Cart

404

Resource not found

423

Locked: cart is connected to closed order and request currency does not match the cart currency

default

Error

Request samples 
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
post/carts/{cartUuid}/items
While this endpoint accepts multiple items, only the first item is returned. A cart can hold a maximum of 100 items. Carts are allowed to contain items from different activities.


For more info, check out our guide.
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.


 
For more info, check out our guide.
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.


 
For more info, check out our guide.
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
For more info, check out our guide.
Request Body schema: application/json
required
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.


 
For more info, check out our guide.
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: the item is no longer available


422
Unprocessable entity: the cart item limit has been reached


423
Locked: cart cannot be modified due to connected order status


default
Error


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