# hetras Booking API Version 0 API

> hetras Booking API Version 0 API on Apizie: 19 endpoints (Get a list of offers for addon services for the specified guest stay details., Gets the availability and occupancy for a specific hotel and timespan., Gets a list of blocks., Get total blocks count that match the given filter criteria., …) returned as clean JSON through one API key. 19 endpoints are live now. Call it over REST at https://zieapi.vercel.app/v1/open-data:hetras-certification-booking/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `open-data:hetras-certification-booking`
- Category: Open Data
- Status: live
- Source: https://hetras-certification.net
- Page: https://zieapi.vercel.app/api/open-data/hetras-certification-booking
- OpenAPI: https://zieapi.vercel.app/api/open-data/hetras-certification-booking/openapi.json



## Endpoints

### Get a list of offers for addon services for the specified guest stay details.
`GET https://zieapi.vercel.app/v1/open-data:hetras-certification-booking/addons-get`

| Parameter | Type | Required | Description |
|---|---|---|---|
| App-Id | string | yes | Application identifier |
| App-Key | string | yes | Application key. |
| hotelId | integer | yes | Specifies the hotel id to request offers for. |
| arrivalDate | string | yes | Date from when the addon service will be booked to the reservation in the ISO-8601 format "YYYY-MM-DD". |
| departureDate | string | yes | Date until when the addon service will be booked to the reservation in the ISO-8601 format "YYYY-MM-DD". This is usually the departure… |
| channelCode | string | yes | Channel Code the rate plan needs to be configured for. |
| adults | string | yes | Number of adults per room. |
| rooms | string | yes | Number of rooms. |
| roomType | string | yes | Only return offers for the specified room type code. |
| ratePlanCode | string | yes | Only return offers for the specified rate plan code. |
| expand | string | no | Expand the rates breakdown if required. |

### Gets the availability and occupancy for a specific hotel and timespan.
`GET https://zieapi.vercel.app/v1/open-data:hetras-certification-booking/availability-get`

| Parameter | Type | Required | Description |
|---|---|---|---|
| App-Id | string | yes | Application identifier |
| App-Key | string | yes | Application key. |
| hotelId | integer | yes | Specifies the hotel id to request the availability for. |
| from | string | yes | Defines the first business day you would like to get availability numbers for. |
| to | string | yes | Defines the last business day you would like to get availability numbers for. The maximum time span between from ´and to is limited to 365… |
| expand | string | no | You can expand the room types breakdown per business day for the availibility numbers if need be. |
| skip | integer | no | Amount of items to skip. |
| top | integer | no | Amount of items to select. |
| inlinecount | string | no | Return total number of items for a given filter criteria. |

### Gets a list of blocks.
`GET https://zieapi.vercel.app/v1/open-data:hetras-certification-booking/blocks-get-blocks-async`

| Parameter | Type | Required | Description |
|---|---|---|---|
| App-Id | string | yes | Application identifier |
| App-Key | string | yes | Application key. |
| hotelId | integer | no | Only return blocks for this specific hotel. |
| groupCode | string | no | Filter the blocks by the specified group code |
| from | string | no | Return all blocks where the block's last_departure is greater than specified date. |
| to | string | no | Return all blocks where the block's last_departure is less than specified date. |
| status | string | no | Return all blocks where the block status is one of the specified values. |
| ratePlanCodes | array | no | Return all blocks that have related the specified comma-separated rate plans. |
| countDetails | boolean | no | If true it will include also details of block count per each room type. |
| skip | integer | no | Amount of items to skip. |
| top | integer | no | Amount of items to select. |
| inlinecount | string | no | Return total number of items for a given filter criteria. |

### Get total blocks count that match the given filter criteria.
`GET https://zieapi.vercel.app/v1/open-data:hetras-certification-booking/blocks-get-blocks-count-async`

| Parameter | Type | Required | Description |
|---|---|---|---|
| App-Id | string | yes | Application identifier |
| App-Key | string | yes | Application key. |
| hotelId | integer | no | Only return blocks for this specific hotel. |
| groupCode | string | no | Filter the blocks by the specified group code |
| from | string | no | Return all blocks where the block's last_departure is greater than specified date. |
| to | string | no | Return all blocks where the block's last_departure is less than specified date. |
| status | string | no | Return all blocks where the block status is one of the specified values. |
| ratePlanCodes | array | no | Return all blocks that have related the specified comma-separated rate plans. |
| countDetails | boolean | no | If true it will include also details of block count per each room type. |

