# Check venue availability

Endpoint: GET /venues/{compositeId}/availability
Version: 4.11.0-SNAPSHOT
Security: Staging, Production

## Path parameters:

  - `compositeId` (string, required)
    The unique identifier of the venue or product.

## Query parameters:

  - `AvailabilityRequest` (object)

## Header parameters:

  - `X-Partner-Reference` (string)
    Required for Bookable Agents. Specifies the partner reference for whom the booking is being made.
This header must contain a valid partner reference when making requests with the agent:write scope.
    Example: "bottomlessbrunch.com"

  - `X-Correlation-ID` (string)
    An optional ID which you can use to track transactions across multiple systems. It can have any value, but we recommend avoiding . characters.
Mirrored back in a response header.
    Example: "11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA"

## Response 200 fields (application/json):

  - `name` (string)
    The name of the available booking option.

  - `deposit` (number)
    The deposit amount required for the booking.

  - `policy` (string)
    General policy details regarding the booking.

  - `cancellationPolicy` (string)
    Terms and conditions for canceling the booking.

  - `times` (array)

  - `times.time` (string)
    Available time slot for the booking (HH:MM format).

  - `times.duration` (integer)
    Duration of the booking in minutes.

  - `times.type` (string)
    Specifies how an operators time slot can be handled. A value of book indicates the slot is available for instant confirmation, while request means the slot requires manual approval through an enquiry-based process.
    Enum: "book", "request"

  - `times.productId` (string,null)
    Unique identifier of the product (compositeId) that this time slot refers to.

  - `noAvailabilityAction` (string)
    Strategy provided by the RMS (Restaurant Management System) when no availability is found. Defines fallback actions or alternative options to present to customers.

  - `autoConfirmRule` (object)
    Defines the criteria for automatically confirming bookings without manual intervention.

  - `autoConfirmRule.date` (string,null)
    Specific date when this rule applies (YYYY-MM-DD format). If null, rule applies based on other criteria.

  - `autoConfirmRule.dateType` (string,null)
    Type of date restriction (e.g., "date", "weekend", "special_event"). Allows for categorized date-based rules.

  - `autoConfirmRule.minPeople` (integer,null)
    Minimum number of people required for auto-confirmation. If null, no minimum limit applies.

  - `autoConfirmRule.maxPeople` (integer,null)
    Maximum number of people allowed for auto-confirmation. If null, no maximum limit applies.

  - `autoConfirmRule.timeFrom` (string,null)
    Start time for the auto-confirm window (HH:MM format). Bookings before this time won't be auto-confirmed.

  - `autoConfirmRule.timeTo` (string,null)
    End time for the auto-confirm window (HH:MM format). Bookings after this time won't be auto-confirmed.

  - `autoConfirmRule.weekdays` (object)
    Configuration object defining which weekdays a rule applies to.

  - `autoConfirmRule.weekdays.monday` (boolean,null)
    Whether the rule applies on Mondays.

  - `autoConfirmRule.weekdays.tuesday` (boolean,null)
    Whether the rule applies on Tuesdays.

  - `autoConfirmRule.weekdays.wednesday` (boolean,null)
    Whether the rule applies on Wednesdays.

  - `autoConfirmRule.weekdays.thursday` (boolean,null)
    Whether the rule applies on Thursdays.

  - `autoConfirmRule.weekdays.friday` (boolean,null)
    Whether the rule applies on Fridays.

  - `autoConfirmRule.weekdays.saturday` (boolean,null)
    Whether the rule applies on Saturdays.

  - `autoConfirmRule.weekdays.sunday` (boolean,null)
    Whether the rule applies on Sundays.

## Response default fields (application/json):

  - `type` (string)
    A URI reference [rfc9457] that identifies the problem type. This specification encourages that, when dereferenced, it provides human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank".

  - `title` (string, required)
    A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

  - `status` (integer, required)
    The HTTP status code [rfc9457, Section 3.1.12] generated by the origin server for this occurrence of the problem.

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.