1 of 100

Su API Documentation

Su Overview

Su is the platform that enables easy connectivity and total transparency.

The highly reliable and scalable product powers direct connections to over 175 OTAs across the globe, enabling seamless connectivity to delight your customers.

The Su platform gives PMS providers in total control and helps you grow your business with easy connectivity. The sophisticated technology is simplified with easy connectivity, human access and total transparency. Our platform puts PMS providers in control and helps them grow.

What if something goes wrong?

The Su platform is built by an experienced technical team specializing in OTA connectivity to ensure the system runs as efficiently as possible. That being said, we know it’s reassuring to have a real person on the other end of the phone, whom you can call at any time if you need help.

Is it a hassle to integrate a new piece of tech?

Setting up Su could not be easier. We offer dedicated support and guidance from our experienced product team to ensure a smooth and seamless integration.

For more information, visit our .

Su API Introduction

The Su Partner API provides everything you need to solve a variety of property management needs. The Su Partner API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

How Su Works?

Step 1

Book a live demo to see Su in action. We create a property from scratch and map it to an OTA in the simulator, so you can see for yourself just how simple the platform is to use.

Step2

Arrange a technical call before proceeding with agreements to get up and running with ease.

Integration is built with our guidance and dedicated customer support.

See below:

Contact Information

Partner Success

partnersuccess[at]su-api.com

Support

support[at]su-api.com

Step 3

Launch and start using Su to take back control effortlessly. Our solution provides complete connectivity, allowing you to focus on growing your Property Management System (PMS) with ease and confidence. Elevate your business with seamless integration and streamlined operations.

Su Channel Manager

Brief introduction of every resource and link to the detailed page. To know more about the resource, click on the tile.

Getting Started

This document explains how to successfully call Su APIs. It assumes you are familiar with REST concepts and API requests and responses and know how to perform REST API calls.

Base URLs

Base URL for Su APIs (domain):

General syntax for different endpoints (see below):

Certification

Certification Process

Find below the details of the process which is divided into 2 phases.

Phase I

Find attached Excel file with various test scenarios. Action accordingly and return the results for each test scenario in the field "Actual Result'. We expect to have examples of the request and the responses.

Authentication (Soon to be Deprecated - 01 / April / 2026)

All Su API requests need to be authenticated through the authorization header. The Su APIs offer only basic authentication methods.

IMPORTANT NOTICE

The current authentication method will be deprecated on 1st April 2026.

If you are already using it, please plan your migration.
If you are implementing authentication from scratch, we strongly recommend adopting the new Token-based Authentication mechanism.

Authorization

Authorization involves sending credentials (username and password) and app-id with every API request. Here's how it works:

Encoding Credentials
- Your username and password are encoded in Base64 format and separated by a colon (:).
- For example, username:password becomes dXNlcm5hbWU6cGFzc3dvcmQ= in Base64.

Example header

Key facts:

Basic authentication is built into the HTTP protocol.
The credentials should be encoded in Base64 and placed in the header with the format Basic <encoded credentials>.

Su Partner Supply API Authentication

The Su Partner Supply API authentication process validates the identity of the client attempting to make a connection by using an authentication protocol. The system needs to make sure each end user is properly validated.

Your API keys carry many privileges, so be sure to keep them secure. Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

All requests to the Su REST API need to be authenticated. The Su API supports the scheme for the Partner Supply APIs. For each request, you must include an authorization header.

Partners can opt for their own domain for live production. STAAH requires an SSL certificate for the domain that is valid for the next 2 years at least.

Replace {Authorization String} with the API key provided by STAAH.

Encoding

Encoding provides a specific mechanism for handling text in various available character encodings. The Partner Supply API uses UTF-8 encoding for the JSON body for all API requests and responses.

Authentication Failure

An API failure is any response that does not confirm to the system’s expected behavior when invoked by the client. If a call fails authentication, the API returns HTTP status code 401. See below:

Authentication Failure Error

Content

Content API can be used to create or modify Property, Room Type, and Rate Plan. Property content contains the below property details:

Property

Property describes a commercial premises such as hotels, motels, lodges, luxury apartments, home stays and other types of buildings where individuals, couples, families and/or groups pay to stay, eat, have fun, relax, and to take advantage of all the offered in-house services available.

Create or Update Property

You can create a new property or update an existing property with this API.

Endpoint

POST

The HotelDescriptiveContent object

The HotelDescriptiveContent object defines all the details of a particular hotel such as hotel id, hotel name, time zone, currency, language, contact info, hotel email id, phone number, and position. Partner can provide all these details using the sample request and create or update hotel descriptive content.

Attributes

The dot notation indicates that the property is one level deep inside a hash. No attributes are guaranteed to be present, and if we cannot find data on a specific network, then we will return a null value for that attribute.