### Gets the details for a specific block.
`GET https://zieapi.vercel.app/v1/open-data:hetras-certification-booking/blocks-get-single-block-async`

| Parameter | Type | Required | Description |
|---|---|---|---|
| App-Id | string | yes | Application identifier |
| App-Key | string | yes | Application key. |
| blockCode | string | yes | Specifies the block code. The block code is composed of the hotel code, a dash and the block code as shown in the hetras UI. |

### Find bookings matching the given filter criteria.
`GET https://zieapi.vercel.app/v1/open-data:hetras-certification-booking/bookings-get-bookings`

| Parameter | Type | Required | Description |
|---|---|---|---|
| App-Id | string | yes | Application identifier |
| App-Key | string | yes | Application key. |
| hotelId | integer | no | Only return bookings for this specific hotel. |
| cancellationId | string | no | Return bookings for this cancellation id. |
| reservationNumber | integer | no | Return bookings matching this reservation number. Please note that reservation numbers are only unique within a hotel. If you don´t… |
| customerName | string | no | Return all bookings where the first or lastname of one of the guests or the contact contains the specified value. The search is executed… |
| customerEmail | string | no | Return all bookings where the primary email address of one of the guests or the contact contains the specified value. The search is… |
| customerId | string | no | Return all bookings the id of one of the guests or the contact matches the specified value. |
| roomNumber | string | no | Return all bookings having the specified room number assigned. |
| externalId | string | no | Return all bookings exactly matching the specified external id. This filter is case sensitive. |
| companyName | string | no | Return all bookings where the name of the linked company or travel agent profile contains the specified value. The search is executed case… |
| companyId | string | no | Return all bookings the id of the company or travel agent profile matches the specified value. |
| companyEmail | string | no | Return all bookings where the primary email address of the company or the travel agent profile contains the specified value. The search is… |
| blockCode | string | no | Return all bookings where the block code matches the specified value. |
| reservationStatuses | array | no | Return all bookings where the reservation status is one of the specified values. |
| marketCodes | array | no | Return all bookings where the market code is one of the specified values. |
| channelCodes | array | no | Return all bookings where the channel code is one of the specified values. |
| subChannelCodes | array | no | Return all bookings where the subchannel code is one of the specified values. |
| roomTypes | array | no | Return all bookings where the room type is one of the specified values. |
| ratePlanCodes | array | no | Return all bookings where the rate plan code is one of the specified values. |
| labels | array | no | Return all reservations with at least one of the specified labels. |
| from | string | no | Start date for the selected date filter. If you select arrival date as date filter the bookings returned will have at least one… |
| to | string | no | End date for the selected date filter. If you select arrival date as date filter the bookings returned will have at least one reservation… |
| dateFilter | string | no | Select a date field you want to filter bookings by. Only one filter at a time can be applied. The to and from dates will then define the… |
| exclude | string | no | To be able to request reservations without personal data based on GDPR. |
| skip | integer | no | Amount of items to skip. |
| top | integer | no | Amount of items to select. |
| inlinecount | string | no | Return total number of items for a given filter criteria. |

### Create a new booking.
`POST https://zieapi.vercel.app/v1/open-data:hetras-certification-booking/bookings-create-booking`

| Parameter | Type | Required | Description |
|---|---|---|---|
| App-Id | string | yes | Application identifier |
| App-Key | string | yes | Application key. |
| sendConfirmation | boolean | no | Whether to send a confirmation email to the primary guest |
| body | object | yes | JSON request body |

### Get total count of bookings matchung the given filter criteria.
`GET https://zieapi.vercel.app/v1/open-data:hetras-certification-booking/bookings-get-bookings-count`

