flowground for Business Customers

Technical Specifications

startFlow

OnInit
./lib/triggers/startFlow.js
OnStartup
-
OnClose
-

Attributes

-

Hotels_GetHotels

Load the details about all the hotels your application has access to.

OnInit
./lib/actions/Hotels_GetHotels.js
OnStartup
-
OnClose
-

Attributes

-

Hotels_GetHotel

Load the details about the specified hotel.

OnInit
./lib/actions/Hotels_GetHotel.js
OnStartup
-
OnClose
-

Attributes

-

Codes_GetCodes

With this call you can find codes for a hotel by type or code. By default and without any filter criteria defined it will return you all available codes.

OnInit
./lib/actions/Codes_GetCodes.js
OnStartup
-
OnClose
-

Attributes

-

Codes_GetCode

Read the details about a specific code available for the defined hotel.

OnInit
./lib/actions/Codes_GetCode.js
OnStartup
-
OnClose
-

Attributes

-

RatePlans_GetRateplans

With this call you can find rateplans for a hotel by different filters. By default and without any filter criteria defined it will return you all active rateplans.

OnInit
./lib/actions/RatePlans_GetRateplans.js
OnStartup
-
OnClose
-

Attributes

-

RatePlans_GetRateplansCount

OnInit
./lib/actions/RatePlans_GetRateplansCount.js
OnStartup
-
OnClose
-

Attributes

-

RatePlans_BatchUpdateRates

Currently this call only allows to set the base price for non-derived rateplans if the rateplan is active and already loaded for the specified time period.

A request example:

[
{
"rateplan": "STDN01", "from": "2018-01-01", "to": "2018-01-30", "base_price": 120.00
}
]

For more details on how the API responds to errors please check our documentation on Error Handling.

OnInit
./lib/actions/RatePlans_BatchUpdateRates.js
OnStartup
-
OnClose
-

Attributes

-

RatePlans_GetRateplan

Read the details about a specific rateplan for the defined hotel.

OnInit
./lib/actions/RatePlans_GetRateplan.js
OnStartup
-
OnClose
-

Attributes

-

RatePlans_GetRates

With this call you can read the daily rates setup including the cancellation policy and minimum guarantee per day for the specified rateplan. You can specify a timeperiod to read the daily rates for. The rateplan needs to be active for at least one business day in the defined time period and have rates loaded.

OnInit
./lib/actions/RatePlans_GetRates.js
OnStartup
-
OnClose
-

Attributes

-

RatePlans_PatchRates

The hetras API is using this Patch Specification to partially update an existing resource. Currently this call only allows to set the base price for non-derived rateplans if the rateplan is active and already loaded for the specified time period.

A request example:

[
{
"op": "replace", "path": "/base_price", "value": 120.00
}
]

For more details on how the API responds to errors please check our documentation on Error Handling.

OnInit
./lib/actions/RatePlans_PatchRates.js
OnStartup
-
OnClose
-

Attributes

-

RatePlans_GetRatesCount

OnInit
./lib/actions/RatePlans_GetRatesCount.js
OnStartup
-
OnClose
-

Attributes

-

RatePlans_GetRate

Read the setup of the daily rate for the defined rateplan for that specific business day.

OnInit
./lib/actions/RatePlans_GetRate.js
OnStartup
-
OnClose
-

Attributes

-

RatePlans_PatchRate

The hetras API is using this Patch Specification to partially update an existing resource. Currently this call only allows to set the base price for non-derived rateplans if the rateplan is active and already loaded for the specified business day.

A request example:

[
{
"op": "replace", "path": "/base_price", "value": 120.00
}
]

For more details on how the API responds to errors please check our documentation on Error Handling.

OnInit
./lib/actions/RatePlans_PatchRate.js
OnStartup
-
OnClose
-

Attributes

-

RoomTypes_GetRoomTypes

With this call you can load the details about a all available room types for the specified hotel.

OnInit
./lib/actions/RoomTypes_GetRoomTypes.js
OnStartup
-
OnClose
-

Attributes

-

RoomTypes_GetRoomType

With this call you can load the details about a specific room type in the hotel.

OnInit
./lib/actions/RoomTypes_GetRoomType.js
OnStartup
-
OnClose
-

Attributes

-

Rooms_GetRooms

Find all rooms for the hotel that match the specified filter criteria. The filtering will be done based on the current state of the rooms.

OnInit
./lib/actions/Rooms_GetRooms.js
OnStartup
-
OnClose
-

Attributes

-

Rooms_GetRoomsCount

OnInit
./lib/actions/Rooms_GetRoomsCount.js
OnStartup
-
OnClose
-

Attributes

-

Rooms_GetAvailableRooms

OnInit
./lib/actions/Rooms_GetAvailableRooms.js
OnStartup
-
OnClose
-

Attributes

-

Rooms_GetRoom

With this call you can load the details about a specific room in the hotel. It will show you the current status of the room.

OnInit
./lib/actions/Rooms_GetRoom.js
OnStartup
-
OnClose
-

Attributes

-

Rooms_PatchRoom

The hetras API is using this Patch Specification to partially update an existing resource. Currently this call only allows to modify condition and housekeeping occupancy status of the room.

A request example:

[
{
"op": "replace", "path": "/status/condition", "value": "CleanNotInspected"
}, {
"op": "replace", "path": "/status/housekeeping_occupancy", "value": "Vacant"
}
]

For more details on how the API responds to errors please check our documentation on Error Handling.

OnInit
./lib/actions/Rooms_PatchRoom.js
OnStartup
-
OnClose
-

Attributes

-

YieldableRates_SavePrices

Saves Yieldable Rate Prices for existing Yieldable Rateplan. The rateplan has been created before and with this End Point we create or update the rate prices. If the Yieldable rateplan prices exist it updates them with the new price if not it creates new price entries.
For more details on how the API responds to errors please check our documentation on Error Handling.

OnInit
./lib/actions/YieldableRates_SavePrices.js
OnStartup
-
OnClose
-

Attributes

-

No data available for terms

No data available for environment