HotelName string (Required)

Name of the property as it should be displayed on the website as a hotel name.

Accepts alphanumeric values.
Special characters are not allowed except Hyphen & Apostrophe mark (" - ", " ' ").

HotelType string (Optional)

Hotels are classified according to the location, target markets, ownership, affiliation, and facility provided. HotelType describes the type of that property.

Accepts values: [1, 2 or 3] (Default value=1)
1 - Hotel
2 - Motel
3 - Vacational Rental

TimeZone string (Optional)

If no value passed, system would take the default value of TimeZone depending on the country.

Accepts the values listed under .

Platform string (Optional)

PMS service assigned as Both (SU & STAAH).

Accepts values: ["SU" or "STAAH"]

hotelid / HotelCode / ClientID string (Required)

The unique property ID as assigned by the provider upon creation of the property.

Accepts alphanumeric values.
Space and Special characters are not allowed except Hyphen (" - ").
Maximum 20 characters allowed.

ChainID string (Optional)

The Chain ID as assigned by the provider upon creation of the property.

Accepts alphanumeric values.
Space and Special characters are not allowed except Hyphen (" - ").
Maximum 15 characters allowed.

LanguageCode enum (Required)

The language codes which are acceptable for the property.

Accepts the values listed under .
Default: en

CurrencyCode string (Required)

The currency codes which are acceptable for the property.

Accepts the values listed under .

closeoutdays number (Optional)

The closeoutdays as allocated by the provider for the property.

Accepts the values between 0 to 30 but must be in quotes. Default value is - 1 (no closeouts).

closeouttime string (Optional)

The closeouttime as allocated by the provider for the property.

Accepts the values between 00:00 to 24:00 (Interval must be 30 min). It is required only if you set closeoutdays value as 0. Default value is - 1 (no closeouts).

HotelDescriptiveContentNotifType enum (Required)

Indicates whether the call is meant to create a new property or update an existing one.

Accepts these values: New and Overlay.
Default: New

PropertyLicenseNumber string (Optional)

The property license number, as provided by the local authority.

Required for certain property types, in certain regions.

Consult your account manager for details.

OfficialCheckinTime string (Optional)

Indicates Check-in Time for the earliest time a guest can check in.

Format: HH:MM 24-hour check-in can be specified using 00:00

OfficialCheckoutTime string (Optional)

Indicates Check-out Time for the earliest time a guest can check out.

Format: HH:MM 24-hour check-in can be specified using 00:00

The ContactInfos object

The ContactInfos object contains all the information related to the property. This object is the building block of Names, Addresses, Emails, and Phones.

If the contact profile type is physical location, then you have to provide the complete address which contains complete physical address of the property (City, , and Country).

Attributes

ContactProfileType enum (Required)

Indicates the type of contact.

Accepts: availability and PhysicalLocation.
availability - Contact for questions about availability.
PhysicalLocation - Address details for the property's physical location.

Name.GivenName string (Required)

The contact's given (first) name.

Name.Surname string (Required)

The contact's last name or family name.

NotificationEmail email (Optional)

Email address on which reservations will be notified.

Multiple Notification Email allowed.

Addresses object

Provides information about the addresses associated with hotels or properties.

Address.AddressLine string (Required)

The full street name and number.

Address.CityName string (Required)

The name of the city, town, or village.

Only editable via Extranet.

Address.CountryName countrycode (Required)

The two-letter code for the country.

Only editable via Extranet listed under .

Address.PostalCode string (Required)

The postal or zip code.

Emails object

Provides information about the addresses associated with hotels or properties.

Email string (Required)

Contains a valid email address.

Maximum 5 email address can be added.

Phones object

Refers to the phone number and the phone tech type used.

Phone.PhoneNumber string (Required)

The international phone number that must be dialed to reach the phone.

Must begin with +, followed by all digits required to dial internationally.
No whitespace, hyphens, or other characters allowed.
Not more than 15 numbers.

Phone.PhoneTechType enum (Required)

The type of phone line or device, expressed as a PTT code.

See for accepted values.

The HotelInfo object

This object represents your hotel’s physical position. It provides the exact co-ordinates containing the value of and .

Attributes

Position.Latitude latitude-value (Required)

Latitude of the property's location.

A valid Latitude value (-90) to 90.

Position.Longitude longitude-value (Required)

Longitude of the property's location.

A valid Longitude value (-180) to 180.

Facilities array

This array represents the facility in your hotel such as free parking, internet connection, cab service, and CCTV camera. It provides the information in combination of the facility and the group name from which the facility belongs to.

Attributes

Facility.Group string (Optional)

Group name of the facility.

Facility.name string (Optional)