| Parameter | Type | Required | Description |
|---|---|---|---|
| App-Id | string | yes | Application identifier |
| App-Key | string | yes | Application key. |
| hotelId | integer | no | Only return bookings for this specific hotel. |
| cancellationId | string | no | Return bookings for this cancellation id. |
| reservationNumber | integer | no | Return bookings matching this reservation number. Please note that reservation numbers are only unique within a hotel. If you don´t… |
| customerName | string | no | Return all bookings where the first or lastname of one of the guests or the contact contains the specified value. The search is executed… |
| customerEmail | string | no | Return all bookings where the primary email address of one of the guests or the contact contains the specified value. The search is… |
| customerId | string | no | Return all bookings the id of one of the guests or the contact matches the specified value. |
| roomNumber | string | no | Return all bookings having the specified room number assigned. |
| externalId | string | no | Return all bookings exactly matching the specified external id. This filter is case sensitive. |
| companyName | string | no | Return all bookings where the name of the linked company or travel agent profile contains the specified value. The search is executed case… |
| companyId | string | no | Return all bookings the id of the company or travel agent profile matches the specified value. |
| companyEmail | string | no | Return all bookings where the primary email address of the company or the travel agent profile contains the specified value. The search is… |
| blockCode | string | no | Return all bookings where the block code matches the specified value. |
| reservationStatuses | array | no | Return all bookings where the reservation status is one of the specified values. |
| marketCodes | array | no | Return all bookings where the market code is one of the specified values. |
| channelCodes | array | no | Return all bookings where the channel code is one of the specified values. |
| subChannelCodes | array | no | Return all bookings where the subchannel code is one of the specified values. |
| roomTypes | array | no | Return all bookings where the room type is one of the specified values. |
| ratePlanCodes | array | no | Return all bookings where the rate plan code is one of the specified values. |
| labels | array | no | Return all reservations with at least one of the specified labels. |
| from | string | no | Start date for the selected date filter. If you select arrival date as date filter the bookings returned will have at least one… |
| to | string | no | End date for the selected date filter. If you select arrival date as date filter the bookings returned will have at least one reservation… |
| dateFilter | string | no | Select a date field you want to filter bookings by. Only one filter at a time can be applied. The to and from dates will then define the… |
| exclude | string | no | To be able to request reservations without personal data based on GDPR. |

### Load all reservations for one booking by confirmation id.
`GET https://zieapi.vercel.app/v1/open-data:hetras-certification-booking/bookings-get-booking`

| Parameter | Type | Required | Description |
|---|---|---|---|
| App-Id | string | yes | Application identifier |
| App-Key | string | yes | Application key. |
| confirmationId | string | yes | The confirmation id for the booking to load. |
| expand | string | no | Specifies the expand type. |
| exclude | string | no | Specifies the exclude type. |

### Load a specific reservation from a booking.
`GET https://zieapi.vercel.app/v1/open-data:hetras-certification-booking/bookings-get-reservation`

| Parameter | Type | Required | Description |
|---|---|---|---|
| App-Id | string | yes | Application identifier |
| App-Key | string | yes | Application key. |
| confirmationId | string | yes | The confirmation id for the booking the reservation was made. |
| reservationNumber | integer | yes | Specifies the reservation number for the reservation to load. |
| expand | string | no | Specifies the expand type. |
| exclude | string | no | Specifies the exclude type. |

### Partially updates a reservation.
`POST https://zieapi.vercel.app/v1/open-data:hetras-certification-booking/bookings-patch`

| Parameter | Type | Required | Description |
|---|---|---|---|
| App-Id | string | yes | Application identifier |
| App-Key | string | yes | Application key. |
| confirmationId | string | yes | The confirmation id for the booking the reservation was made. |
| reservationNumber | integer | yes | Specifies the reservation number for the reservation that has to be updated. |
| body | object | yes | JSON request body |

### Assign a room to a reservation.
`POST https://zieapi.vercel.app/v1/open-data:hetras-certification-booking/bookings-post-room-assignment`

| Parameter | Type | Required | Description |
|---|---|---|---|
| App-Id | string | yes | Application identifier |
| App-Key | string | yes | Application key. |
| confirmationId | string | yes | The confirmation id for the booking the reservation was made. |
| reservationNumber | integer | yes | Specifies the reservation number for the reservation the room should be assigned to. |
| body | object | no | JSON request body |

### Cancel one reservation.
`POST https://zieapi.vercel.app/v1/open-data:hetras-certification-booking/bookings-cancel-reservation`

| Parameter | Type | Required | Description |
|---|---|---|---|
| App-Id | string | yes | Application identifier |
| App-Key | string | yes | Application key. |
| confirmationId | string | yes | The confirmation id for the booking the reservation was made. |
| reservationNumber | integer | yes | Specifies the reservation number for the reservation to cancel. |
| sendConfirmation | boolean | no | Whether to send a confirmation email to the primary guest |

### Performs a check in operation for a reservation.
`POST https://zieapi.vercel.app/v1/open-data:hetras-certification-booking/bookings-check-in`

