API docs by Redocly

UNIFIED API (1.0)

Download OpenAPI specification:

Agustín Ramos Peruzzo: agustin@hotelgest.com URL: https://hotelgest.com License: Proprietary

The UNIFIED API documentation

Bookings

Get bookings V2 search by pcode

Retrieve bookings based on a specific pcode

Authorizations:
ApiKey-auth
path Parameters
pcode
required
number
query Parameters
value
string
roomTypeId
number
status
string
Enum: "ready" "tentative" "cancelled" "no-show"
offset
number
end
string
Example: end=YYYY-MM-DD
start
string
Example: start=YYYY-MM-DD
header Parameters
x-api-key
required
string

API Key for accessing this endpoint

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 10
}

Get bookings V2 only single search by pcode

Retrieve bookings based on a specific pcode and not groups

Authorizations:
ApiKey-auth
path Parameters
pcode
required
number
query Parameters
value
string
roomTypeId
number
status
string
Enum: "ready" "tentative" "cancelled" "no-show"
offset
number
end
string
Example: end=YYYY-MM-DD
start
string
Example: start=YYYY-MM-DD
header Parameters
x-api-key
required
string

API Key for accessing this endpoint

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 10
}

Get bookings V2 only groups search by pcode

Retrieve bookings based on a specific pcode and only groups

Authorizations:
ApiKey-auth
path Parameters
pcode
required
number
query Parameters
value
string
roomTypeId
number
status
string
Enum: "ready" "tentative" "cancelled" "no-show"
offset
number
end
string
Example: end=YYYY-MM-DD
start
string
Example: start=YYYY-MM-DD
header Parameters
x-api-key
required
string

API Key for accessing this endpoint

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 10
}

Get booking details

Retrieve detailed information about a specific booking

Authorizations:
ApiKey-auth
path Parameters
pcode
required
number
bookingId
required
number
header Parameters
x-api-key
required
string

API Key for accessing this endpoint

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "pcode": 123456,
  • "groupId": 1,
  • "groupPrice": 200,
  • "groupQuantity": 2,
  • "start": "2025-10-01",
  • "end": "2025-10-05",
  • "arrivalHour": "14:00",
  • "departureHour": "12:00",
  • "nights": 4,
  • "appUrl": "https://example.com/booking/123",
  • "createdAt": "2025-09-30",
  • "resource": "Room 101",
  • "price": 100,
  • "paid": 100,
  • "totalExtras": 20,
  • "locked": false,
  • "color": "#FF5733",
  • "imported": false,
  • "board": "nb",
  • "policy": "4",
  • "room": {
    },
  • "locator": "string",
  • "customer": {
    },
  • "companyId": 0,
  • "notes": {
    },
  • "occupancy": {
    },
  • "groupOccupancy": {
    },
  • "otaId": 0,
  • "checkInStatus": "string",
  • "bookingStatus": "string",
  • "releaseDateTentative": "2025-10-01",
  • "virtualPayment": {
    },
  • "paymentStatus": "no-paid",
  • "bookingType": {
    },
  • "toDos": {
    },
  • "guests": [
    ],
  • "isSaleDirect": true,
  • "housekeeping": {
    }
}

Add booking V5

Authorizations:
ApiKey-auth
path Parameters
pcode
required
number
header Parameters
x-api-key
required
string

API Key for accessing this endpoint

Request Body schema: application/json
required
required
object

Booking dates

required
object

Host information

required
Array of objects (Room)

Rooms information

required
object

Settings information

required
Array of objects (Product)

Products information

groupId
number

Group ID

Responses

Request samples

Content type
application/json
{
  • "date": {
    },
  • "host": {
    },
  • "rooms": [
    ],
  • "settings": {
    },
  • "products": [
    ],
  • "groupId": 123
}

Get booking payments

Retrieve payments for a specific booking

Authorizations:
ApiKey-auth
path Parameters
pcode
required
number
bookingId
required
number
header Parameters
x-api-key
required
string

API Key for accessing this endpoint

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get booking invoices

Retrieve invoices for a specific booking

Authorizations:
ApiKey-auth
path Parameters
pcode
required
number
bookingId
required
number
header Parameters
x-api-key
required
string

API Key for accessing this endpoint

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get booking proformas

Retrieve proformas for a specific booking