Name of the facility under a group, multiple facility name can come under one group.

Both "Group" and "name" accepts Free Text - Special characters not allowed
If no Group name given, The amenity will be added under the Group "Common" (Auto created / Default)
Once added, it cannot be removed individually

HotelDescription Free Text (Optional)

Proper description of the property/hotel.

Maximum 100 characters. If exceeded, system will simply accept and will not return an error.

Sample Request

Response

If the API call returns the success as the status, this indicates the request was successful. You have created or modified your property successfully.

Sample Success Response

Sample Error Response

This API uses an overlay system. Every time you update an existing property, room type or other objects, the body of your request replaces previous information. This means existing information will be deleted if you don’t include in your request. To update an object without deleting information, make sure your request contains both the fields you want to update and those you want to keep the same.

Rate Plan

Rate Plan is the price or cost charged by the hotel per night. Rate Plan is the term given to different rates you see on a hotel website when you search for a set of dates.

Create or Update Rate Plan

Create or update rate plan API is used to build new rates or add missing rates. It is also possible to change the rate name or remove an existing rate plan.

Request (RQ) Sent with STAAH Rate-Level Build Data

Endpoint

POST

Send a request with STAAH rate level build data which consists of a set of predefined parameters.

Attributes

Rate Plans hotelid / HotelCode / ClientID string (Required)

The existing property ID. Required existing id to create or update rate plans.

Maximum 20 characters allowed.

RatePlan array

RatePlan array contains the different rate plans for the property.

RatePlanNotifType string (Required)

Indicates whether the call is meant to create new rateplan or update an existing one for property.

Accepts values: [New, Overlay, Remove, Activate].
To create use New and to update rateplan, see , , , and .

rateplanid / RatePlanID string (Required)

The rateplan ID as assigned by the provider.

Accepts alphanumeric values and "-" (Hyphen).
Space and Special characters are not allowed.
Maximum 20 characters allowed.

MealPlanID string (Optional)

Name of the MealPlan. See .

Accepts the values listed under .
If wrong mealplanID sent, then it will take default value.
Default: 15 (Room Only).

closeoutdays number (Optional)

The closeoutdays as allocated by the provider for rateplan.

Accepts the values between 0 to 30 but must be in quotes. Default value is -1(no closeouts).

closeouttime string (Optional)

The closeouttime as allocated by the provider for rateplan.

Accepts the values between 00:00 to 24:00(Interval must be 30 min). It is required only if you set closeoutdays value as 0. Default value is -1(no closeouts).

Description object

This object contains the name of the rate plan and the additional note about the rate plan.

Name string (Required)

The rate plan name.

Text string (Optional)

Additional detail or specific note about the rate plan.

Sample Request

Response

Sample Success Response

Example - Change Rate Plan Name

Attributes

Refer .

Sample Request

Example - Deactivate Rate Plan

Attributes

Refer .

Sample Request

Example - Activate Rate Plan

Attributes

Refer .

Sample Request

Example - Delete Rate Plan

Attributes

Refer .

Sample Request

Response

Sample Success Response

Listing

Listing refers to property listing, Su provides fast and easy way to listing your property.

Listing shares all the characteristics and the qualities of your property, such as room types, rate plans, policies, amenities, photographs, and availability. Travelers love to check all the details before booking a particular property for their stay.

Property Listing

Room Type Listing

Rate Plan Listing

Delete Property Listing

Image API

Image API refers to an interface that allows for the integration and retrieval of images related to hotels, accommodations, or other related visual content.

In other words, Image API allows you to upload, manage, and organize photos of your property. This increases the visibility of what your properties have to offer and might help with conversion.

An Image API could be used for the following purposes:

Create or provide images to display with a particular hotel, property, or room.
Retrieve images associated with a particular hotel, property, or room.
Dynamically update visual content, ensuring that images on various platforms remain accurate and current.
Integration with booking platforms and reservation systems allows for the seamless display of images.
Enhance the user experience for potential guests.
Maintain consistency in visual content across different online channels.

Create Images

The Create Image API allows users to upload or create images in the PMS.

Endpoint

POST

Attributes

hotelid string (Required)

Hotel id for which you want to create and image.

Maximum 20 characters allowed.

proppmsid string (Required)

Id assigned to a specific property within the PMS.

images string (Required)

url string (Required)

URL of the image.

name string (Required)

Name of the image.

pms_imageid string (Optional)

Id assigned to a specific image within the PMS.

Image Create with pms_imageid

Sample Request

Response

Image Create without pms_imageid

Sample Request

Response

Retrieve Images

Retrieve Image API allows users to retrieve or access images stored within the PMS.

Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/imageRetrieve

Attributes

hotelid string (Required)

Hotel id for which you want to retrieve the images.

