Skip to main content

Restriction

Overview​

Beyond fundamental room counts (Availability) and pricing (Rates), sophisticated hotel management relies heavily on tactical inventory control mechanisms known as Restrictions (or yield management rules).

The Restriction API serves as the vital command center allowing external Property Management Systems (PMS) to deploy strict, calendar-based sales parameters to GuestPro Platform. These rules dictate explicitly when reservations can begin, when they can end, the required duration of the stay, or if a specific room/rate combination should be abruptly pulled from the public market entirely.

Update Restrictions Endpoint​

API Specification​

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

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": "Restrictions have been successfully synchronized to the property calendar."
}

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>>"
}