Cancellations

It is possible to cancel reservations, provided that the activity in question is refundable.

Cancel reservation for order item

Cancelling reservations requires extra permissions which are not enabled by default.

Cancellations are possible for activities with one or more refund policies, provided the cancellation takes place before the refund cutoff date.

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

Details about the cancellation

cancellation_additional_info
string <= 255 characters

Additional information about the cancellation which partners which to communicate to Musement Customer Care.

cancellation_integration_data
object

Additional information about the cancellation which partners would like to save for their integration.

cancellation_reason
string

The reason for the cancellation, from the following options:

  • API-ISSUE: Technical issue with API.
  • CANCELLED-BY-CUSTOMER: Cancellation requested by customer.
  • GRACE-PERIOD: An agreed upon time between paying for an order and cancelling without repercussions.
  • MISSING-MEETING-POINT-DETAILS: Activity meeting point was incorrect or changed without contact from activity provider or Musement Customer Care.
  • MISSING-PASSENGER-INFO: Provider cannot accept the reservation due to missing information such as date of birth or pickup location.
  • REJECTED-ORDER: Provider cannot accept the reservation due to overbooking or because the requested date/time is no longer available.
  • REJECTED-SCHEDULE-CHANGE: Cancellation because proposed change to reservation date/time was rejected by the customer.
  • TECHNICAL-ISSUE: Technical issue not covered by any of the other reasons.
  • VENUE-CLOSED: Reservation was not honored due to weather, maintenance, strikes, closed venue or other reason.
Enum: API-ISSUE CANCELLED-BY-CUSTOMER GRACE-PERIOD MISSING-MEETING-POINT-DETAILS MISSING-PASSENGER-INFO REJECTED-ORDER REJECTED-SCHEDULE-CHANGE TECHNICAL-ISSUE VENUE-CLOSED
Responses
204

Order item successfully cancelled

404

Resource not found

default

Error

delete/orders/{orderUuid}/items/{orderItemUuid}
Request samples
application/json
{
  • "cancellation_additional_info": "Customer rejected suggested change to reservation date.",
  • "cancellation_reason": "REJECTED-SCHEDULE-CHANGE"
}
Response samples
application/json
{
  • "code": "1400",
  • "message": "Resource does not exist"
}