Maximum 20 characters allowed.

Sample Request

Response

Sample Success Response

Associate Images

The Image Association API enables users to associate an image already stored in the PMS with a property within the PMS.

Image Association for Property

This API is used to associate or connect images with a specific property.

Endpoint

POST

Attributes

hotelid string (Required)

Hotel id for which you want to associate an image.

Maximum 20 characters allowed.

imageid string (Required)

Id assigned to a specific image within the PMS.

pmsimageid string (Required)

Id assigned to a specific image within the PMS.

Sample Request

Request sample for the image associated with imageid for property:

Request sample for the image associate with imageid for room:

Request sample for the image associate with pms_imageid for property:

Request sample for the image associate with pms_imageid for room:

Response

Sample Success Response

Mapping Script

For implementing the module, users have to add a blank div and script to their own system, which is mentioned below:

NOTE

The Su widget cannot be loaded on the local development server. You need to deploy it first; only then you will be able to load the Su widget successfully.

To load the widget, make sure to provide your site’s domain to the Su team for whitelisting.

Add the Script: Include the following script in your HTML to load the required JavaScript file:
Create a Container Div: Insert a blank div in your HTML and assign it an id of your choice:
Invoke the Function: Call the function exported from the script, passing in the necessary object. This object is mandatory for loading the module.

NOTE

The configuration object is required to properly load and initialize the module.

Sample Example

See below:

Use below mention function to load module:

We currently support the following languages. To set a preferred language, please use the corresponding language codes:

Here’s the table you requested:

Language Code

Language

Review API (Soon to be Deprecated)

This Review API is only supported for Airbnb.

Use the correct OTA code for implementation: Airbnb Channel ID = 244.

Review is the way to share your stay experience with others, and it can be used not only by future travelers but also by competing hotels to see what others are saying about them so that they may improve their services.

People are more likely to book a room in a hotel that has a large number of reviews. They always keen to get an idea of what the experience will be like before actually booking it.

For hoteliers, positive reviews and the customer satisfaction are most important factors because they can encourage the business.

Su Review API allows delivery of guest reviews to property.
Reviews only shared for guests with booking.
API applicable for supported channel(s).

Collection of Reviews from OTA

The reviews received from OTA are delivered to partner by post method. Reviews are posted to an endpoint provided by partner. Please note reviews can only be delivered to a single dedicated endpoint. Upon receipt, partners will need to filter reviews based on property ID.

Only one endpoint is required to support both Reviews API and Messaging API. Meaning, both Reviews and Messages are posted to the same endpoint.

Endpoint

END POINT: Please provide endpoint for reviews delivery.

Authorization String: Partner to allocate with Basic Authorization credentials.

Attributes

message string (Optional)

This is message in the review.

guestid string (Optional)c

The unique guest ID as assigned by the provider (OTA) upon creation.

ID can be both numeric, alphanumeric and may have special character such as hyphen ( - ).

bookingid string (Optional)

Booking ID of the Booking.

ID can be both numeric, alphanumeric and may have special character such as hyphen ( - ). For Airbnb, if communication started before booking is made, the parameter will be the thread ID.

listingid string (Optional)

Property ID of the hotel (Channel Hotel ID).

bookingflag string (Optional)

The flag of the booking.

Values can be either B or T (B = Booking, T = Thread). Please note if there is no booking ID, the value will the same for both booking and thread ID.

messageid string (Optional)

This is message id for the particular message.

channel_id string (Optional)

Generated while delivering reviews from OTA.

Airbnb Channel ID: 244

threadid string (Optional)

The thread id created when communication takes place between guest and client,

ID can be both numeric, alphanumeric and may have special character such as hyphen ( - ).

User details

User_details contains the information about the user such as roles and name of users.

roles array (Optional)

These are the different roles.

users array (Optional)

These are the name of users.

attachment array (Optional)

These are the attachments with the review if any.

Review object

Review received from OTA.

Attributes

action string (Optional)

Action on the review, for example review_published.

reviewid string (Optional)

Id of the review.

reviewerid string (Optional)

Unique identity of the reviewer.

reviewer_role string (Optional)

Role of the reviewer.

revieweeid string (Optional)

Unique identity of the reviewee.

reviewee_role string (Optional)

Role of the reviewee.

listing_id string (Optional)

Unique identity of the listing.

private_feedback string (Optional)

Private feedback if any.

public_review string (Optional)

Public review if any.

hidden boolean (Optional)

If the review is hidden or shown.

submitted boolean (Optional)

If the review is submitted or in other state.

submitted_at string (Optional)

Time and date when the review is submitted.

expires_at string (Optional)

Time and date when the review gets expired.

booking_id string (Optional)

Booking id for which the review is posted.

ratings string (Optional)

