Booking management

Booking management

Table of contents:

  • Introduction

  • Use cases

  • Methods available

  • Table of parameters

  • Examples:

  • Petition (POST)


Introduction:

In this article we talk about API requests related to Bookings.

  • Processing a booking:

    • The endpoint is responsible for verifying the creation/update of the reservation in question, as well as the stays, associated contacts.

    • It is necessary that the apiuser have permission."Bookings" to use this endpoint.


The endpoint we use is: https://app.hoteldatahub.io/api/v1/bookings/
The Swagger section is: https://app.hoteldatahub.io/swagger/#/bookings


Use cases:

Create and update a booking with stays and guests information.


Methods available:

Post: https://app.hoteldatahub.io/api/v1/bookings/


Table of parameters:

Booking:

Key

Type

mandatory

Description

hotel_chain

String

Yes

Code of the company.

Provided by HotelDataHub.

external_object_id

String

Yes

External ID of the reservation at HotelDataHub

date

Datetime

Yyyyy-mm-ddthh:mm:ss

Yes

Date of creation

entrance

Date YYYY-MM-DD

Yes

Date of entry

departure

Date YYYY-MM-DD

Yes

Date of departure

localizer

String

Yes

Locator

hotel

Integer

Yes

The hotel identifier.

Provided by HotelDataHub.

agency

String

No

Name of agency

amount

Float

No

Total amount.

currency

String

No

Currency inIso 4217

status

Integer

No

State:

  • Cancelled = 1

  • Confirmed = 2

  • Pending = 3

  • Cancelled = 4

  • No show=5

  • Modified = 6

  • Quote = 7

  • Stay = 8

  • Exit = 9

input_channel

Integer

No

Entrance channel of movement

  • 0 = Telephone

  • 1 = Web

  • 2 = App

  • 3 = Wifi

  • 4 = Pms

  • 5 = Api

  • 6 = Import

  • 7 = Be

  • 8 = chatbot

  • 9 = Concierge

  • 10 = call center

  • 11 = IBE (BE ad-hoc)

  • 12 = Channel Manager

  • 14 = PMS Restaurant

  • 15 = PMS Spa

  • 17 = BE Restaurant

  • 18 = BE Spa

  • 19 = Connector Hub

  • 20 = Digital key platform

  • 21 = Corporate CRM

  • 22 = Social Media Form

regime

String

No

Name of type of regimen

room_type

String

No

Name of room type

fare_type

String

No

Name of rate type

offer

String

No

Name of the offer

event_type

String

No

Name of type of event

package

String

No

Name of the Package

category

String

No

Name of category (segment)

url

String (max. 2048 characters)

No

Allows you to send a URL associated with the reservation.

notes

String (max. 1024 characters)

No

Comments on the reservation

stays

List[Stay]

Yes

See Stay table below


Stay:

Key

Type

mandatory

Description

hotel_chain

String

Yes

Code of the company.

Provided by HotelDataHub.

external_object_id

Integer

Yes

Identifier at HotelDataHub

date

Datetime

Yyyyy-mm-ddthh:mm:ss

Yes

Date of creation

entrance

Date YYYY-MM-DDD

Yes

Date of entry

departure

Date YYYY-MM-DDD

Yes

Date of departure

localizer

String

Yes

Locator

Hotel

Integer

Yes

The hotel identifier.

Provided by HotelDataHub.

agency

String

No

Name of agency

amount

Float

No

Total amount.

currency

String

No

Currency inIso 4217

status

Integer

No

State of the Movement

  • Cancelled = 1

  • Confirmed = 2

  • Pending = 3

  • Cancelled = 4

  • No show=5

  • Modified = 6

  • Quote = 7

  • Stay = 8

  • Exit = 9

room_number

String

No

Room number

adults

Integer

No

Number of adults in the movement

Juniors

Integer

No

Number of Juniors in the Movement

children

Integer

No

Number of children in the movement

babies

Integer

No

Number of babies in movement

regime**

String

No

Name of type of regimen

room_type**

String

No

Name of room type

fare_type**

String

No

Name of rate type

offer**

String

No

Name of the offer.

event_type**

String

No

Name of type of event

package**

String

No

Name of the Package

category**

String

No

Name of category (segment).

url

String (max. 2048 characters)

No

Allows to send a URL associated with the stay

notes

