Order cancellation¶

Endpoint: /api/Order/Cancel

Unpaid order cancellation¶

General terms¶

Endpoint: /api/Order/Cancel

To cancel an unpaid order/reservation, use the request Mixvel_OrderCancelRQ. As a result of successful completion of the order, all services included in the order are canceled. To cancel part of an order after split, the OrderID of the canceled order should be passed into the request.

As a result of executing an order, the agent receives a canceled order ID or an error message if the cancellation operation could not be completed automatically.

Request structure¶

The request input data must satisfy the scheme Mixvel_OrderCancelRQ.xsd and contain the following basic data (the table shows the main parameters of the message, 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	06031-250101-MAA0031	Unique ID of the shopping cart
.../MixOrder/Order/OrderID	06031-250101-OAA0032	Unique ID of the order (optional)

Response structure¶

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

Parameter XPath	Filling example	Description
Mixvel_OrderCancelRS/Response/MixOrderRef/MixOderId	00001-250117-MA1234	Unique identifier of the canceled order cart
For each canceled Order:
Mixvel_OrderCancelRS/Response/MixOrderRef/MixOderId/Order/OrderId	00001-250117-OA1235	Unique ID of a canceled order
Mixvel_OrderCancelRS/Response/MixOrderRef/MixOderId/Order/ OperationStatus	Success	Operation status. Accepts the values "Success" /"Failure"

Usage scenario and message examples¶

Example of an unpaid order cancellation¶

The order cancellation request will look like this.

Show request example

<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-01-24T18:30:11Z"/>
        <AppData>
            <m:Mixvel_OrderCancelRQ xmlns:m="https://www.mixvel.com/API/XSD/Mixvel_OrderCancelRQ/1_01">
                <Request>
                    <MixOrder>
                        <MixOrderID>96829-250124-MEO3193</MixOrderID>
                        <Order>
                            <OrderID>96829-250124-OEO3194</OrderID> <!--ID of an Order (optional)-->
                        </Order>
                    </MixOrder>
                </Request>
            </m:Mixvel_OrderCancelRQ>
        </AppData>
    </Body>
</MixEnv:Envelope>

If the order is successfully cancelled, the agent receives the following message.

Show response example

<?xml version="1.0" encoding="utf-8"?>
<MixEnv:Envelope xmlns:MixEnv="https://www.mixvel.com/API/XSD/mixvel_envelope/1_06">
    <Header />
    <Body>
        <MessageInfo MessageId="c8a1b5a6-930b-49a7-833f-f91e707e47f5" ReplyTo="703423d1-595c-49f5-98c2-5dcabe950276" TimeSent="2025-01-24T18:30:11.133246Z" />
        <AppData>
            <Cancel:Mixvel_OrderCancelRS xmlns:Cancel="https://www.mixvel.com/API/XSD/Mixvel_OrderCancelRS/1_00">
                <Response>
                    <MixOrderRef>
                        <MixOrderID>96829-250124-MEO3193</MixOrderID>
                        <Order>
                            <OrderID>96829-250124-OEO3194</OrderID>
                            <OperationStatus>Success</OperationStatus>
                        </Order>
                    </MixOrderRef>
                    <Warning>
                        <Code>MIX-103026</Code>
                        <DescText>Заказ аннулирован. Для восстановления заказа воспользуйтесь методом OrderChangeRQ</DescText> 
                        <!--The order has been cancelled. To restore an order, use the OrderChangeRQ method-->
                        <LangCode>Ru</LangCode>
                    </Warning>
                </Response>
            </Cancel:Mixvel_OrderCancelRS>
        </AppData>
    </Body>
</MixEnv:Envelope>

Paid order cancellation¶

General terms¶

Void is full cancellation of the document without financial concequences for the end customer. Void is equal to cancellation without penalties. The Mixvel_OrderCancelRQ request is used to cancel a paid Order. Due to successful execution of the request, all services included in the Order are cancelled, as well as all issued tickets. An Order cancellation is performed completely, for partial cancellation of services it is necessary to use the Mixvel_OrderChangeRQ. It is allowed to cancel partial orders included in the order cart (MixOrder).

The cancellation of a paid order is possible within a limited time after payment. The cancellation time is specified in VoidTimelimitUtc — the time limit for voiding the order after ticket issuance.

Due to Order execution, the agent receives the ID of the cancelled Order or an error message if the cancellation could not be performed automatically.

When a request for cancellation is performed, the carriage and additional services are cancelled, the places are returned to the carrier.

Request structure¶

The input data of the request must satisfy the Mixvel_OrderCancelRQ.xsd scheme and contain the following basic (main) data (the table shows the main parameters of the message, full 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	06031-200201-MAA003	Unique Orders cart identifier

Response structure¶

The system response to the paid Order cancellation request corresponds to the Mixvel_OrderCancelRS.xsd scheme and contains the following main data (the table displays the main parameters of the message, full 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/MixOderId	00001-210317-MA1234	Unique identifier for the cancelled Orders cart.
For each cancelled Order:
Mixvel_OrderCancelRS/Response/MixOrderRef/MixOderId/Order/OrderId	06031-200201-OAA003	Unique identifier of the cancelled Order.
Mixvel_OrderCancelRS/Response/MixOrderRef/MixOderId/Order/ OperationStatus	Success	Operation status. Takes values "Success"/"Failure".

Usage scenario and message examples¶

Example of a paid order cancellation¶

An Order cancellation request will look as follows:

Show request example

<Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.mixvel.com/API/XSD/mixvel_envelope/1_06">
    <Header xmlns=""/>
    <Body xmlns="" id="ID1">
        <MessageInfo MessageId="c46dcf8f-4df3-4cc1-a721-b984dccb8902" TimeSent="2022-07-20T08:45:22.6260801Z"/>
        <AppData>
            <Mixvel_OrderCancelRQ xmlns="https://www.mixvel.com/API/XSD/Mixvel_OrderCancelRQ/1_01">
                <Request xmlns="">
                    <MixOrder>
                        <MixOrderID>96829-250111-MEY1044</MixOrderID>
                    </MixOrder>
                </Request>
            </Mixvel_OrderCancelRQ>
        </AppData>
    </Body>
</Envelope>

In case of successful Order cancellation, the agent receives the following xml message:

Show response example

<?xml version="1.0" encoding="utf-8"?>
<MixEnv:Envelope xmlns:MixEnv="https://www.mixvel.com/API/XSD/mixvel_envelope/1_06">
    <Header />
    <Body>
        <MessageInfo MessageId="82fb34a6-014f-4743-a0dc-dc1b945e1f86" ReplyTo="c46dcf8f-4df3-4cc1-a721-b984dccb8902" TimeSent="2025-01-11T09:20:03.3430133Z" />
        <AppData>
            <Cancel:Mixvel_OrderCancelRS xmlns:Cancel="https://www.mixvel.com/API/XSD/Mixvel_OrderCancelRS/1_00">
                <Response>
                    <MixOrderRef>
                        <MixOrderID>96829-250111-MEY1044</MixOrderID>
                        <Order>
                            <OrderID>96829-250111-OEY1045</OrderID>
                            <OperationStatus>Success</OperationStatus>
                        </Order>
                    </MixOrderRef>
                </Response>
            </Cancel:Mixvel_OrderCancelRS>
        </AppData>
    </Body>
</MixEnv:Envelope>

Cancellation without releasing the seats¶

The Agent has access to the process of cancellation of carriage and additional services without cancellation of seats. To do this, you must specify the attribute of the need to hand over the seats Mixvel_OrderCanselRQ/Request/MixOrder/Order/ReturnSeat:

true - seats are cancelled;
false - seats are not cancelled.

By default, seats are cancelled (true value).

A request to cancel an order without releasing the seats will look as follows:

Show request example

<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-01-15T00:00:00Z"/>
    <AppData>
      <m:Mixvel_OrderCancelRQ xmlns:m="https://www.mixvel.com/API/XSD/Mixvel_OrderCancelRQ/1_01">
        <Request>
          <MixOrder>
            <MixOrderID>08258-250115-MEE1069</MixOrderID>
            <Order>
              <OrderID>08258-250115-OEE1070</OrderID>
              <ReturnSeat>false</ReturnSeat>
            </Order>
          </MixOrder>
        </Request>
      </m:Mixvel_OrderCancelRQ>
    </AppData>
  </Body>
</MixEnv:Envelope>

In case of successful Order cancellation, the agent receives the following xml message:

Show response example

<?xml version="1.0" encoding="utf-8"?>
<MixEnv:Envelope xmlns:MixEnv="https://www.mixvel.com/API/XSD/mixvel_envelope/1_06">
    <Header />
    <Body>
        <MessageInfo MessageId="cbad6480-6e9e-4791-96a8-2749f0f8c596" ReplyTo="703423d1-595c-49f5-98c2-5dcabe950276" TimeSent="2025-01-15T07:37:55.327306Z" />
        <AppData>
            <Cancel:Mixvel_OrderCancelRS xmlns:Cancel="https://www.mixvel.com/API/XSD/Mixvel_OrderCancelRS/1_00">
                <Response>
                    <MixOrderRef>
                        <MixOrderID>08258-250115-MEE1069</MixOrderID>
                        <Order>
                            <OrderID>08258-250115-OEE1070</OrderID>
                            <OperationStatus>Success</OperationStatus>
                        </Order>
                    </MixOrderRef>
                </Response>
            </Cancel:Mixvel_OrderCancelRS>
        </AppData>
    </Body>
</MixEnv:Envelope>

Cancellation of an extra service (EMD Void)¶

When being voided, all the services of the EMD coupons should not be provided. The method Mixvel_OrderCancelRQ is used for void of extra services; in this method an element OrderItemID (optional field) was added in commontype OrderIDReturnSeatsRefType.

OrderItemID will be used in the schema to void OrderItem, connected with extra services in a paid order.

Mixvel_OrderCancelRQ/Request/MixOrder/Order/OrderItems/OrderItemID

Example of Mixvel_OrderCancelRQ:

Show request example

<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-10-31T19:37:48Z"/>
        <AppData>
            <m:Mixvel_OrderCancelRQ xmlns:m="https://www.mixvel.com/API/XSD/Mixvel_OrderCancelRQ/1_01">
                <Request>
                    <MixOrder>
                        <MixOrderID>62960-251211-MEB0997</MixOrderID>
                        <Order>
                            <OrderID>62960-251211-OEB0998</OrderID>
                            <OrderItem>
                                <OrderItemID>4bf5b960-46d9-45ad-b58b-72eb2421be38</OrderItemID>
                            </OrderItem>
                        </Order>
                    </MixOrder>
                </Request>
            </m:Mixvel_OrderCancelRQ>
        </AppData>
    </Body>
</MixEnv:Envelope>

In the response Mixvel_OrderCancelRS, OrderItemID is presented in the schema (in commontype OrderIDRefExtendedType):

Mixvel_OrderCancelRS/Response/MixOrderRef/Order/OrderItemID

Example of Mixvel_OrderCancelRS:

Show response example

<?xml version="1.0" encoding="utf-8"?>
<MixEnv:Envelope xmlns:MixEnv="https://www.mixvel.com/API/XSD/mixvel_envelope/1_06">
    <Header />
    <Body>
        <MessageInfo MessageId="019b0b3e-8fa8-7226-b3d5-5672c9dfed8a" ReplyTo="703423d1-595c-49f5-98c2-5dcabe950276" TimeSent="2025-12-11T02:30:13.6395504Z" />
        <AppData>
            <Cancel:Mixvel_OrderCancelRS xmlns:Cancel="https://www.mixvel.com/API/XSD/Mixvel_OrderCancelRS/1_00">
                <Response>
                    <MixOrderRef>
                        <MixOrderID>62960-251211-MEB0997</MixOrderID>
                        <Order>
                            <OrderID>62960-251211-OEB0998</OrderID>
                            <OrderItemID>4bf5b960-46d9-45ad-b58b-72eb2421be38</OrderItemID>
                            <OperationStatus>Success</OperationStatus>
                        </Order>
                    </MixOrderRef>
                </Response>
            </Cancel:Mixvel_OrderCancelRS>
        </AppData>
    </Body>
</MixEnv:Envelope>

If related services are combined into one OrderItem, to cancel part of such services, it is necessary to pass the OrderItemID and ServiceID parameters of the service being deleted. Partial void of services to be issued on one EMD is available only before they are paid for.

Example of Mixvel_OrderCancelRQ:

Show request example

<Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.mixvel.com/API/XSD/mixvel_envelope/1_06">
    <Header xmlns=""/>
    <Body xmlns="" id="ID1">
        <MessageInfo MessageId="c46dcf8f-4df3-4cc1-a721-b984dccb8902" TimeSent="2022-07-20T08:45:22.6260801Z"/>
        <AppData>
            <Mixvel_OrderCancelRQ xmlns="https://www.mixvel.com/API/XSD/Mixvel_OrderCancelRQ/1_01">
                <Request xmlns="">
                    <MixOrder>
                        <MixOrderID>96829-250416-MEK9946</MixOrderID>
                        <Order>
                            <OrderID>96829-250416-OEK9947</OrderID>
                            <OrderItem>
                                <OrderItemID>ba7e698b-5ef8-48b0-ba36-83e70124be70</OrderItemID>
                                <ServiceID>f5cdb425-d722-4885-b417-37150c5e97bd</ServiceID>
                            </OrderItem>
                        </Order>
                    </MixOrder>
                </Request>
            </Mixvel_OrderCancelRQ>
        </AppData>
    </Body>
</Envelope>

If the service is successfully voided, the OrderItemID and ServiceID of the deleted service will be passed to Mixvel_OrderCancelRS.

Example of Mixvel_OrderCancelRS:

Show response example

<MixEnv:Envelope xmlns:MixEnv="https://www.mixvel.com/API/XSD/mixvel_envelope/1_06">
    <Header/>
    <Body>
        <MessageInfo MessageId="7c8a6354-d359-433f-8ddd-38b7da98e455" ReplyTo="c46dcf8f-4df3-4cc1-a721-b984dccb8902" TimeSent="2025-04-16T09:09:31.8684583Z"/>
        <AppData>
            <Cancel:Mixvel_OrderCancelRS xmlns:Cancel="https://www.mixvel.com/API/XSD/Mixvel_OrderCancelRS/1_00">
                <Response>
                    <MixOrderRef>
                        <MixOrderID>96829-250416-MEK9946</MixOrderID>
                        <Order>
                            <OrderID>96829-250416-OEK9947</OrderID>
                            <OrderItem>
                                <OrderItemID>ba7e698b-5ef8-48b0-ba36-83e70124be70</OrderItemID>
                                <ServiceID>f5cdb425-d722-4885-b417-37150c5e97bd</ServiceID>
                            </OrderItem>
                            <OperationStatus>Success</OperationStatus>
                        </Order>
                    </MixOrderRef>
                </Response>
            </Cancel:Mixvel_OrderCancelRS>
        </AppData>
    </Body>
</MixEnv:Envelope>

Deleting segments with the status «XX»¶

The segments which are left after the booking was cancelled / voided have the status "XX".

The Mixvel_OrderCancelRQ request scheme uses the RemoveCancelledPaxSegment element (true/false values), which is used to indicate the need to remove segments with the status "XX" from the Order during the cancellation process.

Mixvel_OrderCancelRQ/Request/MixOrder/Order/RemoveCancelledPaxSegment

By default, the value of the element RemoveCancelledPaxSegment is false. In case the agent needs to delete the segments in the status "XX", then RemoveCancelledPaxSegment should have true value.

The algorithm of deleting the segments in the status "XX" (by indicating RemoveCancelledPaxSegment=true) is the following:

the function applies to all the segments;
all the segments obtain the status "XX";
at simultaneous indication of ReturnSeat=true and RemoveCancelledPaxSegment=true all the segments are deleted.

The element RemoveCancelledPaxSegment is directly connected with the element ReturnSeat (which is also Boolean true/false values):

1) if ReturnSeat=true and RemoveCancelledPaxSegment=true, then the segments in the status "XX" are deleted;

2) if ReturnSeat=true and RemoveCancelledPaxSegment=false, then the segments in the status "XX" are not deleted;

3) if ReturnSeat=false and RemoveCancelledPaxSegment=true, then the segments in the status "XX" are not deleted.