Rating given by the reviewer.

hotelcode string (Optional)

It is the Hotel ID or Property ID assigned in Su.

Su Property ID.

Sample Request

Response

If acknowledgement is not received as required, system will try to repost the review 3 times. After 3 attempts, review will be removed from queue.

Sample Success Response

Review Response API

API allows respond to guests' reviews to property.
Reviews only shared for guests with booking can be responded.
API applicable for supported channel(s).

Response to Reviews Collection from OTA

Once reviews received from OTA, will be delivered to partner by post method. Reviews made from guest to host can be responded using API.

Only reviews received / initiated from guest can be responded.

Endpoint

POST

Attributes

hotelid string (Optional)

It is the Hotel ID or Property ID assigned in Su.

Su Property ID.

channelid string (Optional)

Generated while delivering reviews from OTA.

Airbnb Channel ID: 244

replytext string (Optional)

The response to the review.

listingid string (Optional)

Property ID of the hotel (Channel Hotel ID).

locationid string (Optional)

Account / Host ID of the channel (Airbnb).

reviewid string (Optional)

ID of the review allocated which is being responded.

Sample Request

Response

Sample Success Response

Link/Retrieve Contract

Contract Retrieval api allows users to fetch the existing contact details.

Endpoint

POST

Attributes

hotel_id string (Required)

The unique property ID as assigned by the provider upon creation of the property.

legal_entity_id string (Required)

The identity of the legal entity.

legal_contact_email string (Required)

The Accommodation Partner's legal contact email.

The system sees this email as the unique identifier for the Accommodation Partner.
It should be in valid email format.

Sample Request

Response

Sample Success Response

Error

Sample Error Response

Response Body Elements

Status string

The status of the response.

Message string

The message in the response.

Ruid string

Specifies the unique request ID.

You can share this ID with Booking.com customer support when you run into an issue. This can help in understanding what went wrong.

Data object

The response data.

legal_entity_id integer

The unique legal entity ID.

city string

The city of the Accommodation Partner.

company_name string

The commercial name of the Accommodation Partner company.

contract_countries string

The countries in which the Accommodation Partner has properties.

You can only see this array when the contract is signed.

total_number_of_properties string

The amount of properties connected to the Accommodation Partner.

legal_contact_phone_number string

The Accommodation Partner's legal contact phone number.

Follows the ITU E.164 standard.

legal_contact_name string

The Accommodation Partner's legal contact name.

country string

The country of the Accommodation Partner.

legal_contact_email string

The Accommodation Partner's legal contact email.

The system sees this email as the unique identifier for the Accommodation Partner.

contract_signed boolean

Indicates whether the contract is signed.

Update Property

The endpoint allows users to update the existing property.

Endpoint

POST

Attributes

hotel_id alphanumeric (Required)

The unique property ID as assigned by the provider upon creation of the property.

legal_entity_id string (Required)

The unique id for the legal entity associated with the hotel.

Only allowed for new properties.

position object

Object containing geographical coordinates of the property.

latitude double (Required)

Latitude coordinates of the hotel location.

longitude double (Required)

Longitude coordinates of the hotel location.

check_in object

Object containing check-in times.

Specify 24-hour check-in by using 00:00 for both from and until.

from enumerated string (Required)

Start time for check-in (required).

Accepted values follow the .

until enumerated string (Optional)

End time for check-in.

Accepted values follow the .

check_out object

Object containing check-out times.

from enumerated string (Optional)

Start time for check-out (optional).

Accepted values follow the .

until enumerated string (Required)

End time for check-out (required if check_out > from is specified).

Accepted values follow the .

property_name string (Required)

Name of the hotel property on Booking.com.

Does not support using .

property_category integer (Required)

Category identifier for the hotel.

For a list of supported property class type codes, see .

primary_language enumerated string (Optional)

Main preferred language spoken at the property.

languages_spoken array of enumerated strings (Optional)

Array of languages spoken at the property.

room_count integer (Required)

Number of sellable units/rooms available at the hotel.

A "sellable unit" is the smallest possible space that a guest can book at the property. In a property with 200 rooms, each room is a sellable unit, and the value would be 200. In a holiday home, guests must typically book the home in its entirety, making the value 1.

floor_count integer (Optional)

The total number of floors in the building/hotel, excluding the underground floors.

Max value can be 200.

stars string (Optional)

The number of stars, rating of the hotel.

Accepts values: 0–5. Starting from 1, accepts values in increments of .5. Some countries don't use star ratings. To see whether your property belongs to a Hotel property type,

target enumerated string (Required)

Specifies whether it is a test or production-ready property.

Accepts the following values:

test
production

provider_property_id string (Optional)

Identifier for the property provider.

