Orders

A collection of endpoints for managing orders as part of the booking flow.

Create order

When a customer cart is ready, it's time to create an order and proceed to payment.

Partners are able to include more details to help map the order to their own orders system.

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

The affiliate partner's alphanumeric ID.

affiliate_channel
string

A partner's channel ID for the order. Requires the affiliate property in the request body.

cart_id
integer
Deprecated

The cart's numeric ID. Please use the cart_uuid property instead.

cart_uuid
required
string <uuid>

The cart's UUID.

email_notification
string
Default: ALL

Specify which email notifications are sent:

  • ALL: all relevant notification emails
  • NONE: no emails are sent
  • TO-CUSTOMER: notification emails are sent to the customer only
Enum: ALL NONE TO-CUSTOMER
extra_data
string

Extra info about the order. The exact data and format are the partner's choice, but the value must be a string.

sms_notification_to
string

A phone number for SMS notifications related to the order. Values must follow the E.164 international standard.

source
string

The name of the application creating the order.

Responses
200

Order

default

Error

post/orders
Request samples
application/json
{
  • "cart_uuid": "ff111070-984a-4cff-87c7-2a32cd76de36",
  • "email_notification": "NONE"
}
Response samples
application/json
{
  • "customer": {
    },
  • "date": "2019-08-24T14:15:22Z",
  • "discount_amount": {
    },
  • "extra_data": "string",
  • "identifier": "string",
  • "items": [
    ],
  • "market": "string",
  • "status": "KO",
  • "total_price": {
    },
  • "trustpilot_url": "http://example.com",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "total_retail_price_in_order_currency": {
    },
  • "total_supplier_original_retail_price_in_supplier_currency": {
    },
  • "total_supplier_price_in_supplier_currency": {
    },
  • "affiliate": {
    },
  • "affiliate_channel": "string",
  • "promo_codes": [
    ],
  • "source": "string"
}

Get order

Request
path Parameters
orderUuid
required
string <uuid>

The order UUID.

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

Order

404

Resource not found

default

Error

get/orders/{orderUuid}
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/orders/{orderUuid}' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Currency: USD' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
{
  • "customer": {
    },
  • "date": "2019-08-24T14:15:22Z",
  • "discount_amount": {
    },
  • "extra_data": "string",
  • "identifier": "string",
  • "items": [
    ],
  • "market": "string",
  • "status": "KO",
  • "total_price": {
    },
  • "trustpilot_url": "http://example.com",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "total_retail_price_in_order_currency": {
    },
  • "total_supplier_original_retail_price_in_supplier_currency": {
    },
  • "total_supplier_price_in_supplier_currency": {
    },
  • "affiliate": {
    },
  • "affiliate_channel": "string",
  • "promo_codes": [
    ],
  • "source": "string"
}

Update order

Once payment has occurred, orders cannot be updated.

Request
path Parameters
orderUuid
required
string <uuid>

The order UUID.

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

Order information

extra_data
string

Extra info about the order that partners want to save. The exact data and format are the partner's choice, but the value must be a string.

Responses
200

Order

404

Resource not found

423

Locked: order cannot be modified due to status

default

Error

patch/orders/{orderUuid}
Request samples
application/json
{
  • "extra_data": "string"
}
Response samples
application/json
{
  • "customer": {
    },
  • "date": "2019-08-24T14:15:22Z",
  • "discount_amount": {
    },
  • "extra_data": "string",
  • "identifier": "string",
  • "items": [
    ],
  • "market": "string",
  • "status": "KO",
  • "total_price": {
    },
  • "trustpilot_url": "http://example.com",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "total_retail_price_in_order_currency": {
    },
  • "total_supplier_original_retail_price_in_supplier_currency": {
    },
  • "total_supplier_price_in_supplier_currency": {
    },
  • "affiliate": {
    },
  • "affiliate_channel": "string",
  • "promo_codes": [
    ],
  • "source": "string"
}

Update order item

Once payment has occurred, order items cannot be updated.

Request
path Parameters
orderUuid
required
string <uuid>

The order UUID.

orderItemUuid
required
string

Order item identifier

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

Order item

404

Resource not found

default

Error

patch/orders/{orderUuid}/items/{orderItemUuid}
Request samples
curl -i -X PATCH \
  'https://sandbox.musement.com/api/v3/orders/{orderUuid}/items/{orderItemUuid}' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
{
  • "uuid": "string",
  • "code": "string",
  • "transaction_code": "string",
  • "product": null,
  • "quantity": 0,
  • "retail_price_in_order_currency": {
    },
  • "total_retail_price_in_order_currency": {
    },
  • "original_retail_price_in_supplier_currency": {
    },
  • "total_original_retail_price_in_supplier_currency": {
    },
  • "b2b_price": {
    },
  • "status": "PENDING",
  • "vouchers": null,
  • "is_gift_redeem": true,
  • "extra_customer_data": [
    ],
  • "cancellation_reason": "API-ISSUE",
  • "cancellation_additional_info": "Client did not accept the suggested schedule change because of personal reasons",
  • "participants_info": [
    ],
  • "error_status": true
}

Request notification for order item

Trigger a webhook notification for an order item. This endpoint requires setting up a webhook URL with us ahead of time.

Notifications cannot be requested for gifted order items.

Request
path Parameters
orderUuid
required
string <uuid>

The order UUID.

orderItemUuid
required
string

Order item identifier

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
204

Request was successful

400

Bad request: notification is not possible

404

Not found: order or order item do not exist

default

Error

post/orders/{orderUuid}/items/{orderItemUuid}/notification
Request samples
curl -i -X POST \
  'https://sandbox.musement.com/api/v3/orders/{orderUuid}/items/{orderItemUuid}/notification' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
{
  • "code": "1000",
  • "message": "Notifications cannot be triggered for this order item."
}

Get refund policies for order item

Request
path Parameters
orderUuid
required
string <uuid>

The order UUID.

orderItemUuid
required
string

Order item identifier

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

Refund policies for order item

404

Not found: resource or refund policies do not exist

default

Error

get/orders/{orderUuid}/items/{orderItemUuid}/refund-policies
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/orders/{orderUuid}/items/{orderItemUuid}/refund-policies' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[
  • {
    }
]