Booqable

Booqable Bundles & Collections API

Merchandising groups and store collections.

Documentation GitHub OpenAPI

OpenAPI Specification

openapi: 3.0.3
info:
  title: Booqable API (v4 "Boomerang") Availability Bundles & Collections 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: Bundles & Collections
  description: Merchandising groups and store collections.
paths:
  /bundles:
    get:
      operationId: listBundles
      tags:
      - Bundles & Collections
      summary: List bundles
      description: Lists and searches bundles - packaged groups of products rented together.
      responses:
        '200':
          description: A page of bundles.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ResourceCollection'
    post:
      operationId: createBundle
      tags:
      - Bundles & Collections
      summary: Create a bundle
      description: Creates a new bundle.
      requestBody:
        $ref: '#/components/requestBodies/ResourceBody'
      responses:
        '201':
          description: The created bundle.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ResourceDocument'
  /bundles/{id}:
    parameters:
    - $ref: '#/components/parameters/Id'
    get:
      operationId: getBundle
      tags:
      - Bundles & Collections
      summary: Fetch a bundle
      description: Retrieves a single bundle by ID.
      responses:
        '200':
          description: The requested bundle.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ResourceDocument'
    patch:
      operationId: updateBundle
      tags:
      - Bundles & Collections
      summary: Update a bundle
      description: Updates an existing bundle.
      requestBody:
        $ref: '#/components/requestBodies/ResourceBody'
      responses:
        '200':
          description: The updated bundle.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ResourceDocument'
  /collections:
    get:
      operationId: listCollections
      tags:
      - Bundles & Collections
      summary: List collections
      description: Lists the store collections that organize catalog items.
      responses:
        '200':
          description: A page of collections.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ResourceCollection'
    post:
      operationId: createCollection
      tags:
      - Bundles & Collections
      summary: Create a collection
      description: Creates a new collection.
      requestBody:
        $ref: '#/components/requestBodies/ResourceBody'
      responses:
        '201':
          description: The created collection.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ResourceDocument'
components:
  requestBodies:
    ResourceBody:
      required: true
      description: A JSON:API document wrapping the resource under a "data" member.
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/ResourceDocument'
  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
  parameters:
    Id:
      name: id
      in: path
      required: true
      description: The UUID of the resource.
      schema:
        type: string
  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.'

Where this information came from

This is an independent, third-party profile of Booqable Bundles & Collections API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.

Booqable Bundles & Collections API

Documentation

Specifications

Other Resources

OpenAPI Specification