Recommended for new properties. For example, the provider's internal ID. Can contain a maximum of 16 characters.

currency_code enumerated string (Optional)

The Booking.com defined currency for the property.

In select countries a currency other than the default can be selected.

physical_address object (Required)

Object containing address details.

city_name string (Required)

City where the hotel is located.

country_code enumerated string (Required)

ISO code for the country (IN for India).

postal_code string (Optional)

Postal code of the hotel's location.

Make sure the zip code (postal_code) is relevant to the country specified in the country_code.

address_line string (Required)

Detailed address of the hotel.

display_address boolean (Optional)

Boolean indicating if the address should be displayed.

- true : Shows the full address to the guest. - false : Hides the full address from the guest.

translations object

Object for multilingual support. Specifies the non-English translations of the physical address.

city_name string (Required)

Translated city name.

address_line string (Required)

Translated address line.

Should not contain abbreviations (such as "Rd." for "Road") and should not exceed 255 characters.

language_code enumerated string (Required)

Language code for translation.

property_name enumerated string (Required)

Translated property name.

Sample Request

Response

Sample Success Response

Error

Sample Error Response

Response Body Elements

Status string

The status of the response.

Data object

The response data, the root element.

property_id string

Specifies the property ID that was created.

Message string

The message in the response.

Retrieve Contact

This endpoint retrieves detailed information about a specific contact.

Endpoint

POST

Header

Type

Required

Description

Attributes

hotel_id alphanumeric (Required)

The unique property ID as assigned by the provider upon creation of the property.

channel_hotel_id string (Required)

The unique id for the legal entity associated with the hotel. the unique ID of the property on channel to retrieve its details.

Sample Request

Response

Sample Success Response

Error

Sample Error Response 1

Sample Error Response 2

Sample Error Response 3

Response Body Elements

Status string

The status of the response.

Data object

The response data, the root element.

contacts array

An array of contact objects containing contact details.

contact_profiles array

A list of profiles associated with the contact (for example, invoices, general).

address object

Contains the address details of the contact including country, city and postal code details.

city_name string

The city name where the contact is located.

country_codeenumerated string

The ISO country code of the contact's location.

postal_code string

The postal code of the contact's location.

address_line string

The street address of the contact.

language_code enumerated string

The language code for the address.

contact_person object

Details about the contact person.

gender enumerated string

Gender of the contact person.

name string

Full name of the contact person.

job_title enumerated string

Job title of the contact person.

language_code string

Language code for the contact person (for example, 'en-gb').

phones array

List of phone numbers associated with the contact.

phone_number string

The actual phone number (all international phone numbers).

phone_tech_type enumerated string

Technology type of the phone (for example, '1' for landline).

extension string

Extension number for the phone, if applicable.

email string

Email address of the contact.

Error array

Array that contains details about any errors that occurred during the API call. Each object in the Errors array contains the following properties:

Code string

Specific error code that helps identify the type of error.

ShortText string

Brief description of the error.

Property

Create or Update Property

You can create a new property or update an existing property with this API.

Endpoint

POST

The HotelDescriptiveContent object

Attributes

HotelName string (Required)

Name of the property as it should be displayed on the website as a hotel name.

Accepts alphanumeric values.
Special characters are not allowed except Hyphen & Apostrophe mark (" - ", " ' ").

HotelType string (Optional)

Hotels are classified according to the location, target markets, ownership, affiliation, and facility provided. HotelType describes the type of that property.

Accepts values: [1, 2 or 3] (Default value=1)
1 - Hotel
2 - Motel
3 - Vacational Rental

TimeZone string (Optional)

If no value passed, system would take the default value of TimeZone depending on the country.

Accepts the values listed under .

Platform string (Optional)

PMS service assigned as Both (SU & STAAH).

Accepts values: ["SU" or "STAAH"]

hotelid / HotelCode / ClientID string (Required)

The unique property ID as assigned by the provider upon creation of the property.

Accepts alphanumeric values.
Space and Special characters are not allowed except Hyphen (" - ").
Maximum 20 characters allowed.

ChainID string (Optional)

The Chain ID as assigned by the provider upon creation of the property.

Accepts alphanumeric values.
Space and Special characters are not allowed except Hyphen (" - ").
Maximum 15 characters allowed.

LanguageCode enum (Required)

The language codes which are acceptable for the property.

Accepts the values listed under .
Default: en

CurrencyCode string (Required)

The currency codes which are acceptable for the property.

Accepts the values listed under .

closeoutdays number (Optional)

The closeoutdays as allocated by the provider for the property.

Accepts the values between 0 to 30 but must be in quotes. Default value is - 1 (no closeouts).

closeouttime string (Optional)

The closeouttime as allocated by the provider for the property.