It is important to point out that this function can only be applied to all the coupons. Accordingly, ALL the segments will be deleted/cancelled. The deleted segments of the Order will not be returned.

In case there are both segments in the status "XX" and segments in the status "HK" in a Not-paid Order, and it is necessary to remove only the particular "XX" segments, it is possible to apply the function of Removing Segments within a Not-paid Order. In this case the method Mixvel_OrderChangeRQ with the element DeletePaxSegment (OrderRefID, PaxSegmentRefID) is applied. It is necessary to point out the particular segments which will deleted within the Order.

Example of Mixvel_OrderCancelRQ:

Show request example

<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="2021-03-17T19:37:48Z"/>
    <AppData>
      <m:Mixvel_OrderCancelRQ xmlns:m="https://www.mixvel.com/API/XSD/Mixvel_OrderCancelRQ/1_01">
        <Request>
          <MixOrder>
            <MixOrderID>96829-230714-MPC1000</MixOrderID>
            <Order>
              <OrderID>96829-230714-OPC1001</OrderID>
              <RemoveCancelledPaxSegment>true</RemoveCancelledPaxSegment>
              <ReturnSeat>true</ReturnSeat>
            </Order>
          </MixOrder>
        </Request>
      </m:Mixvel_OrderCancelRQ>
    </AppData>
  </Body>
