Make an Order Cancellation

For activities that allow the cancellation, you can perform a DELETE of an order item.

🚧

NOTE

You can't cancel an entire order, you have to cancel the order items in the order.
To cancel the entire order, you need to cancel all the order items in the order.

To proceed with the cancellation, you need to follow these steps:

  • Check the refund policies for the activity booked at order item level
curl -X GET \
  https://api.musement.com/api/v3/orders/{order_uuid}/items/{order-item_uuid}/refund-policies

If an activity has free cancellation, the response will be:

[
    {
        "uuid": "847b73ba-829d-49a7-bde5-31b7377b781d",
        "period": "P1D",
        "type": "PERCENTAGE",
        "value": 100
    }
]

That means that, if you cancel the order item 1 day before the booking date, you will be completely refunded.
You can have different cancellation policy depending on when you cancel the order item:

[
    {
        "uuid": "ba26a615-9520-4bea-a580-b0eaa2120a60",
        "period": "PT48H",
        "type": "PERCENTAGE",
        "value": 100
    },
    {
        "uuid": "246006c3-f676-4458-a99e-4e23a1ea0667",
        "period": "PT24H",
        "type": "PERCENTAGE",
        "value": 50
    }
]

That means that:
if you cancel the order item 48 hours before the booking date or before, you will receive all the money back
if you cancel the order item 24 hours before the booking date, you will receive half money back

  • Perform a DELETE of an order item
curl --request DELETE 
'api.musement.com/api/v3/orders/{orderUuid}/items/{orderItemUuid}' \
-H 'X-Musement-Version: 3.4.0' \
-H 'Authorization: Bearer ValidAccessToken' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
-d '{
  "cancellation_reason": "Valid Cancellation Reason",
  "cancellation_additional_info": "Additional info"
}'

You can find the valid cancellation reasons in the swagger.

To perform a cancellation, you need a special permission in your credentials, so please get in contact with your account manager.
Also you have to use the same credentials that create the order.
An example of response that you don't have the permission is:

{
    "code": "7101",
    "message": "You do not have the right permission to cancel this booking."
}

❗️

Important

Please, keep in mind that you can cancel an order item ONLY if there is a cancellation policy.
If you will cancel an order item outside of the cancellation policy, you will be charged for it even if the the API responded it's successfully cancelled.