Identifiers (UIDs)
ApiXV identifies hotels, options, confirmations, bookings and cancellations with its own unique identifiers (UIDs). Field names ending in _uid hold a single identifier. Parameters ending in _uids take a comma-separated list, for example hotel_uids=AXH-XNL4fK9Tq2,AXH-XNLb7Rm2Pz.
UIDs contain only letters, digits and dashes, so they are safe to use in URLs. Treat them as opaque strings: store and send them exactly as received, and don't derive meaning from their contents.
| UID | Identifies | Example | Lifetime |
|---|---|---|---|
hotel_uid |
A hotel | AXH-XNL4fK9Tq2 |
Permanent |
option_uid |
A bookable option from an availability search (room, board, rate) | AXO-LjA3EWynZKvCNXAHT3Ji |
Short-lived |
confirmation_uid |
A confirmed option, ready to book | AXCO-2nyaSSwKw42h3jwGy2KSWTGZshCrhM9XrhL |
Short-lived |
booking_uid |
A booking | AXB-01JA6ZQ3V8K2M4N5P6Q7R8S9TW |
Permanent |
cancellation_uid |
A cancellation, returned in the cancel response | AXCA-3yZe7d5Lc9Wq |
Reference only |
Permanent identifiers can be stored. If a hotel is ever given a new hotel_uid, the previous one keeps working in requests.
Short-lived identifiers belong to one search or confirmation. Use them right away to confirm and book; don't store them. When one has expired, search again.
Reference only identifiers are returned for your records. No endpoint accepts a cancellation_uid; use the booking_uid to look a cancelled booking up.