Order cancellation/annulment¶

General terms¶

Endpoint: /api/Order/Cancel

To cancel a specific hotel booking within an existing order, the Mixvel_OrderCancelRQ method is used. This method is common for various MixVel products, including hotel bookings.

Each booking (Item/voucher) is located within the order (Order). Cancellation is performed using Mixvel_OrderCancelRQ and is only possible for bookings in the Confirmed status. The order (Order) itself cannot be canceled, as it is a technical entity. The method Mixvel_OrderCancelRQ is used to cancel bookings (Item/voucher).

If there is only one booking in the order, it is sufficient to specify the OrderID. If there are multiple bookings, it is necessary to provide the OrderItemID of the specific booking. At the moment, only one booking can be canceled per request, but future support for multiple cancellations will be available.

Important when canceling hotel bookings:

Information about cancellation penalties is returned via Mixvel_OrderRetrieveRQ.
Refunds within Mixvel_OrderCancelRQ/RS are not provided. The agent independently refunds the client and the provider in accordance with the contract.

Request structure¶

The request input data must satisfy the scheme Mixvel_OrderCancelRQ.xsd and contain the following basic data (complete parameters can be found in the xsd scheme or in the xml examples of a specific message):

Parameter XPath	Filling example	Description
Mixvel_OrderCancelRQ/Request/MixOrder/MixOrderID	82477-250921-MEY3505	Unique ID of the shopping cart
Mixvel_OrderCancelRQ/Request/MixOrder/Order/OrderID	82477-250921-OEY3506	Unique ID of the order
Mixvel_OrderCancelRQ/Request/MixOrder/Order/OrderItemID	cc7ce875-66fd-4e8f-91d4-36b29134aa62	Unique ID of the booking

Example of the Mixvel_OrderCancelRQ requests:

Show request example

<?xml version="1.0" encoding="UTF-8"?>
<MixEnv:Envelope xmlns:MixEnv="https://www.mixvel.com/API/XSD/mixvel_envelope/1_06">
  <Header/>
  <Body id="ID1">
    <MessageInfo MessageId="703423d1-595c-49f5-98c2-5dcabe950276" TimeSent="2025-09-18T03:04:38.6129323Z"/>
    <AppData>
      <m:Mixvel_OrderCancelRQ xmlns:m="https://www.mixvel.com/API/XSD/Mixvel_OrderCancelRQ/1_01">
        <Request>
          <MixOrder>
            <MixOrderID>82477-250616-MEE8921</MixOrderID>
            <Order>
              <OrderID>82477-250616-OEE8922</OrderID>
            </Order>
          </MixOrder>
        </Request>
      </m:Mixvel_OrderCancelRQ>
    </AppData>
  </Body>
</MixEnv:Envelope>

Response structure¶

As a result of the cancellation request, the agent receives the identifier of the canceled order or an error message if the cancellation operation was not performed automatically.

After receiving the response Mixvel_OrderCancelRS (both for Success and Failure), it is recommended to perform the Mixvel_OrderRetrieveRQ request to ensure that the status of the selected OrderItem has changed to Canceled.

The system response to the cancellation request corresponds to the Mixvel_OrderCancelRS.xsd schema and contains the following main data (complete parameters can be found in the xsd scheme or in the xml examples of a specific message):

Parameter XPath	Filling example	Description
Mixvel_OrderCancelRS/Response/MixOrderRef/MixOrderId	82477-250616-MEE8921	Unique identifier for the cancelled Orders cart
Mixvel_OrderCancelRS/Response/MixOrderRef/MixOrderId/Order/OrderId	82477-250616-OEE8922	Unique identifier of the cancelled Order
Mixvel_OrderCancelRS/Response/MixOrderRef/MixOrderId/Order/OperationStatus	Success	Operation status. Takes values "Success"/"Failure".

Example of the Mixvel_OrderCancelRS response:

Show response example

<MixEnv:Envelope xmlns:MixEnv="https://www.mixvel.com/API/XSD/mixvel_envelope/1_06">
  <Header/>
  <Body>
    <MessageInfo MessageId="a4ea7885-063f-4371-8d3e-c5221882d156" ReplyTo="703423d1-595c-49f5-98c2-5dcabe950276" TimeSent="2025-06-16T16:15:37.4629607Z"/>
    <AppData>
      <Cancel:Mixvel_OrderCancelRS xmlns:Cancel="https://www.mixvel.com/API/XSD/Mixvel_OrderCancelRS/1_00">
        <Response>
          <MixOrderRef>
            <MixOrderID>82477-250616-MEE8921</MixOrderID>
            <Order>
              <OrderID>82477-250616-OEE8922</OrderID>
              <OperationStatus>Success</OperationStatus>
            </Order>
          </MixOrderRef>
        </Response>
      </Cancel:Mixvel_OrderCancelRS>
    </AppData>
  </Body>
</MixEnv:Envelope>