Orders

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

Create order

post/orders

When a customer cart is ready, it's time to create an order and proceed to payment. We strongly recommend creating orders only when payment is guaranteed in order to reduce unnecessary API calls and avoid misleading results in sales reports.

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

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

Additional info about the order that partners may want to save. This value only accepts a serialized JSON object of key-value pairs.

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

Request samples
application/json
{
  • "cart_uuid": "ff111070-984a-4cff-87c7-2a32cd76de36",
  • "email_notification": "NONE",
  • "extra_data": "{\"clientReferenceId\":\"12345678\",\"firstName\":\"John\",\"lastName\":\"Smith\",\"reservationId\":\"3E5B7445-00E6-4ED6-9321-19E30D73A128\",\"utm_campaign\":\"example-it\",\"utm_content\":\"it-native\",\"utm_medium\":\"example-App it\",\"utm_source\":\"channel-abc\"}"
}
Response samples
application/json
{
  • "customer": {
    },
  • "date": "2019-08-24T14:15:22Z",
  • "discount_amount": {
    },
  • "extra_data": "{\"clientReferenceId\":\"12345678\",\"firstName\":\"John\",\"lastName\":\"Smith\",\"reservationId\":\"3E5B7445-00E6-4ED6-9321-19E30D73A128\",\"utm_campaign\":\"example-it\",\"utm_content\":\"it-native\",\"utm_medium\":\"example-App it\",\"utm_source\":\"channel-abc\"}",
  • "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

get/orders/{orderUuid}

Returns an 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.

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

Order

404

Resource not found

default

Error

Request samples 
Response samples 
application/json
{
  • "customer": {
    },
  • "date": "2019-08-24T14:15:22Z",
  • "discount_amount": {
    },
  • "extra_data": "{\"clientReferenceId\":\"12345678\",\"firstName\":\"John\",\"lastName\":\"Smith\",\"reservationId\":\"3E5B7445-00E6-4ED6-9321-19E30D73A128\",\"utm_campaign\":\"example-it\",\"utm_content\":\"it-native\",\"utm_medium\":\"example-App it\",\"utm_source\":\"channel-abc\"}",
  • "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
patch/orders/{orderUuid}
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.


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


extra_data
string
Additional info about the order that partners may want to save. This value only accepts a serialized JSON object of key-value pairs.


 
Responses 
200
Order


404
Resource not found


423
Locked: order cannot be modified due to status


default
Error


Request samples 
application/json
{
  • "extra_data": "{\"clientReferenceId\":\"12345678\",\"firstName\":\"John\",\"lastName\":\"Smith\",\"reservationId\":\"3E5B7445-00E6-4ED6-9321-19E30D73A128\",\"utm_campaign\":\"example-it\",\"utm_content\":\"it-native\",\"utm_medium\":\"example-App it\",\"utm_source\":\"channel-abc\"}"
}
Response samples 
application/json
{
  • "customer": {
    },
  • "date": "2019-08-24T14:15:22Z",
  • "discount_amount": {
    },
  • "extra_data": "{\"clientReferenceId\":\"12345678\",\"firstName\":\"John\",\"lastName\":\"Smith\",\"reservationId\":\"3E5B7445-00E6-4ED6-9321-19E30D73A128\",\"utm_campaign\":\"example-it\",\"utm_content\":\"it-native\",\"utm_medium\":\"example-App it\",\"utm_source\":\"channel-abc\"}",
  • "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"
}
Request notification for order item
post/orders/{orderUuid}/items/{orderItemUuid}/notifications
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.


For more info, check out our guide.
Request 
path Parameters
orderItemUuid
required
string
Order item identifier


 
orderUuid
required
string <uuid> 
The order UUID.


 
header Parameters
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-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 
204
Request was successful


400
Bad request: notification is not possible


404
Not found: order or order item do not exist


default
Error


Request samples 
Response samples 
application/json
{
  • "code": "1000",
  • "message": "Notifications cannot be triggered for this order item."
}
Get refund policies for order item
get/orders/{orderUuid}/items/{orderItemUuid}/refund-policies
Returns an array of refund policies for an order item.


Request 
path Parameters
orderItemUuid
required
string
Order item identifier


 
orderUuid
required
string <uuid> 
The order UUID.


 
header Parameters
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-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
Refund policies for order item


404
Not found: resource or refund policies do not exist


default
Error


Request samples 
Response samples 
application/json
[
  • {
    }
]
Get refunds for order
get/orders/{orderUuid}/refunds
Returns an array of paid refunds for an order.


Request 
path Parameters
orderUuid
required
string <uuid> 
The order UUID.


 
header Parameters
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-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
Refunds for order


404
Resource not found


default
Error


Request samples 
Response samples 
application/json
[
  • {
    }
]