> ## Documentation Index
> Fetch the complete documentation index at: https://docs.maple.inc/llms.txt
> Use this file to discover all available pages before exploring further.

# Search booking availability

> Bookable slots for a party at a granted location inside a venue-local window (at most 31 days). Every slot carries an opaque signed `slot_token`: pass it unchanged to `POST /booking_holds`, never rebuild slot parameters yourself. Quotes are bound to the partner channel and expire after 15 minutes. Typed outcomes (`party_size_out_of_bounds` with the bounds, `outside_booking_window`, `large_party_inquiry_required` with the venue’s inquiry contact, `bookings_not_enabled`) come back as 422 with a `code`. Requires `bookings:read`.



## OpenAPI

````yaml /openapi/developer-api.json get /locations/{locationId}/booking_availability
openapi: 3.1.0
info:
  title: Maple Developer API
  version: 0.0.1
  description: >-
    Public API for POS and platform partners to integrate with Maple: granted
    locations and connections, the order loop (validation, notification,
    accept/deny, status updates), payment-link visibility, menu publishing, and
    HMAC-signed webhooks. Authenticate every request with a Bearer API key
    (`mpk_test_…` / `mpk_live_…`). The credential determines the environment:
    test-mode credentials only see test data, live-mode credentials only see
    live data.
servers:
  - url: https://api.maple.inc/v1
    description: Production
  - url: https://api.staging.maple.inc/v1
    description: Sandbox (development and testing)
security: []
tags:
  - name: General
    description: Service status and credential introspection.
  - name: Locations
    description: The restaurant locations your app has been granted access to.
  - name: Connections
    description: Become (or stop being) a granted location’s order receiver.
  - name: Menu
    description: Publish and read a connected location’s menu.
  - name: Delivery zones
    description: >-
      Manage a connected location’s delivery zones and check whether a
      coordinate is deliverable.
  - name: Orders
    description: 'The order loop: read orders, submit validation results, and decide orders.'
  - name: Bookings
    description: >-
      Bookings (rolling out per location): a location’s booking profile,
      availability, holds, bookings, venue verbs, configuration, and live floor.
  - name: Webhooks
    description: Event-type catalog, subscriptions, the event ledger, and replay.
