--- updatedAt: 2026-02-23T11:18:34.000Z agentTools: projectIndex: https://volt-docs.travclan.com/llms.txt --- # Get Itinerary Retrieves detailed information about a specific itinerary, including guest validations, search request logs, and static content based on the provided trace ID. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Hotel API", "description": "### Overview\nThis API allows clients to search, filter, book hotels, and manage itineraries seamlessly.\n\n### Copyright\n© Copyright 2024, TravClan \nThis document contains confidential material and is the property and copyright of Travclan. \nNo part of this document may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, electronic, mechanical, chemical, photocopying, recording, or otherwise without the prior written permission of Travclan.", "version": "1.1.1", "contact": { "name": "Volt API Support", "url": "https://volt.travclan.com/contact", "email": "apisupport@travclan.com" } }, "servers": [ { "url": "https://hotel-api-sandbox.travclan.com", "description": "SandBox" }, { "url": "https://hotels-v1-tp.travclan.com", "description": "Production" }, { "url": "https://hms-api-sandbox.travclan.com", "description": "SandBox (only for Hotel Search)" }, { "url": "https://hms-v1-tp.travclan.com", "description": "Production (only for Hotel Search)" } ], "tags": [ { "name": "Itinerary", "description": "APIs related to hotel Itinerary." } ], "paths": { "/api/v1/hotels/itineraries/{itineraryCode}/": { "get": { "tags": [ "Itinerary" ], "summary": "Get Itinerary", "description": "Retrieves detailed information about a specific itinerary, including guest validations, search request logs, and static content based on the provided trace ID.", "parameters": [ { "name": "itineraryCode", "in": "path", "required": true, "description": "The unique identifier of the itinerary whose details are being retrieved.", "schema": { "type": "string" } }, { "name": "traceId", "in": "query", "required": true, "description": "An identifier used for tracing the request, helps in tracking the request in the system.", "schema": { "type": "string" } }, { "name": "guestRules", "in": "query", "required": true, "description": "Include guest rules in the response.", "schema": { "type": "boolean" } }, { "name": "searchRequestLog", "in": "query", "required": false, "description": "Include search request log in the response.", "schema": { "type": "boolean" } }, { "name": "staticContent", "in": "query", "required": false, "description": "Include static content in the response.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Status message of the API response." }, "error": { "type": "boolean", "description": "Indicates if there was an error with the request." }, "code": { "type": "integer", "description": "HTTP status code of the response." }, "results": { "type": "array", "description": "Array of results returned by the API.", "items": { "type": "object", "properties": { "traceId": { "type": "string", "description": "Unique trace ID for the request." }, "traceIdDetail": { "type": "object", "description": "Details about the trace ID.", "properties": { "id": { "type": "string", "description": "Unique trace ID." }, "remainingTime": { "type": "integer", "description": "Time remaining for the trace (in seconds)." }, "createdAt": { "type": "string", "format": "date-time", "description": "Timestamp when the trace was created." } } }, "code": { "type": "string", "description": "Unique code for the itinerary." }, "totalAmount": { "type": "number", "description": "Total amount for the itinerary." }, "createdAt": { "type": "string", "format": "date-time", "description": "Timestamp when the itinerary was created." }, "items": { "type": "array", "description": "Array of items related to the itinerary.", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Unique code for the item." }, "type": { "type": "string", "description": "Type of the item (e.g., HOTEL)." }, "createdAt": { "type": "string", "format": "date-time", "description": "Timestamp when the item was created." }, "selectedRoomsAndRates": { "type": "array", "description": "Array of selected rooms and their rates.", "items": { "type": "object", "properties": { "rate": { "type": "object", "description": "Details of the room rate.", "properties": { "id": { "type": "string", "description": "Unique identifier for the rate." }, "availability": { "type": "string", "description": "Availability of the rate." }, "needsPriceCheck": { "type": "boolean", "description": "Indicates if a price check is required." }, "isPackageRate": { "type": "boolean", "description": "Indicates if the rate is part of a package." }, "providerId": { "type": "integer", "description": "Identifier for the rate provider." }, "providerName": { "type": "string", "description": "Name of the rate provider." }, "occupancies": { "type": "array", "description": "Details of room occupancy.", "items": { "type": "object", "properties": { "roomId": { "type": "string", "description": "Unique identifier for the room." }, "stdRoomId": { "type": "string", "description": "Standard room ID." }, "numOfAdults": { "type": "string", "description": "Number of adults occupying the room." }, "numOfChildren": { "type": "string", "description": "Number of children occupying the room." } } } }, "baseRate": { "type": "number", "description": "Base rate of the room." }, "currency": { "type": "string", "description": "Currency code for the rate." }, "refundable": { "type": "boolean", "description": "Indicates if the rate is refundable." }, "refundability": { "type": "string", "description": "Details about refundability." }, "policies": { "type": "array", "description": "Policies related to the rate.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the policy (e.g., Check-in)." }, "text": { "type": "string", "description": "Text describing the policy." } } } }, "boardBasis": { "type": "object", "description": "Details about the board basis.", "properties": { "description": { "type": "string", "description": "Description of the board basis." }, "type": { "type": "string", "description": "Type of the board basis (e.g., RoomOnly)." } } }, "offers": { "type": "array", "description": "Special offers available for the rate.", "items": { "type": "object", "properties": { "title": { "type": "string", "description": "Title of the offer." }, "description": { "type": "string", "description": "Description of the offer." }, "discountOffer": { "type": "string", "description": "Discount offer amount." }, "percentageDiscountOffer": { "type": "string", "description": "Percentage discount offer." } } } }, "cancellationPolicies": { "type": "array", "description": "Cancellation policies for the rate.", "items": { "type": "object", "properties": { "rules": { "type": "array", "description": "List of cancellation rules.", "items": { "type": "object", "properties": { "value": { "type": "integer", "description": "Cancellation value." }, "valueType": { "type": "string", "description": "Type of value (e.g., Nights)." }, "estimatedValue": { "type": "number", "description": "Estimated value for the cancellation." }, "start": { "type": "string", "format": "date-time", "description": "Start time for the cancellation rule." }, "end": { "type": "string", "format": "date-time", "description": "End time for the cancellation rule." } } } } } } }, "includes": { "type": "array", "description": "Services included with the rate.", "items": { "type": "string" } } } }, "room": { "type": "object", "description": "Details about the room.", "properties": { "id": { "type": "string", "description": "Unique identifier for the room." }, "name": { "type": "string", "description": "Name of the room." }, "description": { "type": "string", "description": "Description of the room." }, "beds": { "type": "array", "description": "Details about the beds in the room.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of bed (e.g., KingBed)." }, "count": { "type": "string", "description": "Number of beds of this type." } } } } } } } } }, "isPanMandatoryForBooking": { "type": "boolean", "description": "Indicates if PAN is mandatory for booking." }, "guestRules": { "type": "object", "description": "Rules related to guests and bookings.", "properties": { "allGuestsInfoRequired": { "type": "boolean", "description": "Indicates if all guest information is required." }, "isPassportMandatory": { "type": "boolean", "description": "Indicates if a passport is mandatory." }, "isPANMandatory": { "type": "boolean", "description": "Indicates if a PAN is mandatory." } } }, "searchRequestLog": { "type": "object", "description": "This will return original request Body.", "properties": { "checkIn": { "type": "string", "format": "date", "description": "Check-in date." }, "checkOut": { "type": "string", "format": "date", "description": "Check-out date." } } }, "staticContent": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the hotel.", "example": "32177510" }, "name": { "type": "string", "description": "Name of the hotel.", "example": "Chres" }, "providerId": { "type": "integer", "description": "Identifier for the provider of the hotel data.", "example": 11 }, "providerHotelId": { "type": "string", "description": "Identifier for the hotel provided by the provider.", "example": "9623069" }, "providerName": { "type": "string", "description": "Name of the provider.", "example": "P11" }, "language": { "type": "string", "description": "Language code for the hotel data.", "example": "en-US" }, "geoCode": { "type": "object", "description": "Geographic coordinates of the hotel.", "properties": { "lat": { "type": "string", "description": "Latitude of the hotel.", "example": "33.56938" }, "long": { "type": "string", "description": "Longitude of the hotel.", "example": "133.57533" } } }, "contact": { "type": "object", "description": "Contact information for the hotel.", "properties": { "address": { "type": "object", "properties": { "line1": { "type": "string", "description": "Street address.", "example": "155 Sunazi, Takasu" }, "city": { "type": "object", "properties": { "name": { "type": "string", "description": "City of the hotel.", "example": "Kochi" } } }, "state": { "type": "object", "properties": { "name": { "type": "string", "description": "State of the hotel.", "example": "Kochi" } } }, "country": { "type": "object", "properties": { "code": { "type": "string", "description": "Country code of the hotel.", "example": "JP" }, "name": { "type": "string", "description": "Country name of the hotel.", "example": "Japan" } } }, "postalCode": { "type": "string", "description": "Postal code of the hotel.", "example": "781-8101" } } }, "phones": { "type": "array", "description": "Array of phone numbers for the hotel.", "items": { "type": "string" }, "example": [ "81-88-8667000" ] }, "fax": { "type": "array", "description": "Array of fax numbers for the hotel.", "items": { "type": "string" }, "example": [ "81-88-8667017" ] } } }, "descriptions": { "type": "array", "description": "Array of descriptions for the hotel.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of description (e.g., Name).", "example": "Name" }, "text": { "type": "string", "description": "Description text.", "example": "Chres" } } } }, "policies": { "type": "array", "description": "Array of policies related to the hotel.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of policy (e.g., know_before_you_go).", "example": "know_before_you_go" }, "text": { "type": "string", "description": "Text describing the policy.", "example": "Children 5 years old and younger are not permitted at this property." } } } }, "facilities": { "type": "array", "description": "Array of facilities available at the hotel.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the facility.", "example": "2537" }, "groupId": { "type": "string", "description": "Group identifier for the facility.", "example": "14" }, "name": { "type": "string", "description": "Name of the facility.", "example": "Number of restaurants - 1" } } } }, "facilityGroups": { "type": "array", "description": "Array of facility groups.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the facility group.", "example": "32" }, "name": { "type": "string", "description": "Name of the facility group.", "example": "Safe deposit box" }, "culture": { "type": "string", "description": "Culture code for the facility group.", "example": "en-us" }, "type": { "type": "string", "description": "Type of facility (e.g., Room, Hotel).", "example": "Room" } } } }, "rooms": { "type": "array", "description": "Array of rooms available at the hotel.", "items": { "type": "object", "properties": { "roomId": { "type": "string", "description": "Unique identifier for the room.", "example": "318140286" }, "type": { "type": "string", "description": "Type of room.", "example": "Standard Single Room, 1 Bedroom, Smoking" }, "facilities": { "type": "array", "description": "Array of facilities available in the room.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the facility.", "example": "1073743284" }, "groupId": { "type": "string", "description": "Group identifier for the facility.", "example": "0" }, "name": { "type": "string", "description": "Name of the facility.", "example": "Heating" } } } }, "beds": { "type": "array", "description": "Array of beds in the room.", "items": { "type": "object", "properties": { "Type": { "type": "string", "description": "Type of bed.", "example": "Twin" }, "Size": { "type": "string", "description": "Size of the bed.", "example": "Twin" }, "Count": { "type": "string", "description": "Number of beds.", "example": "1" } } } }, "area": { "type": "object", "properties": { "squareMeters": { "type": "string", "description": "Area in square meters.", "example": "17.5" }, "squareFeet": { "type": "string", "description": "Area in square feet.", "example": "188" } } }, "maxGuestAllowed": { "type": "string", "description": "Maximum number of guests allowed.", "example": "1" }, "maxAdultAllowed": { "type": "string", "description": "Maximum number of adults allowed.", "example": "1" }, "maxChildrenAllowed": { "type": "string", "description": "Maximum number of children allowed.", "example": "0" } } } }, "images": { "type": "array", "description": "Array of images of the hotel.", "items": { "type": "object", "properties": { "links": { "type": "array", "description": "Array of image links.", "items": { "type": "object", "properties": { "size": { "type": "string", "description": "Size of the image (e.g., Standard, Xxl).", "example": "Standard" }, "url": { "type": "string", "description": "URL of the image.", "example": "https://i.travelapi.com/lodging/10000000/9630000/9623100/9623069/eb03775f_b.jpg" } } } }, "caption": { "type": "string", "description": "Caption for the image.", "example": "Primary image" }, "roomCodes": { "type": "array", "description": "Array of room codes associated with the image.", "items": { "type": "string" }, "example": [] } } } }, "nearByAttractions": { "type": "array", "description": "Array of nearby attractions.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the attraction.", "example": "Museum of Art" }, "distance": { "type": "string", "description": "Distance to the attraction.", "example": "1" }, "unit": { "type": "string", "description": "Unit of distance measurement (e.g., Km).", "example": "Km" } } } }, "reviews": { "type": "array", "description": "Array of reviews for the hotel.", "items": { "type": "object", "properties": { "provider": { "type": "string", "description": "Identifier for the review provider.", "example": "P1" }, "count": { "type": "string", "description": "Number of reviews.", "example": "5" }, "rating": { "type": "string", "description": "Average rating.", "example": "4.4" }, "categoryratings": { "type": "array", "description": "Array of ratings by category.", "items": { "type": "object", "properties": { "category": { "type": "string", "description": "Category of rating (e.g., cleanliness).", "example": "cleanliness" }, "rating": { "type": "string", "description": "Rating for the category.", "example": "4.4" } } } } } } }, "imagesAndCaptions": { "type": "object", "description": "Categorized images with captions.", "properties": { "Lobby": { "type": "object", "description": "Images related to the hotel lobby.", "properties": { "captionLabel": { "type": "string", "description": "Label for the caption.", "example": "Lobby" }, "images": { "type": "array", "description": "Array of images for the specified category.", "items": { "type": "object", "properties": { "links": { "type": "array", "description": "Array of image links.", "items": { "type": "object", "properties": { "size": { "type": "string", "description": "Size of the image (e.g., Standard, Xxl).", "example": "Standard" }, "url": { "type": "string", "description": "URL of the image.", "example": "https://i.travelapi.com/lodging/10000000/9630000/9623100/9623069/eb03775f_b.jpg" } } } }, "caption": { "type": "string", "description": "Caption for the image.", "example": "Primary image" }, "roomCodes": { "type": "array", "description": "Array of room codes associated with the image.", "items": { "type": "string" }, "example": [] } } } } } }, "Room": { "type": "object", "description": "Images related to the hotel rooms.", "properties": { "captionLabel": { "type": "string", "description": "Label for the caption.", "example": "Room" }, "images": { "type": "array", "description": "Array of images for the specified category.", "items": { "type": "object", "properties": { "links": { "type": "array", "description": "Array of image links.", "items": { "type": "object", "properties": { "size": { "type": "string", "description": "Size of the image (e.g., Standard, Xxl).", "example": "Standard" }, "url": { "type": "string", "description": "URL of the image.", "example": "https://i.travelapi.com/lodging/10000000/9630000/9623100/9623069/8de1c38f_b.jpg" } } } }, "caption": { "type": "string", "description": "Caption for the image.", "example": "Room" }, "roomCodes": { "type": "array", "description": "Array of room codes associated with the image.", "items": { "type": "string" }, "example": [] } } } } } } } }, "attributes": { "type": "array", "description": "Array of additional attributes related to the hotel.", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Key for the attribute.", "example": "general_1073745142" }, "value": { "type": "string", "description": "Value of the attribute.", "example": "Professional property host/manager" } } } }, "groupedFacilities": { "type": "array", "description": "Array of grouped facilities for the hotel.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the grouped facility.", "example": "32" }, "name": { "type": "string", "description": "Name of the grouped facility.", "example": "Safe deposit box" }, "culture": { "type": "string", "description": "Culture code for the grouped facility.", "example": "en-us" }, "type": { "type": "string", "description": "Type of facility (e.g., Room, Hotel).", "example": "Room" }, "facilities": { "type": "array", "description": "Array of facilities within the group.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the facility.", "example": "2016" }, "groupId": { "type": "string", "description": "Group identifier for the facility.", "example": "32" }, "name": { "type": "string", "description": "Name of the facility.", "example": "Safe-deposit box at front desk" } } } }, "imageUrl": { "type": "string", "description": "URL of the image representing the facility.", "example": "https://s3.ap-south-1.amazonaws.com/com.travclan.cms.production/appcms/tick61022.svg" } } } }, "fees": { "type": "array", "description": "Array of fees associated with the hotel.", "items": { "type": "object", "description": "Currently empty." } }, "badges": { "type": "array", "description": "Array of badges associated with the hotel.", "items": { "type": "string", "description": "Badge or label for the hotel.", "example": "Top Pick" } }, "tags": { "type": "array", "description": "Array of tags associated with the hotel.", "items": { "type": "string", "description": "Tag for the hotel.", "example": "Luxury Stay" } } } } } } } } } } } } } } }, "400": { "description": "Bad Request - Missing or invalid parameters." }, "401": { "description": "Unauthorized - Invalid or missing access token." }, "422": { "description": "Bad Request. Client Side Error in Request Body." }, "500": { "description": "Internal Server Error - Something went wrong on the server." } } } } } } ```