</MixEnv:Envelope>

Example of Mixvel_OrderCancelRS:

Show response example

<MixEnv:Envelope xmlns:MixEnv="https://www.mixvel.com/API/XSD/mixvel_envelope/1_06">
  <Header/>
  <Body>
    <MessageInfo MessageId="e74b2f7e-c136-441f-a95f-06b3df6122ef" ReplyTo="703423d1-595c-49f5-98c2-5dcabe950276" TimeSent="2023-07-14T12:22:21.2691519Z"/>
    <AppData>
      <Cancel:Mixvel_OrderCancelRS xmlns:Cancel="https://www.mixvel.com/API/XSD/Mixvel_OrderCancelRS/1_00">
        <Response>
          <MixOrderRef>
            <MixOrderID>96829-230714-MPC1000</MixOrderID>
            <Order>
              <OrderID>96829-230714-OPC1001</OrderID>
              <OperationStatus>Success</OperationStatus>
            </Order>
          </MixOrderRef>
        </Response>
      </Cancel:Mixvel_OrderCancelRS>
    </AppData>
  </Body>
</MixEnv:Envelope>

Order cancellation¶

Unpaid order cancellation¶

General terms¶

Request structure¶

Response structure¶

Usage scenario and message examples¶

Example of an unpaid order cancellation¶

Paid order cancellation¶

General terms¶

Request structure¶

Response structure¶

Usage scenario and message examples¶

Example of a paid order cancellation¶

Cancellation without releasing the seats¶

Cancellation of an extra service (EMD Void)¶

Partial cancellation of related services¶

Deleting segments with the status «XX»¶