Seats reserve¶
General terms¶
Endpoint: /api/Order/Inv-Guarantee
The method Mixvel_InvGuaranteeRQ is used for requests of guaranteed services in the offer, in order to transfer them into an executed / paid / completed offer.
The method Mixvel_InvGuaranteeRS returns the response with ID reserve number (guarantee number) and the valid period for this reserve. Guaranteed TimeLimit cannot exceed TimeLimit Offers, after which new offers will be generated.
Possible responses variants:
-
«Inventory Guarantee Identifier» for each offer and / or ID of the service.
-
No possibility to set up the reserve – with pointing out the reasons why the offer «cannot be reserved».
-
The offer «cannot be reserved».
Request structure¶
| Parameter XPath | Filling example | Description |
|---|---|---|
| Mixvel_InvGuaranteeRQ/Request/SelectedOffer/OfferRefID | 4b33414c-5503-4275-9416-7c98a7f5dd1a | Commercial offer identifier |
Response structure¶
| Parameter XPath | Filling example | Description |
|---|---|---|
| Mixvel_InvGuaranteeRS / Response / InventoryGuarantee / OfferID | 77939f37-7743-4463-a0f7-313da505a315 | A unique ID of the offer. It’s used at creation of the order / booking |
| Mixvel_InvGuaranteeRS / Response / InventoryGuarantee / InventoryGuaranteeTimeLimitDateTime | 2025-02-20T13:40:00 | The data in this field contains the data and the time up to which the preliminary booking of the seats will be active |
Usage scenario and message examples¶
Mixvel_InvGuaranteeRQ:
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>
<MessageInfo MessageId="79b67a26-6fc3-41e3-8ac4-14e0ac0245c8" TimeSent="2025-01-07T17:37:47Z"/>
<AppData>
<m:Mixvel_InvGuaranteeRQ xmlns:m="https://www.mixvel.com/API/XSD/Mixvel_InvGuaranteeRQ/1_00">
<Request>
<SelectedOffer>
<OfferRefID>25283a93-f691-4cd2-956b-9f9a0bf03355</OfferRefID>
</SelectedOffer>
</Request>
</m:Mixvel_InvGuaranteeRQ>
</AppData>
</Body>
</MixEnv:Envelope>
Within the InvGuaranteeRQ no new offers are generated. Only the existing ones are modified.
Mixvel_InvGuaranteeRS:
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="019af860-cddd-74af-9957-57c7f10fbcbe" ReplyTo="79b67a26-6fc3-41e3-8ac4-14e0ac0245c8" TimeSent="2025-12-07T10:34:45.6789345Z" />
<AppData>
<InvGuarantee:Mixvel_InvGuaranteeRS xmlns:InvGuarantee="https://www.mixvel.com/API/XSD/Mixvel_InvGuaranteeRS/1_00">
<Response>
<InventoryGuarantee>
<OfferID>25283a93-f691-4cd2-956b-9f9a0bf03355</OfferID>
<InventoryGuaranteeTimeLimitDateTime>2025-12-07T10:50:00Z</InventoryGuaranteeTimeLimitDateTime>
</InventoryGuarantee>
</Response>
</InvGuarantee:Mixvel_InvGuaranteeRS>
</AppData>
</Body>
</MixEnv:Envelope>
After successful execution of the method InvGuaranteeRS there comes the response:
-
InventoryGuaranteeTimeLimitDateTime -in the format date and time of the booking termination;
-
OfferID, which can be later used at seats booking.
To subsequently book reserved seats, use the Mixvel_OrderCreateRQ method.
Cancellation of the Seats Reserve¶
Endpoint: /api/Order/inv-guarantee-release
The method Mixvel_InvReleaseNotifRQ returns a disclaimer about the seats reserved via InvGuaranteeRQ/RS. In case of cancellation, the modified OfferId is also removed.
Mixvel_InvReleaseNotifRQ:
Show request example
<?xml version="1.0" encoding="UTF-8"?>
<MixEnv:Envelope xmlns:MixEnv="https://www.mixvel.com/API/XSD/mixvel_envelope/1_05">
<Header/>
<Body>
<MessageInfo MessageId="79b67a26-6fc3-41e3-8ac4-14e0ac0245c8" TimeSent="2021-03-17T17:37:47Z"/>
<AppData>
<m:Mixvel_InvReleaseNotifRQ xmlns:m="https://www.mixvel.com/API/XSD/Mixvel_InvReleaseNotifRQ/1_00">
<Request>
<SelectedOffer>
<OfferRefID>25283a93-f691-4cd2-956b-9f9a0bf03355</OfferRefID>
</SelectedOffer>
</Request>
</m:Mixvel_InvReleaseNotifRQ>
</AppData>
</Body>
</MixEnv:Envelope>
To cancel the Seats Reserve one needs to indicate the Offer, which the Agent receives af the method Mixvel_InvGuaranteeRS.
The method Mixvel_Acknowledgement brings the code in the response:
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="019af862-7135-75fc-a9b8-b2834b525f3e" ReplyTo="79b67a26-6fc3-41e3-8ac4-14e0ac0245c8" TimeSent="2025-12-07T10:36:32.6803415Z" />
<AppData>
<Ack:Mixvel_Acknowledgement xmlns:Ack="https://www.mixvel.com/API/XSD/Mixvel_Acknowledgement/1_00">
<Response>
<StatusCode>OK</StatusCode>
<StatusMessageText>XX</StatusMessageText>
</Response>
</Ack:Mixvel_Acknowledgement>
</AppData>
</Body>
</MixEnv:Envelope>
If the Seats Reserve cancellation was executed successfully, then the reply contains the code – XX.
Reservations for previously reserved seats will be made upon request Mixvel_OrderCreateRQ.