---
title: "Stay"
url: "https://portal2.konghotels.cloud/apis/kong-hotels-guest-stay-api-1/versions/b4bfa113-0e33-46cc-8723-38e7ac5e7863/schemas/Stay"
---

> Full API specification: https://portal2.konghotels.cloud/apis/kong-hotels-guest-stay-api-1/versions/b4bfa113-0e33-46cc-8723-38e7ac5e7863.md

# Stay

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Kong Hotels Guest Stay API
  version: 1.0.0
servers:
  - url: https://stay.konghotels.cloud
    description: Production (Kong Gateway)
components:
  schemas:
    StayStatus:
      type: string
      enum:
        - pre_arrival
        - checked_in
        - checked_out
        - no_show
        - cancelled
      description: "`pre_arrival`: booked, not yet checked in. `checked_in`: guest is
        in house. `checked_out`: stay complete."
    RoomStatus:
      type: string
      enum:
        - not_assigned
        - assigned
        - ready
      description: "`ready` means cleaned and inspected; keys can be issued."
    Stay:
      type: object
      required:
        - confirmation_number
        - property_code
        - status
        - room
      properties:
        confirmation_number:
          type: string
          examples:
            - KH4DEMO01
        property_code:
          type: string
          examples:
            - KTNYC
        status:
          $ref: "#/components/schemas/StayStatus"
        arrival_date:
          type: string
          format: date
        departure_date:
          type: string
          format: date
        room:
          type: object
          required:
            - status
          properties:
            status:
              $ref: "#/components/schemas/RoomStatus"
            number:
              type:
                - string
                - "null"
              examples:
                - "1412"
            floor:
              type:
                - integer
                - "null"
              examples:
                - 14
            estimated_ready_at:
              type:
                - string
                - "null"
              format: date-time
        check_in_time:
          type: string
          description: Property's standard check-in time (local).
          examples:
            - 15:00
        check_out_time:
          type: string
          description: Agreed check-out time (local), including any approved late check-out.
          examples:
            - 11:00
        checked_in_at:
          type:
            - string
            - "null"
          format: date-time
        checked_out_at:
          type:
            - string
            - "null"
          format: date-time
        actions:
          type: object
          description: What the guest can do right now. Use these instead of re-deriving
            the rules.
          properties:
            can_check_in:
              type: boolean
            can_issue_key:
              type: boolean
            can_request_service:
              type: boolean
            can_check_out:
              type: boolean
```