String (max. 1024 characters)

No

Comments on the stay

guests

List[guest]

Yes

View guest table below

** Fields already present in the booking with the same value in the stay can be omitted, thus the stay will infer these values from the booking.


Guest:

Key

Type

mandatory

Description

email

String

Yes

Unique field in the Fideltour DB, used as a guest identifier.

external_object_id

String

No

External identifier of the guest

is_owner

Boolean

No

Indicates whether the main guest of the reservation

name

String

No

Name

surname

String

No

Surnames

phone

String

No

Telephone

birthday

Date YYYY-MM-DDD

No

Date of birth

gender

Integer

No

Gender:

  • 0 = unspecified (default)

  • 1 = man

  • 2 = woman

  • 3 = non-binary

  • 4 = fluid gender

  • 5 = prefer not to say it

address

String

No

Address

post_code

String

No

Postal Code

zone

String

No

Name of the area.

town

String

No

Name of the city.

province

String

No

Name of the province

country

String

No

ISO 3166-1 alpha-2

language

String

No

ISO 639-1 Code

identification_document_type

Numeric

No

Type of identity document.

  • 0 = Other

  • 1 = Dni

  • 2 = Nie

  • 3 = Passport

identification_number

String

No

Number of identity document.

business_name

String

No

Name of the company

work_place

String

No

Business Charge

business_address

String

No

Address of company

fiscal_address

String

No

Fiscal Directorate

notes

String

No

Notes

custom_tags

List of Strings

No

Listing made up of label names

subscribed

Boolean

No

Indicates if the contact is subscribed to commercial communications.

  • True = Subscribed

  • False = Not subscribed (by default)



Examples

Below is an example of reservation processing:

Protocol: http/1.1

Method: Post

Host/ENDPOINT:https://app.hoteldatahub.io/api/v1/contacts/

Headers:

  • Content-type: application/json

  • Authorization: Token xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

  • BODY: an example is added below.


{
"hotel": "2293",
"hotel_chain": "6NOK",
"date": "2025-11-27T10:08:08",
"entry": "2026-10-02",
"Departure": "2026-10-04",
"localizer": "91764088833/6",
"external_object_id": "12345726",
"agency": "Testing company",
Offer: Black Friday.
"Category": "Consumerists"
"amount": 280,
"currency": "EUR",
"input_channel": 4,
"Status": 2,
"stays": [
      {
"entry": "2026-10-02",
"Departure": "2026-10-04",
"localizer": "91764088833/6",
"externa_object_id": "123456112",
"amount": 280,
"currency": "EUR",
"room_number": "0A Double 2 beds",
"room_type": "Double room",
"Regime": "Accommodation",
"Adults": 2,
"Childs": 0,
"Status": 2,
"Guests": [
{
"id": 3183465,
"name": "BETTINA",
"is_owner":true,
"surname": "STROBEL",
"Email": "bettinastrobel@web.de"
"phone": "0049772691980",
"Gender": 2,
"language": "is",
Birthdate: "1990-12-12",
"post_code": "07009",
"Notes": "
"country": "ESP",
"custom_tags": [],
"subscribed": false,
"is_active": true
}
]
}
]
}



    • Related Articles

    • Management of movements

      Movements Table of Contents Introduction Use cases Available methods Table of parameters Examples Petition (POST) Answer (POST) Petition (GET) Answer (GET) Petition (PATCH) Answer (PATCH) Introduction: In this article we talk about API requests ...
    • GDPR consent

      GDPR Consent Introduction: In this article, we talk about API requests related to the mandatory consents of the General Data Protection Regulation (GDPR in English), and how to manage it in our contacts. - Create consents for a contact - List and ...
    • Loyalty

      Loyalty Introduction: In this article we talk about API requests related to the Fideltour Loyalty module. The sections of the Swagger which include this information are: https://app.hoteldatahub.io/swagger/#/contacts ...
    • Other connections

      Other Introduction In the Hotel Data Hub API, several numeric values are required, which serve to identify an item or element in Fideltour's database. We can deduce that if an item does not exist in the database, it must first be created in order to ...
    • Contact management

      Contacts Introduction: In this article we talk about API requests related to Contacts. Create contact Update contact List and filter contacts The endpoint we use is:https://app.hoteldatahub.io/api/v1/contacts/and the Swagger section ...