paths:
  /locations/{locationId}/booking_availability:
    get:
      tags:
        - Bookings
      summary: Search booking availability
      description: >-
        Bookable slots for a party at a granted location inside a venue-local
        window (at most 31 days). Every slot carries an opaque signed
        `slot_token`: pass it unchanged to `POST /booking_holds`, never rebuild
        slot parameters yourself. Quotes are bound to the partner channel and
        expire after 15 minutes. Typed outcomes (`party_size_out_of_bounds` with
        the bounds, `outside_booking_window`, `large_party_inquiry_required`
        with the venue’s inquiry contact, `bookings_not_enabled`) come back as
        422 with a `code`. Requires `bookings:read`.
      operationId: developer-api-bookings.getBookingAvailability
      parameters:
        - name: locationId
          in: path
          schema:
            type: string
          required: true
        - name: party_size
          in: query
          schema:
            type: string
            allOf:
              - pattern: ^[+-]?\d*\.?\d+(?:[Ee][+-]?\d+)?$
          required: true
        - name: start
          in: query
          schema:
            type: string
            description: >-
              Venue-local wall-clock start of the search window,
              `YYYY-MM-DDTHH:MM`.
          required: true
        - name: end
          in: query
          schema:
            type: string
            description: >-
              Venue-local wall-clock end of the search window,
              `YYYY-MM-DDTHH:MM`, at most 31 days after `start`.
          required: true
        - name: changing_booking_id
          in: query
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Reschedule mode: exclude this booking’s own claim from occupancy
              so its current slot (or a neighbour) can be re-quoted. The
              resulting `slot_token` is what `POST /bookings/{id}/change` takes.
          required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    enum:
                      - list
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        object:
                          type: string
                          enum:
                            - booking_slot
                        slot_token:
                          type: string
                        starts_at:
                          type: string
                        starts_at_local:
                          type: string
                        duration_minutes:
                          anyOf:
                            - anyOf:
                                - anyOf:
                                    - type: number
                                    - type: string
                                      enum:
                                        - NaN
                                    - type: string
                                      enum:
                                        - Infinity
                                    - type: string
                                      enum:
                                        - '-Infinity'
                                - type: string
                                  enum:
                                    - Infinity
                                    - '-Infinity'
                                    - NaN
                            - type: 'null'
                        area:
                          anyOf:
                            - type: object
                              properties:
                                ref:
                                  type: string
                                name:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                              required:
                                - ref
                                - name
                              additionalProperties: false
                            - type: 'null'
                          description: >-
                            The seating area the slot is quoted in, when the
                            provider names one.
                        cancellation_policy:
                          anyOf:
                            - type: object
                              properties:
                                type:
                                  type: string
                                currency:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                  description: ISO-4217.
                                policy_text:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                tiers:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      within_hours_before_start:
                                        anyOf:
                                          - anyOf:
                                              - type: number
                                              - type: string
                                                enum:
                                                  - NaN
                                              - type: string
                                                enum:
                                                  - Infinity
                                              - type: string
                                                enum:
                                                  - '-Infinity'
                                          - type: string
                                            enum:
                                              - Infinity
                                              - '-Infinity'
                                              - NaN
                                      basis:
                                        type: string
                                        description: '`per_party` or `per_person`.'
                                      amount_cents:
                                        anyOf:
                                          - anyOf:
                                              - anyOf:
                                                  - type: number
                                                  - type: string
                                                    enum:
                                                      - NaN
                                                  - type: string
                                                    enum:
                                                      - Infinity
                                                  - type: string
                                                    enum:
                                                      - '-Infinity'
                                              - type: string
                                                enum:
                                                  - Infinity
                                                  - '-Infinity'
                                                  - NaN
                                          - type: 'null'
                                      percent_bps:
                                        anyOf:
                                          - anyOf:
                                              - anyOf:
                                                  - type: number
                                                  - type: string
                                                    enum:
                                                      - NaN
                                                  - type: string
                                                    enum:
                                                      - Infinity
                                                  - type: string
                                                    enum:
                                                      - '-Infinity'
                                              - type: string
                                                enum:
                                                  - Infinity
                                                  - '-Infinity'
                                                  - NaN
                                          - type: 'null'
                                        description: >-
                                          Basis points of the party value, when
                                          the fee is a percentage.
                                    required:
                                      - within_hours_before_start
                                      - basis
                                      - amount_cents
                                      - percent_bps
                                    additionalProperties: false
                                deposit:
                                  anyOf:
                                    - type: object
                                      properties:
                                        amount_cents:
                                          anyOf:
                                            - anyOf:
                                                - type: number
                                                - type: string
                                                  enum:
                                                    - NaN
                                                - type: string
                                                  enum:
                                                    - Infinity
                                                - type: string
                                                  enum:
                                                    - '-Infinity'
                                            - type: string
                                              enum:
                                                - Infinity
                                                - '-Infinity'
                                                - NaN
                                        currency:
                                          type: string
                                        basis:
                                          type: string
                                      required:
                                        - amount_cents
                                        - currency
                                        - basis
                                      additionalProperties: false
                                    - type: 'null'
                              required:
                                - type
                                - currency
                                - policy_text
                                - tiers
                                - deposit
                              additionalProperties: false
                            - type: 'null'
                      required:
                        - object
                        - slot_token
                        - starts_at
                        - starts_at_local
                        - duration_minutes
                        - area
                        - cancellation_policy
                      additionalProperties: false
                required:
                  - object
                  - data
                additionalProperties: false
        '400':
          description: DeveloperApiBadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperApiBadRequest'
        '401':
          description: DeveloperApiUnauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperApiUnauthorized'
        '403':
          description: DeveloperApiForbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperApiForbidden'
        '404':
          description: DeveloperApiNotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperApiNotFound'
        '409':
          description: DeveloperApiConflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperApiConflict'
        '422':
          description: DeveloperApiUnprocessable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperApiUnprocessable'
        '429':
          description: DeveloperApiRateLimited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperApiRateLimited'
          headers:
            Retry-After:
              description: >-
                Seconds to wait before retrying; also returned as retry_after in
                the body.
              schema:
                type: integer
                minimum: 1
      security:
        - bearer: []
components:
  schemas:
    DeveloperApiBadRequest:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - DeveloperApiBadRequest
        code:
          type: string
        message:
          type: string
      required:
        - _tag
        - message
      additionalProperties: false
    DeveloperApiUnauthorized:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - DeveloperApiUnauthorized
        message:
          type: string
      required:
        - _tag
        - message
      additionalProperties: false
    DeveloperApiForbidden:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - DeveloperApiForbidden
        code:
          type: string
          enum:
            - insufficient_scope
            - wrong_environment
        message:
          type: string
      required:
        - _tag
        - code
        - message
      additionalProperties: false
    DeveloperApiNotFound:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - DeveloperApiNotFound
        message:
          type: string
      required:
        - _tag
        - message
      additionalProperties: false
    DeveloperApiConflict:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - DeveloperApiConflict
        code:
          type: string
        message:
          type: string
        details:
          type: object
      required:
        - _tag
        - message
      additionalProperties: false
    DeveloperApiUnprocessable:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - DeveloperApiUnprocessable
        code:
          type: string
        message:
          type: string
        details:
          type: object
      required:
        - _tag
        - code
        - message
      additionalProperties: false
    DeveloperApiRateLimited:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - DeveloperApiRateLimited
        message:
          type: string
        retry_after:
          anyOf:
            - type: number
            - type: string
              enum:
                - NaN
            - type: string
              enum:
                - Infinity
            - type: string
              enum:
                - '-Infinity'
      required:
        - _tag
        - message
        - retry_after
      additionalProperties: false
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: >-
        API key — `mpk_test_…` for the sandbox, `mpk_live_…` for production.
        Issued by Maple during partner onboarding.

````