Availability and Rates API

API to work with Availability and Rates

Availability, Rates and Restriction data is the core data for hotel business. This information represents how many rooms your property has to sell and what restrictions you have applied to each rate plan.

Get Availability and Restrictions data from Rate Plans.

GET https://hotelcm-api-dev.zimple.cloud/api/v1/restrictions?filter[property_id]=888204c4-723a-3546-a254-8f4b2aeb1356&filter[date][gte]=2024-01-01&filter[date][lte]=2024-01-10&filter[restrictions]=rate

date

Specific date or Date range what you would like to load. Date should be provided as ISO 8601 format YYYY-MM-DD. Query to get values for specific date: filter[date]=YYYY-MM-DD To get values for Date Range: filter[date][gte]=YYYY-MM-DD&filter[date][lte]=YYYY-MM-DD

restrictions

List of comma separated restrictions what you would like to load. Supported values: - availability - rate - min_stay_arrival - min_stay_through - min_stay - closed_to_arrival - closed_to_departure - stop_sell - max_stay - availability_offset - max_availability

Headers

Name	Type	Description
user-api-key*	String

200: OK

400: Bad Request

401: Unauthorized

Get Availability Per Room Type

GET https://hotelcm-api-dev.zimple.cloud/api/v1/availability?filter[date][gte]=2024-01-01&filter[date][lte]=2024-01-10

date

Specific date or Date range what you would like to load. Date should be provided as ISO 8601 format YYYY-MM-DD. Query to get values for specific date: filter[date]=YYYY-MM-DD To get values for Date Range: filter[date][gte]=YYYY-MM-DD&filter[date][lte]=YYYY-MM-DD

Headers

Name	Type	Description
user-api-key*	String

200: OK

400: Bad Request

401: Unauthorized

Update Rate & Restrictions for specific Rate Plans and Dates.

POST https://hotelcm-api-dev.zimple.cloud/api/v1/restrictions

Query body (JSON) for single date update:

{ "values": [{ "property_id": "888204c4-723a-3546-a254-8f4b2aeb1356", "rate_plan_id": "235d4672-dccd-4572-2356-b5ab87ce346b", "date": "2024-01-20", "rate": 30000 }] }

Query body (JSON) for multiple dates update:

{ "values": [{ "property_id": "888204c4-723a-3546-a254-8f4b2aeb1356", "rate_plan_id": "235d4672-dccd-4572-2356-b5ab87ce346b", "date_from": "2024-01-20", "date_to": "2024-01-28", "rate": 30000 }] }

Headers

Name	Type	Description
user-api-key*	String

200: OK

401: Unauthorized

429: Too Many Requests

Update Availability for a specific Room Type and Date.

POST https://hotelcm-api-dev.zimple.cloud/api/v1/availability

Query body (JSON) for single date update:

{ "values": [{ "property_id": "888204c4-723a-3546-a254-8f4b2aeb1356", "room_type_id": "235d4672-dccd-4572-2356-b5ab87ce346b", "date": "2024-01-20", "availability": 2 }] }

Query body (JSON) for multiple dates update:

{ "values": [{ "property_id": "888204c4-723a-3546-a254-8f4b2aeb1356", "room_type_id": "235d4672-dccd-4572-2356-b5ab87ce346b", "date_from": "2024-01-20", "date_to": "2024-01-25", "availability": 2 }] }

Headers

Name	Type	Description
user-api-key*	String

200: OK

401: Unauthorized