| Parameter | Type | Required | Description |
|---|---|---|---|
| App-Id | string | yes | Application identifier |
| App-Key | string | yes | Application key. |
| confirmationId | string | yes | The confirmation id for the booking the reservation was made. |
| reservationNumber | integer | yes | Specifies the reservation number for the reservation to be checked in. |
| body | object | yes | JSON request body |

### Performs a check out operation for a reservation.
`POST https://zieapi.vercel.app/v1/open-data:hetras-certification-booking/bookings-check-out`

| Parameter | Type | Required | Description |
|---|---|---|---|
| App-Id | string | yes | Application identifier |
| App-Key | string | yes | Application key. |
| confirmationId | string | yes | The confirmation id for the booking the reservation was made. |
| reservationNumber | integer | yes | Specifies the reservation number for the reservation to be checked out. |

### Post a payment token for a reservation.
`POST https://zieapi.vercel.app/v1/open-data:hetras-certification-booking/bookings-payment-token`

| Parameter | Type | Required | Description |
|---|---|---|---|
| App-Id | string | yes | Application identifier |
| App-Key | string | yes | Application key. |
| confirmationId | string | yes | The confirmation id for the booking the reservation was made. |
| reservationNumber | integer | yes | Specifies the reservation number for the reservation to be checked in. |
| body | object | yes | JSON request body |

### Performs a chip and pin credit card authorization for a reservation.
`POST https://zieapi.vercel.app/v1/open-data:hetras-certification-booking/bookings-terminal-authorization`

| Parameter | Type | Required | Description |
|---|---|---|---|
| App-Id | string | yes | Application identifier |
| App-Key | string | yes | Application key. |
| confirmationId | string | yes | The confirmation id for the booking the reservation was made. |
| reservationNumber | integer | yes | Specifies the reservation number for the reservation to be checked in. |
| body | object | yes | JSON request body |

### Get a list of daily rates given a hotel Id, a channel code and a date range.
`GET https://zieapi.vercel.app/v1/open-data:hetras-certification-booking/daily-rates-get-daily-rates`

| Parameter | Type | Required | Description |
|---|---|---|---|
| App-Id | string | yes | Application identifier |
| App-Key | string | yes | Application key. |
| hotelId | integer | yes | Define the hotel id to request the availability for. |
| from | string | yes | Define the first business day you would like to get availability numbers for. The day should not be in the past. |
| to | string | yes | Define the last business day you would like to get rates for (inclusive). The maximum time span between 'From' and 'To' is limited to 365… |
| channelCode | string | yes | Define the channel code in order to look up the rates for. |
| expand | array | no | Define the sections you want to expand and get informed about rates for. |
| ratePlanCodes | array | no | Define the codes of rate plans to show in the response. A list of comma ',' separated rate plan codes. |
| skip | integer | no | Amount of items to skip. |
| top | integer | no | Amount of items to select. |
| inlinecount | string | no | Return total number of items for a given filter criteria. |

### Get a list of room offers for the specified guest stay details.
`GET https://zieapi.vercel.app/v1/open-data:hetras-certification-booking/rates-get`

| Parameter | Type | Required | Description |
|---|---|---|---|
| App-Id | string | yes | Application identifier |
| App-Key | string | yes | Application key. |
| hotelId | integer | yes | Specifies the hotel id to request offers for. |
| arrivalDate | string | yes | Date of arrival for the guest in the ISO-8601 format "YYYY-MM-DD". |
| departureDate | string | yes | Date of departure for the guest in the ISO-8601 format "YYYY-MM-DD". |
| channelCode | string | yes | Channel Code the rate plan needs to be configured for. |
| adults | string | yes | Number of adults per room. |
| rooms | string | no | Number of rooms (default is 1). |
| roomType | string | no | Only return offers with rates for the specified room type code. |
| ratePlanCode | string | no | Only return offers for the specified room type code. |
| groupCode | string | no | Only return offers for the specified group code. |
| expand | string | no | Expand the rates breakdown if required. |

## Example
```
curl "https://zieapi.vercel.app/v1/open-data:hetras-certification-booking/addons-get" \
  -H "x-api-key: $APIZIE_KEY"
```

## FAQ

### How do I call the hetras Booking API Version 0 API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/open-data:hetras-certification-booking/addons-get with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the hetras Booking API Version 0 API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card.

### Can AI agents use the hetras Booking API Version 0 API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key open-data:hetras-certification-booking.

### What is the status of the hetras Booking API Version 0 API?
Live: works with just an Apizie key