canonical: https://jentic.com/apis/newbook.cloud/newbook

# Newbook OTA API

The Newbook OTA API exposes Newbook's property management system over Open Travel Alliance (OTA) message contracts, represented here as REST endpoints that wrap SOAP/XML payloads. Channel managers, OTAs, and direct booking surfaces use it to read availability and rates, push reservations, modify or cancel bookings, and manage availability and rate inventory (ARI) for accommodation properties. Authentication uses a WSSE header passed on every request.

## For AI agents

Read accommodation availability and rates and create, modify, or cancel bookings against Newbook properties through OTA-style messages.

## Scope

Does not handle payments, guest communications, or housekeeping operations - use for OTA-style availability, rates, and reservation messages against Newbook properties only.

## Capabilities

- Test connectivity and credentials with the OTA Ping message
- Retrieve descriptive hotel and instance information for connected properties
- Get the room types and rate plan mapping for a property to drive a booking surface
- Check live availability and rates for a property across given dates and occupancies
- Read existing booking details by reservation reference
- Create, modify, or cancel bookings via the OTA HotelResNotif message
- Configure ARI push settings to control how Newbook sends availability and rate updates

## Use cases

### OTA Channel Booking Push

Online travel agencies that take a reservation on their own surface forward the booking into Newbook by calling POST /OTA_HotelResNotifRQ with the OTA-formatted booking message. Newbook records the reservation against the property and the property staff see the new booking in their PMS without any manual entry.

Example prompt: POST to /OTA_HotelResNotifRQ with the OTA HotelResNotif message containing the guest, property, room type, rate plan, and arrival/departure dates; record Newbook's confirmation reference in the OTA's order record.

### Real-Time Availability and Rate Lookup

Booking surfaces and metasearch integrations call POST /OTA_HotelAvailRQ to fetch live availability and pricing for a property and date range before quoting a guest. The response feeds the displayed rate so the guest only sees offers Newbook can actually fulfil.

Example prompt: POST to /OTA_HotelAvailRQ with the property code, arrival and departure dates, and occupancy; surface the cheapest available rate plan in the booking widget.

### Reservation Modification and Cancellation

Guest service teams modify or cancel an existing booking by sending a HotelResNotif message with status 'Modify' or 'Cancel' through POST /OTA_HotelResNotifRQ. Newbook applies the change to the property's PMS calendar and inventory immediately, eliminating the dual-entry problem when handling changes from multiple channels.

Example prompt: POST to /OTA_HotelResNotifRQ with the existing reservation reference and a HotelResNotif message in 'Cancel' status to release the inventory back to availability.

### AI Agent Concierge for Properties

A property concierge agent uses Jentic to discover Newbook OTA operations and answers guest questions like 'is a king room available next Friday?' by calling /OTA_HotelAvailRQ behind the scenes, then proceeds to /OTA_HotelResNotifRQ once the guest confirms - all through one credential bound at the agent level.

Example prompt: Use Jentic to search 'check hotel availability', load POST /OTA_HotelAvailRQ, execute it for the guest's dates, and on confirmation call POST /OTA_HotelResNotifRQ to create the booking.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/OTA_PingRQ` | Connection test |
| POST | `/OTA_HotelDescriptiveInfoRQ` | Retrieve hotel and instance information |
| POST | `/GetMappingRQ` | Get room types and rate plans |
| POST | `/OTA_HotelAvailRQ` | Check availability and rates |
| POST | `/OTA_ReadRQ` | Retrieve booking details |
| POST | `/OTA_HotelResNotifRQ` | Create, modify, or cancel bookings |
| POST | `/ARISettingsRQ` | Configure ARI push settings |

## Key resources

- **System** — Connectivity test via OTA Ping
- **Hotel Info** — Descriptive hotel and rate plan mapping information
- **Availability** — Live availability and rate lookups for properties and dates
- **Bookings** — Read, create, modify, and cancel reservations
- **ARI** — Availability and rate inventory push settings

## Why Jentic

- **Setup:** Wiring the Newbook OTA API by hand means building its WSSE header, targeting the apius.newbook.cloud/ota host, and shaping the OTA request messages for availability, rates, and reservations yourself. Through Jentic you install once, import Newbook OTA from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** Newbook takes its property and reservation details inside the OTA request body, so limit the agent to the operations it needs, such as checking availability or reading a reservation, and leave out the ones it should not run, such as posting a reservation notification.
- **Credential handling:** Your Newbook WSSE credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'check hotel availability' or 'create a hotel booking', and Jentic returns the matching Newbook OTA operation with its input schema so the agent calls the right endpoint without browsing the OTA schemas by hand.

## Related APIs

- **Cloudbeds API** — Property management system with REST API for hotel and short-term rental operations
- **Beds24 API** — Channel manager and PMS API covering availability, rates, and bookings
- **Booking.com API** — Distribution channel that pushes reservations into the property's PMS

## FAQ

### What authentication does the Newbook OTA API use?

Newbook OTA uses a WSSE header passed on every request. Through Jentic, the WSSE credential is stored in the encrypted Jentic One instance and injected at request time so it never appears in the agent's context.

### Can I create bookings through the Newbook OTA API?

Yes. POST /OTA_HotelResNotifRQ accepts an OTA HotelResNotif message in 'Commit', 'Modify', or 'Cancel' status to create, change, or cancel a reservation in Newbook. The endpoint returns Newbook's confirmation reference for use in your own order record.

### How do I check live availability and rates through Jentic?

Search Jentic for 'check hotel availability', load POST /OTA_HotelAvailRQ, and execute it with the property code, dates, and occupancy. The response contains the bookable rate plans and prices that Newbook will honour.

### What are the rate limits for the Newbook OTA API?

Rate limits are not published numerically in the spec - Newbook scales API capacity by the property and channel partner agreement. Coordinate concurrency expectations with Newbook before running heavy availability polling against many properties.

### Is the Newbook OTA API REST or SOAP?

The underlying contract is OTA SOAP/XML. Newbook represents each OTA message as a REST endpoint that accepts the corresponding XML body, so HTTP clients can call /OTA_HotelResNotifRQ etc. without a SOAP toolkit.

### Is the Newbook OTA API free?

API access is included with Newbook's PMS subscription for connected properties or channel partners. There is no separate API tier - credentials are issued by Newbook as part of the partner onboarding process.

### Can I limit what my agent is allowed to do with the Newbook OTA API?

Yes. Because Jentic One is self-hosted, your own rules decide which Newbook OTA operations and credentials the agent may use. You can allow read-only calls such as checking availability and rates with /OTA_HotelAvailRQ or reading a reservation with /OTA_ReadRQ, while leaving out write operations like creating, modifying, or cancelling a booking through /OTA_HotelResNotifRQ. The WSSE credential is injected only for the operations you permit, so the agent cannot call anything you have not scoped.