Booqable Availability API

openapi: 3.0.3
info:
  title: Booqable API (v4 "Boomerang") Availability API
  description: The Booqable API is a RESTful, JSON:API-compliant interface for managing an equipment and inventory rental business - orders, products, product groups, customers, stock items, availability and plannings, documents and invoices, payments, bundles, collections, and webhooks. Requests are directed to a company-specific host in the form https://{company}.booqable.com/api/4 and authenticated with an access token (Bearer) or a signed single-use request. The default response media type is JSON:API (application/vnd.api+json); a nested JSON representation is available by appending .json to a path. The API is documented as still in Beta and may introduce non-backwards-compatible changes. A legacy v1 API also remains documented. This description was authored by API Evangelist from the public Booqable developer documentation; request and response schemas are modeled and simplified.
  version: '4'
  contact:
    name: Booqable
    url: https://developers.booqable.com/
  license:
    name: Proprietary
    url: https://booqable.com/terms/
servers:
- url: https://{company}.booqable.com/api/4
  description: Company-specific Booqable API v4 host
  variables:
    company:
      default: your-company
      description: Your Booqable company slug (subdomain).
security:
- bearerAuth: []
tags:
- name: Availability
  description: Inventory availability, levels, and plannings.
paths:
  /availabilities:
    get:
      operationId: getAvailabilities
      tags:
      - Availability
      summary: Get availabilities
      description: Returns availability information for orders, products, and downtimes over a period.
      responses:
        '200':
          description: Availability data.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ResourceCollection'
  /inventory_availabilities:
    get:
      operationId: getInventoryAvailabilities
      tags:
      - Availability
      summary: Get inventory availabilities
      description: Returns the available quantity for products and bundles over a requested period.
      responses:
        '200':
          description: Inventory availability data.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ResourceCollection'
  /inventory_levels:
    get:
      operationId: getInventoryLevels
      tags:
      - Availability
      summary: Get inventory levels
      description: Returns stock counts for products, optionally broken down by location.
      responses:
        '200':
          description: Inventory level data.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ResourceCollection'
  /plannings:
    get:
      operationId: listPlannings
      tags:
      - Availability
      summary: List plannings
      description: Lists and searches plannings - the records that reserve inventory against orders for a period.
      parameters:
      - $ref: '#/components/parameters/PageNumber'
      - $ref: '#/components/parameters/PageSize'
      responses:
        '200':
          description: A page of plannings.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ResourceCollection'
  /plannings/{id}:
    parameters:
    - $ref: '#/components/parameters/Id'
    get:
      operationId: getPlanning
      tags:
      - Availability
      summary: Fetch a planning
      description: Retrieves a single planning by ID.
      responses:
        '200':
          description: The requested planning.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ResourceDocument'
components:
  parameters:
    PageNumber:
      name: page[number]
      in: query
      required: false
      description: The page number to return (JSON:API pagination).
      schema:
        type: integer
        minimum: 1
        default: 1
    PageSize:
      name: page[size]
      in: query
      required: false
      description: Number of records per page. Defaults to 25.
      schema:
        type: integer
        minimum: 1
        default: 25
    Id:
      name: id
      in: path
      required: true
      description: The UUID of the resource.
      schema:
        type: string
  schemas:
    ResourceDocument:
      type: object
      description: A JSON:API document containing a single primary resource.
      properties:
        data:
          $ref: '#/components/schemas/Resource'
        included:
          type: array
          items:
            $ref: '#/components/schemas/Resource'
        meta:
          type: object
          additionalProperties: true
    Resource:
      type: object
      description: A JSON:API resource object.
      properties:
        type:
          type: string
        id:
          type: string
        attributes:
          type: object
          additionalProperties: true
        relationships:
          type: object
          additionalProperties: true
    ResourceCollection:
      type: object
      description: A JSON:API document containing a collection of resources.
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Resource'
        included:
          type: array
          items:
            $ref: '#/components/schemas/Resource'
        meta:
          type: object
          description: Metadata such as total_count and pagination stats.
          additionalProperties: true
        links:
          type: object
          additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'An access token created in Booqable account settings, sent as "Authorization: Bearer <token>". Booqable also supports request signing (single-use signed tokens using ES256, RS256, or HS256) and, on the legacy v1 API, an api_key query parameter.'