The identity and technical contract details declared by the specification.
HotelSearchData
object
Defines the structure for hotel data in the search results.
8 properties
5 required
Department
object
Department details.
4 properties
2 required
NameSuffix
string
Suffix for name
CompanyConfigSourceWrapper
object
Wrapper for option source company config.
1 property
SeatPref
object
Preference about seat of rail.
5 properties
Preference
object
3 properties
1 required
DepartmentId
object
Department id.
1 property
1 required
TravelRegionType
string
Travel region Type
AdhocUserInfo
object
Basic information related to ad-hoc traveler profile.
2 properties
1 required
HotelPropertyType
object
Describes the type of property for a hotel.
2 properties
1 required
HotelPriceCheckResponse
object
Defines the structure of a hotel price check response.
4 properties
4 required
LegalEntityIdListWrapper
object
1 property
DateTimeOffset
object
ISO8601 UTC Date Time
1 property
1 required
HotelTraveler
object
7 properties
4 required
OccupancyDates
object
3 properties
3 required
UserOrgId
object
User and user's organization information.
5 properties
2 required
IntListWrapper
object
1 property
ContactInfo
object
Provides contact information for a hotel.
3 properties
2 required
HotelAdditionalDetailType
string
AirportSearch
object
2 properties
2 required
PolicyPreventBookingAction
object
Whether to allow booking if a rule is violated.
2 properties
LegalEntityId
object
The ID of the legal entity.
1 property
1 required
HotelSortOptions
object
Defines the sorting options for hotel search results.
2 properties
2 required
PostStripeVerificationInfoWrapper
object
Wrapper for post stripe verification info object.
1 property
Credit
object
18 properties
12 required
OrganizationAgencyId
object
Agency id for the organization.
1 property
1 required
HotelRoomMealType
string
Type of meal plan
PaymentVerificationInfo
object
VerificationInfo required for the payment operation.
2 properties
Accessibility
object
Information about the accessibility of the hotel room.
3 properties
2 required
Card
object
User card info
15 properties
1 required
FlightPassPaymentAmounts
object
Fare breakdown for the flight pass booking.
4 properties
Int32Range
object
2 properties
EmergencyContactInfo
object
Emergency contact information.
6 properties
1 required
Condition
object
Details of the condition
2 properties
2 required
HotelCreatePnrRequest
object
Defines the structure of a hotel create pnr request
12 properties
5 required
RegistrarUserIdSearch
object
2 properties
2 required
CoordinatesSearch
object
2 properties
2 required
CustomFieldType
string
The type of custom field.
PolicyFlagActionWrapper
object
1 property
SimpleMoney
object
Money object containing just amount and currency code.
2 properties
2 required
PaymentInfo
object
Payment information.
4 properties
1 required
WorkerType
string
The type of worker.
PostalAddressWrapper
object
1 property
ItemType
string
Type of payment item eligible for this fop rule
DoubleRangeWrapper
object
1 property
PolicyHideActionWrapper
object
1 property
ThreeDSecure2VerificationInfoItem
object
3DS2 verification info.
3 properties
3 required
RoomFee
object
Room Fee
4 properties
1 required
SeatAmenityPref
object
Seat amenity preference.
1 property
1 required
PostUrlBasedVerificationInfoWrapper
object
Wrapper for post url based verification info object.
1 property
HotelRoomMeals
object
Meal details for the room
2 properties
1 required
LoyaltyInfo
object
Loyalty Info details.
6 properties
3 required
VariableName
string
Name of the variable.
Int64Wrapper
object
1 property
BedInfo
object
Bed count and type
2 properties
RazorpayPostVerificationInfoWrapper
object
Wrapper for post razorpay verification info object.
1 property
LoyaltyTier
string
Loyalty membership tier name echoed from the supplier.
AnswerPair
object
3 properties
StripeVerificationInfo
object
Verification information required for card stripe verification.
1 property
ErrorParameter
object
Error parameter
2 properties
UserIdWrapper
object
Wrapper over UserId object to be used as an identifier in a oneOf case
1 property
HotelDetailsRequest
object
Request object for fetching hotel details.
5 properties
1 required
RatingWrapper
object
1 property
HotelImageCategory
string
Category of image such as exterior, spa, etc.
Office
object
Office details.
5 properties
2 required
StripeVerificationInfoWrapper
object
Wrapper for stripe verification Info.
1 property
OfficeIdWrapper
object
1 property
CustomFieldV3Response
object
Custom field responses.
5 properties
3 required
Expression
object
Expression consisting of variables and constants which needs to be sent along with custom field response.
3 properties
2 required
RailPref
object
Travel preferences related to rail station.
5 properties
EntityAnswer
object
7 properties
GradeId
object
Grade id.
1 property
1 required
HotelCodeSearch
object
2 properties
2 required
Name
object
Full name containing first, middle, last (family) names, and suffix.
6 properties
2 required
CarVendor
object
Car vendor.
3 properties
2 required
Image
object
An image with meta data. Either the data or url property must be supplied to load the image.
3 properties
AdditionalInfo
object
Additional data need to be sent along with the custom field response.
HotelDetailsFilters
object
Filters for hotel details.
1 property
1 required
StripeCardTokens
object
Stripe card tokens used by clients in authorizing newly added cards.
5 properties
3 required
Int32Wrapper
object
1 property
TripId
object
Id of trip.
1 property
1 required
PostalAddress
object
Postal Address Details
19 properties
2 required
StringListWrapper
object
1 property
HotelSearchMetadata
object
Includes metadata for a hotel search.
4 properties
2 required
HotelSearchParams
object
The parameters required for searching hotels.
2 properties
2 required
CompanyRef
object
Basic information about a company.
3 properties
1 required
PercentageWrapper
object
1 property
Option
object
Answer option for a question
2 properties
1 required
PolicyPreventBookingActionWrapper
object
1 property
HotelDetailsResponse
object
Response object for hotel details.
9 properties
3 required
AmadeusCheckoutVerificationInfo
object
4 properties
1 required
ThreeDSecure2VerificationResultItem
object
Result of 3DS2 verification.
3 properties
3 required
RoomPreference
object
Room options and stay preference.
7 properties
ErrorResponse
object
2 properties
PreferredRailStation
object
Rail station preferred by traveler.
5 properties
2 required
ExpiryWrapper
object
1 property
HotelUserId
object
An identifier for the user involved in the hotel booking or search process.
AmadeusCheckoutVerificationInfoWrapper
object
Wrapper for amadeus checkout verification info object
1 property
BookingContact
object
2 properties
Tier
string
Tier of User. Note: In default UI, BASIC is displayed as Standard, and SEAT1A is displayed as VIP.
HotelSearchFilters
object
Filters to refine the search result. Based on the user selected filters, the list of matching hotels will be displayed.
15 properties
RailCard
object
Rail card
5 properties
3 required
HotelAmenity
object
Type of hotel amenity
3 properties
1 required
PrimaryServiceProviderTmc
object
Primary service provider TMC info
1 property
1 required
CardDetails
object
Card Details
3 properties
3 required
AirRequestTravelerInfo
object
The traveler identifiers. These can be either the Spotnana user IDs of the travelers or information regarding the adhoc travelers.
BookingTravelerPaymentDetails
object
List of different forms of payments used for booking for a set of travelers.
1 property
1 required
DoubleListWrapper
object
1 property
BedType
string
Bed types.
HotelRoomRate
object
Rate details for hotel room
6 properties
2 required
MoneyWrapper
object
1 property
UrlVerificationInfo
object
Verification information required for url based payment verification.
1 property
PreCheckoutQuestionType
string
Types of pre-checkout questions. USERDEFINEDQUESTION the default question type for all pre checkout questions which have been created from UI. OOPREASONCODE is…
AirlinePref
object
Airline preferences.
2 properties
HotelChain
object
The chain of hotel.
2 properties
WorkerTypeWrapper
object
1 property
KeywordWithReasonListWrapper
object
1 property
AirRestrictedFaresParamsWrapper
object
1 property
ImmigrationDocumentWrapper
object
1 property
OptionInfo
object
Options related information for the question.
4 properties
1 required
TermsAndConditions
object
Terms and conditions.
1 property
OptionSource
string
Option source
HotelRateInfo
object
Information about a hotel rate.
16 properties
10 required
PolicyAlertOnSelectionAction
object
1 property
SplitPayment
object
Split payment details for claiming reimbursements.
3 properties
SeatPrefDirection
string
The direction of seat of the rail.
OptionSourceMetadata
object
Metadata information for the option source.
TravelType
string
Travel Type
HotelModifyDetailsRequest
object
Request object for fetching hotel details if room is already booked.
2 properties
1 required
EntityId
object
Identifier of an object
1 property
1 required
KnownTravelerNumber
object
Information about the Known Traveler Number (KTN).
2 properties
2 required
HotelPriceCheckRequest
object
Defines the structure of a hotel price check request.
2 properties
1 required
Money
object
Money object containing details such as the amount, the currency code, and the converted amount.
5 properties
2 required
RewardPointsEarned
object
Details reward points earned.
3 properties
3 required
PenaltyAmount
object
Penalty Amount
1 property
SelectedPaymentSource
object
Describes the selected payment source for the booking.
5 properties
RestrictedKeywordsWithReason
object
2 properties
HotelAccessibleFeatureType
string
Types of accessible features available in the hotel.
OfficeIdListWrapper
object
1 property
FlightPassPaymentMetadata
object
Metadata specific to Flight Pass payment method in OtherCoinage.
2 properties
DateModel
object
Date in ISO 8601 standard.
1 property
1 required
CorporateInfoV2
object
Corporate data to be collected during the search request workflow.
1 property
1 required
SupplierType
string
Supplier type like Sabre, TravelFusion etc.
NumStopsPref
object
Preferred number of stops.
1 property
1 required
PolicySplitPaymentActionWrapper
object
1 property
UserBasicInfo
object
Basic user information.
9 properties
HotelRateStatistics
object
Contains statistical information about hotel search results.
5 properties
3 required
Traveler
object
Traveler details.
9 properties
CentralCardAccessLevel
string
Identifies at which level central card is applicable, for example organization or legal entity.
ThreeDSecure2PostVerificationInfo
object
Result of 3DS2 verification.
1 property
1 required
UserBusinessInfo
object
User business information.
14 properties
4 required
HotelSpecialRequests
object
Hotel special requests
7 properties
TokenBasedPaginationRequest
object
Pagination request for token-based pagination, where a token is used to retrieve the next page of results.
PolicyTakeApprovalActionWrapper
object
1 property
CostCenterId
object
1 property
1 required
DoubleRange
object
2 properties
GatewayIdentifier
object
2 properties
HotelPref
object
Travel preferences related to hotel.
5 properties
RazorpayPostVerificationInfo
object
Object to indicate successful stripe verification and provide payment information for next steps.
3 properties
1 required
LengthWrapper
object
1 property
Latlng
object
Latitude and Longitude for a Location
2 properties
2 required
CardAccessEntity
object
Contains the central access level and entity id.
2 properties
1 required
FlightPassTax
object
A single tax component of the flight pass fare.
2 properties
HotelBrand
object
The brand of hotel.
2 properties
LegalEntityIdWrapper
object
1 property
HotelRoomMealsIncluded
string
Meals included, (Breakfast/Lunch/Dinner)
User
object
User details.
13 properties
RedressNumberWrapper
object
1 property
OfficeId
object
The unique ID of the office.
1 property
1 required
HotelModifyBookingResponse
object
Defines the structure of a hotel modify booking response
4 properties
2 required
TimeLocal
object
ISO8601 Local Time
1 property
1 required
PersonaWrapper
object
1 property
NationalDocWrapper
object
1 property
PageSize
object
The page size.
2 properties
1 required
CreditCardAccess
object
Access type for cards to check who in the organization has permission to use it
3 properties
2 required
SecondaryServiceProviderTmc
object
Secondary service provider TMC info
3 properties
3 required
HotelModifyBookingRequest
object
Defines the structure of a hotel modify booking request
10 properties
4 required
TmcInfo
object
TMC config information.
4 properties
2 required
MultiHotelCodesSearch
object
2 properties
2 required
ApprovalType
string
Type of APPROVAL
UserIdSearch
object
2 properties
2 required
HotelRoomAmenity
object
Hotel Room amenities
3 properties
FareComponent
string
Fare component eligible for this fop rule
Duration
object
Represents a duration of time with specific units of time.
1 property
MealPref
object
Meal preferences.
3 properties
PolicyAction
object
Action that is required / done for policy.
HotelValidateRebookingResponse
object
Hotel Validate rebooking response
2 properties
2 required
UserOrgIdListWrapper
object
1 property
AdhocTravelerInfoWrapper
object
Wrapper over AdhocTravelerInfo object to be used as an identifier in a oneOf case.
1 property
PreSearchQuestionType
string
Types of pre-search questions. PURPOSEOFTRIP required to ask purpose of the trip user is going to. For example: meeting, training, interview.
KeywordsWithReasonList
object
1 property
CreditCardAccessType
string
Identifies the different ways the card can be used across an organization
HotelPrefAmenity
string
Preferred hotel amenity.
CardCompany
string
The issuing company of card
RedressNumber
object
Redress details
2 properties
2 required
DateTimeLocal
object
Local date and time in ISO 8601 format.
1 property
1 required
PaymentItem
object
The payment item eligible for associated payment rules
2 properties
TripData
object
Trip data to book a PNR.
7 properties
1 required
OrganizationId
object
Organization id for traveler.
1 property
1 required
BookingPaymentDetails
object
Payment details used for booking.
1 property
1 required
FlightPassPaymentMetadataWrapper
object
Wrapper for Flight Pass payment metadata.
2 properties
1 required
SimpleMoneyRange
object
SimpleMoney range containing minimum and maximum amount.
2 properties
PrepaidQualifier
string
Prepaid qualifiers.
HotelDescription
object
Hotel description
2 properties
HotelSearchRateInfo
object
Contains detailed rate information for a hotel search.
5 properties
3 required
RoomClass
string
Room Class
SelectedFormOfPayment
object
List of different forms of payments used for booking for a set of travelers.
2 properties
2 required
CancellationPenalty
object
Passport
object
Passport details.
6 properties
4 required
PolicyRuleResultInfo
object
3 properties
HotelRoomData
object
Details about a specific hotel room.
5 properties
2 required
OwnershipLabel
string
Ownership label of the card whether it is personal, corporate or central.
SeatPrefLocation
string
The location of seat of the rail.
Variable
object
Variable defining the additional value to be sent along with custom field response.
2 properties
2 required
AlliancePref
object
Alliance preferences.
1 property
1 required
HotelCancelPnrRequest
object
Request object for cancelling a hotel pnr.
3 properties
Grade
object
Grade details.
3 properties
2 required
HotelRateAssuranceMetadata
object
Savings information from the rate assurance rebooking
2 properties
HotelValidateRebookingRequest
object
3 properties
3 required
PromotionalOffer
object
Represents a promotional offer applied to a hotel rate.
1 property
1 required
RazorpayVerificationInfoWrapper
object
Wrapper for Razorpay verification Info.
1 property
Length
object
Specifies the length or a distance.
2 properties
2 required
PenaltyPercentage
object
Penalty percentage
1 property
UrlVerificationInfoWrapper
object
Wrapper for stripe verification Info.
1 property
Tax
object
Tax details
3 properties
1 required
SeatLocationPref
object
Seat location preference.
4 properties
Occupancy
object
2 properties
1 required
CustomFieldLocation
string
Display the custom fields in all these locations.
TripUsageType
string
Trip usage type.
AirPref
object
Travel preferences related to air travel.
9 properties
PolicyTakeApprovalAction
object
6 properties
PostPaymentVerificationInfo
object
Payment information sent after the verification of payment method.
1 property
ThreeDSecure2VerificationInfoWrapper
object
Wrapper for 3DS2 verification Info.
1 property
HotelCo2EmissionDetail
object
The co2 emission detail for the hotel.
1 property
1 required
BoolWrapper
object
1 property
IncludeLocation
string
Various traveler notifications (e.g. emails) where the responses to this field should be included.
PolicyFlagAction
object
1 property
PolicyType
string
Policy type.
PolicyViolationInfo
object
Policy Violation info.
4 properties
FarePref
object
Fare preferences.
1 property
1 required
SeatPrefType
string
The type of seat of the rail.
PolicyPredicate
string
This contains the enum mentioning the policy rule which was violated.
DoubleWrapper
object
1 property
PassportWrapper
object
1 property
ThreeDSecure2PostVerificationInfoWrapper
object
Wrapper for 3DS2 post verification info object
1 property
PreferredType
string
Preference type.
HotelRoomInfo
object
Information about the room.
4 properties
HotelAncillariesRequest
object
Request to retrieve available ancillaries for a hotel booking.
1 property
1 required
CoachPref
string
The preference of coach.
PreferredAirport
object
Airport preferred by traveler.
3 properties
2 required
RoomType
string
Room Type
CustomFieldOptionsParam
string
Parameter to form options for the custom field.
AirlineInfo
object
2 properties
2 required
Dpan
object
Object to pass through dpan payment source details through the api call.
2 properties
2 required
HotelAncillariesResponse
object
Response containing available ancillaries for the hotel booking.
1 property
CardType
object
Information about the type of card accepted.
2 properties
1 required
CarPref
object
Travel preferences related to car.
5 properties
PreferredLocationLabel
string
The label of preferred airport or rail station.
TravelClassHierarchy
string
Rail Travel classes in hierarchy numbering higher to keep scope for future additions in between.
Persona
string
Persona of the user
PaymentMethod
string
Payment method
AdhocTravelerInfo
object
Describes an adhoc traveler.
2 properties
EngineType
string
Engine types.
TmcBasicInfo
object
TMC related basic information.
2 properties
2 required
DeckLevel
string
The deck level of the rail.
HotelStarRatingInfo
object
Details about hotel star rating.
2 properties
2 required
TravelPref
object
Travel preferences.
6 properties
AirRestrictedKeyword
object
Airline/Keyword to be restricted
2 properties
1 required
TravelClassHierarchyWrapper
object
1 property
RailTravelClass
string
Travel class
QuestionFormat
string
Question types. INPUTBOX will make user enter a free flowing text. RADIOBUTTON will have multiple options, user can select only one. CHECKBOX questions contain…
CustomFieldSelectedOption
object
Selected response for the custom field.
7 properties
1 required
Reference
object
Reference of an entity
2 properties
1 required
CancellationPolicyTerm
object
Conditions and restrictions on Cancellations.
2 properties
2 required
TransmissionSearchFilter
string
Transmission type for Filters
CostCenter
object
Cost center details.
3 properties
2 required
QuestionType
object
Question type.
2 properties
TokenBasedPaginationResponse
object
Pagination response for token based pagination. Contains the next page token(if next page is available) and pagination parameters.
2 properties
1 required
HotelCancelPnrResponse
object
Response object for cancelling a hotel pnr.
2 properties
1 required
ImmigrationDocument
object
Immigration document details.
8 properties
3 required
RateOption
object
Details about a specific rate option for a hotel room.
25 properties
18 required
NationalDoc
object
National Document Id details.
5 properties
2 required
HotelSearchRequest
object
Defines the structure of a hotel search request.
5 properties
2 required
StringWrapper
object
1 property
Dimensions
object
Image dimensions ie width and height.
2 properties
RazorpayVerificationInfo
object
Verification information required when card is tokenized via Razorpay for Indian markets.
2 properties
1 required
PreBookAnswers
object
2 properties
HotelAdditionalDetail
object
2 properties
TokenizedExpiryWrapper
object
1 property
PreSearchAnswers
object
2 properties
PostUrlBasedVerificationInfo
object
1 property
WorkerTypeListWrapper
object
1 property
TravelerPersonalInfo
object
Traveler personal information.
3 properties
AmadeusPaymentActionToken
object
2 properties
2 required
PageToken
object
The page token.
2 properties
2 required
Int32RangeWrapper
object
1 property
UserOrgIdWrapper
object
1 property
CompanyConfigSource
object
For this option source, options would be auto generated based on specified parameter.
1 property
1 required
ImageGroup
object
Contains different sizes of the same image.
2 properties
1 required
ThreeDSecure2VerificationInfo
object
Verification information required for 3DS2 authentication.
1 property
1 required
RawPaymentSourceDetails
object
Raw Details of the Payment Source
PostStripeVerificationInfo
object
Object to indicate successful stripe verification and provide payment information for next steps.
1 property
HotelSearchResponse
object
Defines the structure of a hotel search response.
3 properties
3 required
HotelCreatePnrResponse
object
Defines the structure of a hotel create pnr response
4 properties
2 required
ConditionalRate
string
Conditional rate.
UserId
object
User identifier
1 property
1 required
HotelSpec
object
Includes detailed specifications for a hotel, such as name, star rating, address, coordinates, amenities, and other information.
17 properties
8 required
KnownTravelerNumberWrapper
object
1 property
CommonPolicyInfo
object
Includes detailed information about a policy, such as its unique identifier, type, name, rules, version, and approval type.
6 properties
5 required
PolicyConstValue
object
1 property
TokenizedExpiry
object
Contains the tokenized expiry of a Card.
2 properties
2 required
EmergencyContact
object
Emergency contact information.
6 properties
2 required
HotelMedianRateInfo
object
Details median rate information for a hotel.
2 properties
2 required
CompanyId
object
Company ID
1 property
1 required
HotelCancellationPolicy
object
Cancellation policy for the PNR
3 properties
HotelImageSet
object
Object containing details of images of different for a given category.
2 properties
2 required
TravelerMatchConditions
object
Matching conditions for traveler.
6 properties
Commission
object
Commision on rate
2 properties
1 required
PhoneNumber
object
Properly formatted phone number.
10 properties
ProfileOwner
object
Basic information about the owner of the ad-hoc user.
1 property
1 required
CustomFieldMatchConditions
object
Conditions to select the custom field for given context.
4 properties
PersonaListWrapper
object
1 property
HotelAmenityType
string
Type of hotel amenity.
IdentityDocument
object
Identity document details. Currently supported documents are passport, immigration document, known traveler number, redress number and national document.
Expiry
object
Contains the expiry of a Card.
2 properties
2 required
AirRestrictedFaresParams
object
1 property
HotelAncillary
object
Represents an individual ancillary service or add-on for a hotel booking.
13 properties
8 required
CancellationDuration
object
2 properties
CardExpiry
object
Contains the expiry of a Card.
Question
object
The message defines the format of a question which can be asked to a user in any kind of workflows.
10 properties
4 required
MealType
string
Type of the meal
PolicyAlertOnSelectionActionWrapper
object
1 property
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Spotnana publishes across the network.