v1

latestSwagger 2.02026-07-141993129.2 KB
Blocks

Gets a list of blocks.

With this endpoint you can request a list of blocks for the hotel chain. Currently we only support to optionally filter by the group code linked to the block. Additional filters will be available soon.

get/api/booking/v0/blocks

Query parameters

hotelIdinteger

Only return blocks for this specific hotel.

groupCodestring

Filter the blocks by the specified group code

fromstring date-time

Return all blocks where the block's last_departure is greater than specified date.

tostring date-time

Return all blocks where the block's last_departure is less than specified date.

status'Cancelled' | 'Tentative' | 'Definite'

Return all blocks where the block status is one of the specified values.

ratePlanCodesstring[]

Return all blocks that have related the specified comma-separated rate plans.

countDetailsboolean

If true it will include also details of block count per each room type.

skipinteger

Amount of items to skip.

topinteger

Amount of items to select.

inlinecount'None' | 'AllPages'

Return total number of items for a given filter criteria.

Headers

App-Idstring required

Application identifier

App-Keystring required

Application key.

Request body

CanBeCanceledboolean
IsCancellationRequestedboolean

Response

Returns a list of blocks matching the provided filter criteria.

Object required