This message returns a list of establishments based on the parameters set up in the request message.

It is important to keep in mind that only those establishments to which the user has access will be returned.

 

The response will return the list of establishments grouped by vendorCode (group of establishments) and will also include the basic information of each establishment. If more detailed information is required, it will be necessary to launch the hotelInformation message request explained in the following section of the documentation.


Endpoint: https://hotel.new.hotetec.com/webservice/integrations/pull/listHotels 

 


listHotels Request message 

 

The message has the following elements:

 

Element

Mandatory

Values/Format

Description

sessionId

Y

Alphanumeric

Generated session’s ID

languageCode

Y

DE, EN, ES, FR, IT, NL, PT

Language in which we want to receive the response. If not indicated, the value that Hotetec has by default for the user will be returned.

 

ISO 639-1 codes are used. Right know only the codes indicated in values are accepted.

currency

Y

EUR, USD, GBP, EGP, MXN, CHF, CUP

Currency in which we want to receive the prices of the request. If not indicated, the value that Hotetec has by default for the user will be returned.

 

ISO 639-1 codes are used. Right know only the codes indicated in values are accepted.

vendorCode

N

Alphanumeric

Company code of a hotel/establishment set

hotelCode

N

Alphanumeric

Single’s hotel/establishment code

hotelName

N

Alphanumeric

Establishment’s name. A part of the name can be set up and a search will be made for establishments containing these names.

hotelFacilityCode

N

Alphanumeric

Type of facilities of the establishment. Example: PISCINA (SWIMMING POOL)

locationCode

N

Alphanumeric

Geographical area code where the establishment is located.

categoryCode

N

Alphanumeric

Establishment’s category

chainCode

N

Alphanumeric

Chain code

establishmentTypeCode

N

Alphanumeric

Establishment’s type code

roomCode

N

Alphanumeric

Internal room’s code. Internal use

rateCode

N

Alphanumeric

Rate’s code

onlyWithRates

N

 

 

true

false

Indicates if we want to receive only establishments with defined rates. Values:

True / False

 


Example of message with all elements filled out (JSON):

{

    "sessionId": " HPH#20077#682164202862402",

    "languageCode": "ES",

    "currency": "EUR",

    "vendorCode": [“DEMOHTT”],

    "hotelCode": [“45501”],

    "hotelName": “Playa”,

    "hotelFacilityCode": [”PISCINA”],

    "locationCode": ”ESBAL03”,

    "categoryCode": [”5*”],

    "chainCode": [”DEMO”],

    "establishmentTypeCode": [”HOTL”],

    "roomCode": [”DBL#STD”],

    "rateCode": “30006”,

    "onlyWithRates": “false”

}

 


listHotels Response message 

 

The message has the following elements:

 

Element

Description

sessionId

Generated session’s ID

notification

Type of notification.

Error: it’s important to check it immediately in order to solve the issue that is being indicated by the system.

Warning

Information

notificationDetail

Notification’s description

vendorCode

Company code of a hotel/establishment set

 

Hotel

code

Single’s hotel/establishment code

name

Establishment’s full name

chain

Chain to which the establishment belongs

 

establishmentType

code

Establishment’s type code. (Example: HOTL)

name

Establishment’s type description. (Example: Hotel)

 

Category

code

Category’s code (Example: 5*)

name

Category's description. (Example: Five Stars)

 

address – country

code

Country’s code (Example: ES)

name

Country’s description. (Example: España – Spain)

state

Additional typing of the destination tree

county

Establishment’s city

province

Additional typing of the destination tree

 

address – location

code

Geographical area’s code

name

Geographical area’s description

postalCode

Establishment’s postcode

adressText

Establishment’s postal address

 

address – gps

latitude

Latitude

longitude

Longitude

 

contact

Establishment’s contact details

 

Example message (JSON):

{   

"sessionId": "HPH#20077#280227446359930",

    "notification": null,

    "notificationDetail": null,

    "hotelsByVendor": [

        {

            "vendorCode": "DEMOHTT",

            "hotel": [

                {

                    "code": "30621",

                    "name": "Boutique Hotel Elena",

                    "chain": null,

                    "establishmentType": {

                        "code": "HOTL",

                        "name": "Hotel"

                    },

                    "category": {

                        "code": "4*",

                        "name": "Cuatro estrellas"

                    },

                    "address": {

                        "country": {

                            "code": "ES",

                            "name": "ESPAÑA"

                        },

                        "state": null,

                        "county": "Adeje",

                        "province": null,

                        "location": {

                            "code": "ES-48245",

                            "name": "Adeje"

                        },

                        "postalCode": "38670",

                        "addressText": "Av. Adeje",

                        "gps": {

                            "latitude": 28.15039046107699,

                            "longitude": -16.44536361524011

                        }

                    },

                    "contact": null

 }