← Back to catalog

Other

hetras Booking API Version 0

auto-generated
swirls add hetras_certification
actionPOSTv1.0.0

Assign a room to a reservation.

By default this API call assigns a random room, which has the proper room type, is not already assigned to another reservation or has any maintenance status set for the stay period of the underlying reservation. If the arrival date for the underlying reservation is the current business day dirty rooms are excluded by default. For reservation arriving on any latter day the room condition is not taken into account.<br /> By specifiying the room selection criteria in the request body you can influence which room will be assigned. See the request model for further details.<br /> For more details on how the API responds to errors please check our documentation on <a href="https://developer.hetras.com/docs/errors/" onfocus="this.blur()">Error Handling</a>.

Source
actionPOSTv1.0.0

Cancel one reservation.

This request will cancel one specific reservation. It will show up in the hetras UI in the Cancellation and NoShow processing screen and it will be up to the hotel staff to either charge or waive the cancellation fee.<br /> For more details on how the API responds to errors please check our documentation on <a href="https://developer.hetras.com/docs/errors/" onfocus="this.blur()">Error Handling</a>.

Source
actionPOSTv1.0.0

Create a new booking.

Create a new booking as defined in the requests payload. You can get more information about the payload if you check out the documentation for the reservation request model.<br /> Please also have a look at the <a href="https://developer.hetras.com/docs/tutorials" onfocus="this.blur()">Tutorials</a>.<br /> For more details on how the API responds to errors please check our documentation on <a href="https://developer.hetras.com/docs/errors/" onfocus="this.blur()">Error Handling</a>.

Source
actionGETv1.0.0

Find bookings matching the given filter criteria.

Here you can easily find bookings matching various criteria. The booking you are looking for has to fullfill all the specified criteria at the same time. So if you specify a customer name and a channel code you will get all bookings where the firstname or lastname of a guest or a contact contains the specified value and that have been done through the defined channel. A booking can consist of multiple reservations, so even if you are looking for a specific reservation which is part of a multi-room booking you will get all reservations for this booking returned.

Source
actionGETv1.0.0

Get a list of daily rates given a hotel Id, a channel code and a date range.

With the rates request you can get a list of different daily rates. You will have to at least specify the hotel, the channel code, and a calendar range. The channel code will define which rates will be returned based on the access control configuration for the rates. Additionally rate plan codes may be specified in the request in order to limit only those rates of the given plans, if they are not specified, it will return all the public rate plans. If requested the caller may specify whether he wants policies or not.

Source
actionGETv1.0.0

Get a list of room offers for the specified guest stay details.

With the rates request you can get a list of different rate offers per room type. You will have to at least specify the hotel, the arrival and departure date, number of adults per room and the channel code. The channel code will define which rates will be returned based on the access control configuration for the rates.

Source
actionGETv1.0.0

Get total count of bookings matchung the given filter criteria.

Get the count of all bookings matching your criteria. The bookings have to fullfill all the specified criteria at the same time. So if you specify a customer name and a channel code you will get the count for all bookings where the firstname or lastname of a guest or a contact contains the specified value and that have been done through the defined channel.

Source
actionGETv1.0.0

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.

Source
actionGETv1.0.0

Gets the details for a specific block.

Read all informationen about a block including the numbers of blocked rooms per room type and business day.

Source
actionGETv1.0.0

Load all reservations for one booking by confirmation id.

A booking groups all reservations done in one single request and can be identified by the confirmation id. Guests usually use the confirmation id to check in at the kiosk, on the website or mobile device. In hetras all reservations of one booking share the room type, rate plan and number of guests per room.

Source
actionPATCHv1.0.0

Partially updates a reservation.

The hetras API is using this <a href="https://developer.hetras.com/docs/patch" onfocus="this.blur()" target="_blank">Patch Specification</a> to partially update an existing resource. Currently this call allows to update the following fields: external_id, market_code, channel_code, subchannel_code, guarantee_type, comment, addon_services, labels, guests, contact and company. <br /><br /> A request example:<br /><pre> [ { "op": "replace", "path": "/addon_services", "value": ["BREAKFAST", "PARKING"] }, { "op": "add", "path": "/labels/-", "value": "MOBILE" }, { "op": "replace", "path": "/guests/SHOW-1234", "value": { "customer_id": "SHOW-1234", "primary": false } }, { "op": "add", "path": "/guests/-", "value": { "customer_id": "SHOW-5678", "primary": true } } ] </pre><br /> For more details on how the API responds to errors please check our documentation on <a href="https://developer.hetras.com/docs/errors/" onfocus="this.blur()">Error Handling</a>.

Source
actionPOSTv1.0.0

Performs a check in operation for a reservation.

With this call you can set a reservation to the status inhouse. It allows only single room reservations to be checked in. The reservation must have assigned a vacant and clean room.<br /> For more details on how the API responds to errors please check our documentation on <a href="https://developer.hetras.com/docs/errors/" onfocus="this.blur()">Error Handling</a>.

Source
actionPOSTv1.0.0

Performs a check out operation for a reservation.

With this call you can set a reservation to the checkout status. It allows only single room reservations to be checked out. For more details on how the API responds to errors please check our documentation on <a href="https://developer.hetras.com/docs/errors/" onfocus="this.blur()">Error Handling</a>.

Source
actionPOSTv1.0.0

Performs a chip and pin credit card authorization for a reservation.

With this call you can trigger a terminal authorization prompt for a reservation guest. For more details on how the API responds to errors please check our documentation on <a href="https://developer.hetras.com/docs/errors/" onfocus="this.blur()">Error Handling</a>.

Source
Beyond the catalog

Any provider, on request.

01

Request it

Tell us which provider you need, and we will ship it in the registry.

02

Generate it

Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.

acme · integrations
terminal
~/acme $swirls add linear
✓ 12 typed actions · scopes and schemas included
 
~/acme $swirls add https://api.acme.dev/openapi.json
◆ Fetched spec · 38 operations
✓ 6 typed actions · generated from spec