Authorizations:
ApiKey-auth
path Parameters
pcode
required
number
bookingId
required
number
header Parameters
x-api-key
required
string

API Key for accessing this endpoint

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get booking deposits

Retrieve deposits for a specific booking

Authorizations:
ApiKey-auth
path Parameters
pcode
required
number
bookingId
required
number
header Parameters
x-api-key
required
string

API Key for accessing this endpoint

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Rooms

Get rooms availability V2

Authorizations:
ApiKey-auth
path Parameters
pcode
required
number
query Parameters
bookingId
required
number
header Parameters
x-api-key
required
string

API Key for accessing this endpoint

Responses

Response samples

Content type
application/json
{
  • "availables": {
    },
  • "notAvailables": {
    }
}

Get rooms types by pcode

Authorizations:
ApiKey-auth
path Parameters
pcode
required
number
header Parameters
x-api-key
required
string

API Key for accessing this endpoint

Responses

Response samples

Content type
application/json
{
  • "101": {
    }
}

Miscs

Get otas

Authorizations:
ApiKey-auth
header Parameters
x-api-key
required
string

API Key for accessing this endpoint

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Image

Get image from customer

Authorizations:
ApiKey-auth
path Parameters
pcode
required
number
hash
required
string
header Parameters
x-api-key
required
string

API Key for accessing this endpoint

Responses

Webhooks

Get all webhooks

Authorizations:
ApiKey-auth
path Parameters
pcode
required
number
header Parameters
x-api-key
required
string

API Key for accessing this endpoint

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add webhook

Authorizations:
ApiKey-auth
path Parameters
pcode
required
number
header Parameters
x-api-key
required
string

API Key for accessing this endpoint

Request Body schema: application/json
required
name
required
string

Name

url
required
string

Url

eventTypes
required
Array of strings
Items Value: "bookings-added"

List of event types

required
object

Authentication details

Responses

Request samples

Content type
application/json
{
  • "name": "My Webhook",
  • "url": "https://mywebhook.com",
  • "eventTypes": [
    ],
  • "authentication": {
    }
}

Update webhook

Authorizations:
ApiKey-auth
path Parameters
pcode
required
number
header Parameters
x-api-key
required
string

API Key for accessing this endpoint

Request Body schema: application/json
required
name
required
string

Name

url
required
string

Url

eventTypes
required
Array of strings
Items Value: "bookings-added"

List of event types

required
object

Authentication details

id
required
string

Webhook ID

Responses

Request samples

Content type
application/json
{
  • "name": "My Webhook",
  • "url": "https://mywebhook.com",
  • "eventTypes": [
    ],
  • "authentication": {
    },
  • "id": "60d21b4667d0d8992e610c85"
}

Delete webhook

Authorizations:
ApiKey-auth
path Parameters
pcode
required
number
id
required
string
header Parameters
x-api-key
required
string

API Key for accessing this endpoint

Responses

Set webhook available

Authorizations:
ApiKey-auth
path Parameters
pcode
required
number
id
required
string
header Parameters
x-api-key
required
string

API Key for accessing this endpoint

Responses

Set webhook unavailable

Authorizations:
ApiKey-auth
path Parameters
pcode
required
number
id
required
string
header Parameters
x-api-key
required
string

API Key for accessing this endpoint

Responses

Test webhook

Authorizations:
ApiKey-auth
path Parameters
pcode
required
number
header Parameters
x-api-key
required
string

API Key for accessing this endpoint

Request Body schema: application/json
required
id
required
string

Webhook ID

eventType
required
string
Value: "bookings-added"

Webhook Event Type

Responses

Request samples

Content type
application/json
{
  • "id": "60d21b4667d0d8992e610c85",
  • "eventType": "bookings-added"
}

Response samples

Content type
application/json
{
  • "pcode": 123456,
  • "webhookId": "wh_789",
  • "url": "https://myapp.com/webhooks",
  • "eventType": "bookings-added",
  • "payload": {
    },
  • "statusCode": 200,
  • "errorMessage": "Endpoint unreachable",
  • "durationMs": 87
}

Get webhook logs by id

Authorizations:
ApiKey-auth
path Parameters
pcode
required
number
id
required
string
header Parameters
x-api-key
required
string

API Key for accessing this endpoint

Responses

Response samples

Content type
application/json
[
  • {
    }
]