Accepts the values between 00:00 to 24:00 (Interval must be 30 min). It is required only if you set closeoutdays value as 0. Default value is - 1 (no closeouts).

HotelDescriptiveContentNotifType enum (Required)

Indicates whether the call is meant to create a new property or update an existing one.

Accepts these values: New and Overlay.
Default: New

PropertyLicenseNumber string (Optional)

The property license number, as provided by the local authority.

Required for certain property types, in certain regions.

Consult your account manager for details.

OfficialCheckinTime string (Optional)

Indicates Check-in Time for the earliest time a guest can check in.

Format: HH:MM 24-hour check-in can be specified using 00:00

OfficialCheckoutTime string (Optional)

Indicates Check-out Time for the earliest time a guest can check out.

Format: HH:MM 24-hour check-in can be specified using 00:00

The ContactInfos object

The ContactInfos object contains all the information related to the property. This object is the building block of Names, Addresses, Emails, and Phones.

If the contact profile type is physical location, then you have to provide the complete address which contains complete physical address of the property (City, , and Country).

Attributes

ContactProfileType enum (Required)

Indicates the type of contact.

Accepts: availability and PhysicalLocation.
availability - Contact for questions about availability.
PhysicalLocation - Address details for the property's physical location.

Name.GivenName string (Required)

The contact's given (first) name.

Name.Surname string (Required)

The contact's last name or family name.

NotificationEmail email (Optional)

Email address on which reservations will be notified.

Multiple Notification Email allowed.

Addresses object

Provides information about the addresses associated with hotels or properties.

Address.AddressLine string (Required)

The full street name and number.

Address.CityName string (Required)

The name of the city, town, or village.

Only editable via Extranet.

Address.CountryName countrycode (Required)

The two-letter code for the country.

Only editable via Extranet listed under .

Address.PostalCode string (Required)

The postal or zip code.

Emails object

Provides information about the addresses associated with hotels or properties.

Email string (Required)

Contains a valid email address.

Maximum 5 email address can be added.

Phones object

Refers to the phone number and the phone tech type used.

Phone.PhoneNumber string (Required)

The international phone number that must be dialed to reach the phone.

Must begin with +, followed by all digits required to dial internationally.
No whitespace, hyphens, or other characters allowed.
Not more than 15 numbers.

Phone.PhoneTechType enum (Required)

The type of phone line or device, expressed as a PTT code.

See for accepted values.

The HotelInfo object

This object represents your hotel’s physical position. It provides the exact co-ordinates containing the value of and .

Attributes

Position.Latitude latitude-value (Required)

Latitude of the property's location.

A valid Latitude value (-90) to 90.

Position.Longitude longitude-value (Required)

Longitude of the property's location.

A valid Longitude value (-180) to 180.

Facilities array

Attributes

Facility.Group string (Optional)

Group name of the facility.

Facility.name string (Optional)

Name of the facility under a group, multiple facility name can come under one group.

Both "Group" and "name" accepts Free Text - Special characters not allowed
If no Group name given, The amenity will be added under the Group "Common" (Auto created / Default)
Once added, it cannot be removed individually

HotelDescription Free Text (Optional)

Proper description of the property/hotel.

Maximum 100 characters. If exceeded, system will simply accept and will not return an error.

Sample Request

Response

If the API call returns the success as the status, this indicates the request was successful. You have created or modified your property successfully.

Sample Success Response

Sample Error Response

This API uses an overlay system. Every time you update an existing property, room type or other objects, the body of your request replaces previous information. This means existing information will be deleted if you don’t include in your request. To update an object without deleting information, make sure your request contains both the fields you want to update and those you want to keep the same.

Room Type

Room type describes the specific rooms in the hotel based on their room names, classifications, occupancy, sizes, and facilities, amenities or view provided to the guests.

For example, you might offer a Deluxe Room with double occupancy with pool view or beach access.

Create or Update Room Type

You can create a new Room Type or update an existing Room Type in your property. There are a few steps to perform when you create or update any property.

Process to create your room type:

For creating or updating a room type, send request with STAAH Room-Level build data.
If your request is valid, you get a success response that means you have successfully created your room type.

Request (RQ) Sent with STAAH Room-Level Build Data

OTA_HotelRoom POST method provides an object SellableProducts in the request which is sent to the server and the success response creates or modify the Room Type.

Endpoint

POST

The SellableProducts object

You can create different sellable products under one room id or specific room. In other words, you can sell one room with multiple parameters by creating different room types with different amenities.

This is an object representing your sellable product which is a room type. With this object you can POST this object to create a specific room type with all the desired details.

You can also provide the hotel address, positioning, occupancy, and address. Further, room type is broken down based on the occupancy and the facilities.

Attributes

