/api/hotel/availability

post https://nexus.prod.zentrumhub.com/api/hotel/availability

Body Params

channelId

string

required

length ≥ 1

A unique identifier that is generated during setup. It is used to identify the source of the request and apply the appropriate business configurations.

currency

string

required

length ≥ 1

Used to define the currency in which the rates should be returned. If not specified, the default currency configured on the channel will be used.

culture

string | null

checkIn

date-time

required

Check-in date.

checkOut

date-time

required

Check-out date.

occupancies

array of objects

required

Specify the occupancy details for each room requested. For a multi-room request, each room's occupancy should be specified separately.

occupancies*

circularRegion

object

polygonalRegion

object

multiPolygonalRegion

object

hotelIds

array of strings | null

Unica hotelIds

hotelIds

nationality

string | null

Used to identify the primary guest's nationality. This information might be used to fetch nationality-based rates from the provider/hotels. Format: 2-character ISO country code.

countryOfResidence

string | null

Used to identify the primary guest's nationality. This information might be used to fetch nationality-based rates from the provider/hotels. Format: 2-character ISO country code.

destinationCountryCode

string | null

Country code of the destination. Format: 2-character ISO country code.

filterBy

object

additionalInformation

array of objects | null

Additional information.

additionalInformation

providerFilter

object

userInfo

object

travelPurpose

string

Headers

accountId

string

required

Defaults to zentrum-demo-account

A custom header for all requests

apiKey

string

required

Defaults to 4477a62d-2bb6-4392-896a-3f5270962dbc

apiKey

Responses

Response body

object

token

string | null

Unique token recieved in the search init response to be used throught the process from search to book for a complete transaction.

currency

string | null

The currency details for the hotel rates.

hotels

array of objects | null

List of hotels

hotels

object

string | null

UnicaId of the hotel.

relevanceScore

int64

rate

object

isRecommended

boolean | null

options

object

rooms

array of objects | null

rooms

object

string | null

Id of the room.

name

string | null

Name of the room.

description

string | null

Description of the room.

beds

array of objects | null

Bedding info of the room.

beds

object

type

string | null

Type of the bed.

description

string | null

Description of the bed.

count

int64

Number of beds.

smokingAllowed

boolean | null

Indicates if smoking is allowed or not in the room.

facilities

array of objects | null

List of facilities included with the room.

facilities

object

name

string | null

Name of the facility.

description

string | null

Description of the facility.

images

array of objects | null

List of room images.

images

object

url

string | null

Url of the image.

links

array of objects | null

List of image links.

links

object

url

string | null

Url of the image.

size

string | null

Size of the image.

caption

string | null

Caption of the image.

maxGuestAllowed

int32 | null

Indicates the maximum number of guests allowed in the room.

maxAdultAllowed

int32 | null

Indicates the maximum number of adults allowed in the room.

maxChildrenAllowed

int32 | null

Indicates the maximum number of children allowed in the room.

area

object

views

array of strings | null

Room view details.

views

type

string | null

rates

array of objects | null

rates

object

string | null

Id of the rate.

code

string | null

availability

int64

Indicates the units of this rate available.

description

string | null

Description .

needsPriceCheck

boolean

Indicates if the price check is needed for this rate. It is used for internal purposes only.

isPackageRate

boolean | null

Indicates whether this is a package rate.

providerId

string | null

Indicates the provider id .

providerName

string | null

Indicates the provider name .

isContractedRate

boolean

occupancies

array of objects | null

Detail about the occupancy info .

occupancies

object

roomId

string | null

Id of the room object.

stdRoomId

string | null

Id of the standardized room object.It is available in the response only when room mapping is enabled.

numOfAdults

int32

Number of adults in the room.

numOfChildren

int32

Number of children in the room.

childAges

array of int32s | null

Ages of the children in the room.

childAges

type

string

Published Negotiated

baseRate

double

Base amount .

totalRate

double

Total amount .

minSellingRate

double

publishedRate

double

Published total amount .

currency

string | null

Currency .

publishedRateProviderId

string | null

Indicates the provider id of the published rate.

publishedRateProviderName

string | null

Indicates the provider name of the published rate.

taxes

array of objects | null

Tax info

taxes

object

amount

double

description

string | null

type

string | null

isIncludedInBaseRate

boolean

fees

array of objects | null

Fee info

fees

object

amount

double

description

string | null

type

string | null

isIncludedInBaseRate

boolean

discounts

array of objects | null

Discount info

discounts

object

amount

double

description

string | null

type

string | null

isIncludedInBaseRate

boolean

commission

object

dailyRates

array of objects | null

Daily rates info

dailyRates

object

amount

double

date

date-time

taxIncluded

boolean

discount

double

refundable

boolean

deprecated

refundability

string

Refundable NonRefundable Unknown

allGuestsInfoRequired

boolean

Indicates if all guest info is required for booking.

onlineCancellable

boolean

specialRequestSupported

boolean

documentOptions

array of strings | null

documentOptions

payAtHotel

boolean | null

Indicates whether the payment for the booking will be made directly at the hotel.

cardRequired

boolean | null

Indicates whether the payment info is required.

policies

array of objects | null

Policy details.

policies

object

type

string | null

text

string | null

boardBasis

object

offers

array of objects | null

offers

object

title

string | null

description

string | null

type

string

FixedDiscount PercentageDiscount StayOffer

discountOffer

double | null

percentageDiscountOffer

int64 | null

stayOffer

object

cancellationPolicies

array of objects | null

Cancellation policy info.

cancellationPolicies

object

text

string | null

rules

array of objects | null

rules

object

value

double

valueType

string

Amount Percentage Nights

estimatedValue

double

start

date-time

end

date-time

includes

array of strings | null

Inclusions provided by the hotel.

includes

additionalCharges

array of objects | null

Additional charges details.

additionalCharges

object

charge

object

text

string | null

depositRequired

boolean

depositAmount

double | null

guaranteeRequired

boolean

allowedCreditCards

array of objects | null

allowedCreditCards

object

type

string | null

code

string | null

processingCountry

string | null

allowedCountries

array of objects | null

allowedCountries

object

code

string | null

name

string | null

states

array of objects | null

states

object

code

string | null

name

string | null

otherRateComponents

array of objects | null

Provides information about any additional rate component that is part of the total rate.

otherRateComponents

object

amount

double

description

string | null

type

string | null

isIncludedInBaseRate

boolean

distributionType

string

Unknown Public Private MinimumSellingPrice Optimized Corporate

distributionChannel

string

Any Website AgentTool Mobile MetaSearch Cache

supplierBookingPaymentDate

string | null

publishedBaseRate

double

Publish baseRate provided by the hotel.

IsPassportMandatory

boolean

IsPANMandatory

boolean

providerHotelId

string | null

otherProviderRates

array of objects | null

otherProviderRates

object

amount

double

description

string | null

type

string | null

isIncludedInBaseRate

boolean

rateIdentifier

string | null

additionalInformation

array of objects | null

Additional information.

additionalInformation

object

type

string | null

text

string | null

isChildConvertedToAdult

boolean

Indicates whether any child pax provided in the search request is being treated as adult on the supplier end.

supplierRateWithRevenueComponents

double | null

traderInformation

object

deposits

array of objects | null

deposits

object

amount

double

dueDate

string | null

currency

string | null

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://nexus.prod.zentrumhub.com/api/hotel/availability \
3
     --header 'accept: application/json' \
4
     --header 'accountId: zentrum-demo-account' \
5
     --header 'apiKey: 4477a62d-2bb6-4392-896a-3f5270962dbc' \
6
     --header 'content-type: application/*+json'

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200Success

400ClientSideError