Skip to main content

Availability

Overview​

The Availability module is the foundational synchronization layer of the Push Integration. Its primary responsibility is to ensure that the physical room inventory counts that represent the actual number of sellable units remaining at a property are perfectly mirrored across the property’s local system and the GuestPro Platform ecosystem.

Whenever the local Property Management System (PMS) registers an inventory-altering event (e.g., a new reservation decreases available rooms, or a guest cancellation increases available rooms), this API endpoint must be immediately invoked to declare these "availability changes".

Availability Endpoint​

API Specification​

  • HTTP Method: POST
  • URL Path: {{base_url}}/cm/api/{{code}}/changes/availability

Request Headers​

  • api-key: {{api_key}} Authorization token assigned to the connecting system. The API key is provided by GuestPro.
  • Content-Type: application/json Explicitly defines the payload structure.

Payload Construction and Schema Definition​

(Under Development)

Expected System Responses​

Successful Execution​

The external system must respond with an HTTP 200 OK or 201 Created.

{
  "status": "success",
  "message": "Availability changes have been successfully"
}

Failure Execution​

When the external system provides a response other than success codes (200, 201), the external system delivers the following error response structure.

{
  "status": "error",
  "message": "<<error_detail>>"
}

Full Request Body​

(Under Development)