hotelid / HotelCode / ClientID string (Required)

The existing Property/Client ID.

Required existing id to create or update room types.
Maximum 20 characters allowed.

SellableProduct [InvStatusType] string (Required)

Indicates whether the call is meant to create new room type or update an existing one for property.

Accepts values: Initial, Modify, Active, Deactivated, and Delete.
To create a new SellableProduct use Initial.
To Modify, Activate / Deactivate room type, see , , and .

SellableProduct [InvNotifType] string (Required)

Indicates the call is meant to modify room type for property.

Accepts values: Overlay

Occupancy [MaxOccupancy] integer (Required)

Maximum number of guests allowed to stay in a room type.

Maximum occupancy of 999 guests per room type supported.

Occupancy [MaxChildOccupancy] integer (Required)

Maximum number of children allowed to stay in a room type.

Value must be less than Maximum Occupancy of the room type.

The Room object

This is an object representing your particular room with all details. You can specify different room rates, occupancy, quantity, and size.

Attributes

Room.[roomid / RoomID / InvCode/ ListingID] string (Required)

The room ID / Listing ID as assigned by the provider.

roomid, RoomID, ListingID & InvCode defines the same field.
Accepts alphanumeric values and hyphen ( - ).
Space and other special characters are not allowed.
Maximum 20 characters allowed.

Room.RoomRate double (Required)

The default saleable rates of room.

Rate should be greater than 0.

Room.Quantity integer (Optional or auto update)

Number of rooms available in the property.

Room type quantity is not a static value. If not passed when creating, default value will be passed as 0 and system automatically compares inventory values received with this value. It will override and replace it with the higher inventory value (if received).

Room.RoomType string (Required)

Name of the room type. See

Accepts both code and name listed under .

Room.SizeMeasurement double (Optional)

Size of guest room in square meters (by default).

Use SizeMeasurementUnit to indicate square feet unit.

Room.SizeMeasurementUnit enum (Optional)

The measurement unit ("sqm" or "sqft") for the value specified in SizeMeasurement.

This cannot be defined if the SizeMeasurement attribute is missing. Default: sqm

The Facilities object

This is an object representing your facility with its group and the particular name of the facility.

Facilities included in the room type can be assigned using this node. Both Group and Facility are free text - can create group and assign facilities on fly. No special characters allowed.

Attributes

Facility.Group string (Optional)

Group name of the facility.

Facility.name string (Optional)

Name of the facility under a group, multiple facility name can come under one group.

The Position object

This is an object representing Latitude and Longitude.

Position.Latitude latitude-value (Optional)

Latitude of the property's location.

A valid Latitude value (-90) to 90.

Position.Longitude longitude-value (Optional)

Longitude of the property's location.

A valid Longitude value (-180) to 180.

The Address object

This is an object representing a structured address of the property. Address object consists of all the address details such as street name, street number, city name, postal or zip code of the city, and country name.

Address.AddressLine string (Optional)

The full street name and number.

Address.CityName string (Optional)

The name of the city, town, or village.

Only editable through Extranet.

Address.PostalCode string (Optional)

The postal or zip code.

Address.CountryName string (Optional)

The two-letters code for the country.

Only editable through Extranet listed under .

The Description object

Description.Text string (Required)

The room type name.

Description.RoomDescription Free Text (Optional)

Description of room type.

Maximum 2000 characters. If exceeded, system will simply accept and will not return an error.

Sample Request

Response

If the API call returns the success as the status, this indicates the request was successful. You have created or modified your Room Type successfully.

Upon creating a Room Type / Listing successfully, the status will be as "Incomplete" as there is no inventory available for it. Once inventory have been updated for the room type / listing, the status will be changed to "Active" automatically and it will appear as an option to map in channel mapping page.

Sample Success Response

Error

As with every standard STAAH response, an "ID" is necessary for any JSON troubleshooting of requests to STAAH.

you cannot create a room with the same id as a previous room. This will return an error.

Sample Error Response (906)

Update or Modify Room Type

If you want to update the room type, set the InvStatusType attribute to “Modify“ in the header request and call the Update/Modify Room Type API. Updating or modifying a room type involves several key steps and considerations. This procedure is essential for maintaining accurate room inventory, optimizing pricing strategies, and ensuring a positive guest experience.

Sample Request

Deactivate Room Type

If you want to deactivate the room type, set the InvStatusType attribute to “Deactivated“ in the header request and call the Update/Modify Room Type API.

Sample Request

Activate Room Type

If you want to activate the room type, set the InvStatusType attribute to “Active“ in the header request and call the Activate Room Type API.

Sample Request

Delete Room Type

If you want to delete the room type, set the InvStatusType attribute to “Delete“ in the header request and call the Update/Modify Room Type API.