> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Booqable

The Booqable connector lets your AI agent act in each user's Booqable account. Each user connects their own Booqable access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 50 tools.

**Authentication:** Bearer Token
**Categories:** Calendar, CRM & Sales
**Tools:** 50: 32 read, 14 write, 4 destructive
**Users sign in with:** Access token
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=BOOQABLE)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Booqable connection

   In **AgentKit > Connections**, create a Booqable connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'booqable'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Booqable:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'booqable_bundles_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "booqable"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Booqable:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="booqable_bundles_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Booqable credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'booqable_bundle_get',
  toolInput: {
    id: '<id>',
  },
  connector: 'booqable',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="booqable_bundle_get",
    tool_input={
        "id": "<id>",
    },
    connection_name="booqable",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `booqable_bundle_get`

Get Bundle · Read-only

Get one bundle; include bundle_items to see its contents.
Returns data with the bundles record's id and attributes.
Get the ID from booqable_bundles_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=photo,bundle_items,tax_category. Example: bundle_items

Example input: `{"id":"<id>"}`

### `booqable_bundles_list`

List Bundles · Read-only

List bundles (packages of products rented together).
Returns data, a list of bundles records (id, type, attributes), with sideloaded records in included.
Use booqable_bundle_get for one bundle.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `archived` (`boolean`, optional): Filter on archived (operators: eq). Example: true
- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=photo,inventory_levels. Example: photo
- `page` (`string`, optional): The page to request. Example: 1
- `page_size` (`string`, optional): The amount of items per page. Example: 25
- `q` (`string`, optional): Filter on q (operators: eq). Example: example
- `sort` (`string`, optional): How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at

Example input: `{}`

### `booqable_collections_list`

List Collections · Read-only

List store collections (product categories).
Returns data, a list of collections records (id, type, attributes), with sideloaded records in included.
Use the collection ID to filter items in the online store.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`string`, optional): The page to request. Example: 1
- `page_size` (`string`, optional): The amount of items per page. Example: 25
- `parent_id` (`string`, optional): Filter on parent_id (operators: eq, not_eq). Example: example
- `q` (`string`, optional): Filter on q (operators: eq). Example: example
- `sort` (`string`, optional): How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at

Example input: `{}`

### `booqable_company_get`

Get Company · Read-only

Get the Booqable company the token belongs to, with address, currency, timezone and plan details.
Returns data, a list of companies records (id, type, attributes), with sideloaded records in included.
Use this to confirm the connection.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `booqable_coupons_list`

List Coupons · Read-only

List discount coupons with code, value, type and limits.
Returns data, a list of coupons records (id, type, attributes), with sideloaded records in included.
Use booqable_coupon_create to add one.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `active` (`boolean`, optional): Filter on active (operators: eq). Example: true
- `archived` (`boolean`, optional): Filter on archived (operators: eq). Example: true
- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=coupon_items. Example: coupon_items
- `page` (`string`, optional): The page to request. Example: 1
- `page_size` (`string`, optional): The amount of items per page. Example: 25
- `q` (`string`, optional): Filter on q (operators: eq). Example: example
- `sort` (`string`, optional): How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at

Example input: `{}`

### `booqable_customer_get`

Get Customer · Read-only

Get one customer with contact details, deposit and discount defaults, tags and order totals.
Returns data with the customers record's id and attributes.
Get the customer ID from booqable_customers_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=barcode,properties,tax_region. Example: barcode

Example input: `{"id":"<id>"}`

### `booqable_customers_list`

List Customers · Read-only

List customers, optionally searching by name or email (q) or filtering by email, tag or archived state.
Returns data, a list of customers records (id, type, attributes), with sideloaded records in included.
Use booqable_customer_get for one customer.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `archived` (`boolean`, optional): Filter on archived (operators: eq). Example: true
- `email` (`string`, optional): Filter on email (operators: eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match). Example: jane@example.com
- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=barcode,properties,tax_region. Example: barcode
- `name` (`string`, optional): Filter on name (operators: eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match). Example: Example name
- `page` (`string`, optional): The page to request. Example: 1
- `page_size` (`string`, optional): The amount of items per page. Example: 25
- `q` (`string`, optional): Filter on q (operators: eq). Example: example
- `sort` (`string`, optional): How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
- `tag_list` (`string`, optional): Filter on tag_list (operators: eq). Example: example

Example input: `{}`

### `booqable_document_get`

Get Document · Read-only

Get one quote, contract or invoice with totals and status; include lines to sideload them.
Returns data with the documents record's id and attributes.
Get the ID from booqable_documents_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=signature,coupon,properties. Example: lines

Example input: `{"id":"<id>"}`

### `booqable_documents_list`

List Documents · Read-only

List quotes, contracts and invoices, by order, customer, type or status.
Returns data, a list of documents records (id, type, attributes), with sideloaded records in included.
Use booqable_document_get for one document.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_id` (`string`, optional): Filter on customer_id (operators: eq, not_eq). Example: example
- `document_type` (`string`, optional): Filter on document_type (operators: eq, not_eq). Example: example
- `finalized` (`boolean`, optional): Filter on finalized (operators: eq). Example: true
- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=customer,order. Example: customer
- `order_id` (`string`, optional): Filter on order_id (operators: eq, not_eq). Example: example
- `page` (`string`, optional): The page to request. Example: 1
- `page_size` (`string`, optional): The amount of items per page. Example: 25
- `q` (`string`, optional): Filter on q (operators: eq). Example: example
- `sort` (`string`, optional): How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at

Example input: `{}`

### `booqable_emails_list`

List Emails · Read-only

List emails sent from Booqable, by customer, order or template.
Returns data, a list of emails records (id, type, attributes), with sideloaded records in included.
Use booqable_email_send to send one.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_id` (`string`, optional): Filter on customer_id (operators: eq, not_eq). Example: example
- `email_template_id` (`string`, optional): Filter on email_template_id (operators: eq, not_eq). Example: jane@example.com
- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=customer,order. Example: customer
- `order_id` (`string`, optional): Filter on order_id (operators: eq, not_eq). Example: example
- `page` (`string`, optional): The page to request. Example: 1
- `page_size` (`string`, optional): The amount of items per page. Example: 25
- `sort` (`string`, optional): How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at

Example input: `{}`

### `booqable_employees_list`

List Employees · Read-only

List the employees (staff accounts) in the company.
Returns data, a list of employees records (id, type, attributes), with sideloaded records in included.
Use this to find who made a change.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `active` (`boolean`, optional): Filter on active (operators: eq). Example: true
- `email` (`string`, optional): Filter on email (operators: eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match). Example: jane@example.com
- `page` (`string`, optional): The page to request. Example: 1
- `page_size` (`string`, optional): The amount of items per page. Example: 25
- `sort` (`string`, optional): How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at

Example input: `{}`

### `booqable_inventory_levels_list`

List Inventory Levels · Read-only

Get stock and availability levels for items over a period, per location.
Returns data, a list of inventory_levels records (id, type, attributes), with sideloaded records in included.
Pass from and till; filter by item, location or order.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `from` (`string`, optional): Filter on from (operators: eq). Example: example
- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=item,location. Example: item
- `item_id` (`string`, optional): Filter on item_id (operators: eq). Example: example
- `location_id` (`string`, optional): Filter on location_id (operators: eq). Example: example
- `order_id` (`string`, optional): Filter on order_id (operators: eq). Example: example
- `page` (`string`, optional): The page to request. Example: 1
- `page_size` (`string`, optional): The amount of items per page. Example: 25
- `sort` (`string`, optional): How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
- `till` (`string`, optional): Filter on till (operators: eq). Example: example

Example input: `{}`

### `booqable_item_get`

Get Item · Read-only

Get one item (product or bundle).
Returns data with the items record's id and attributes.
Get the ID from booqable_items_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=barcode,bundle_items,collection_items. Example: barcode

Example input: `{"id":"<id>"}`

### `booqable_items_list`

List Items · Read-only

List all bookable items (products and bundles) in one list, by search text or type.
Returns data, a list of items records (id, type, attributes), with sideloaded records in included.
Use this to find an item ID for lines, plannings and inventory.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `archived` (`boolean`, optional): Filter on archived (operators: eq). Example: true
- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=barcode,bundle_items,collection_items. Example: barcode
- `page` (`string`, optional): The page to request. Example: 1
- `page_size` (`string`, optional): The amount of items per page. Example: 25
- `q` (`string`, optional): Filter on q (operators: eq). Example: example
- `sort` (`string`, optional): How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
- `tag_list` (`string`, optional): Filter on tag_list (operators: eq). Example: example
- `type` (`string`, optional): Filter on type (operators: eq, not_eq). Example: example

Example input: `{}`

### `booqable_line_get`

Get Line · Read-only

Get one line with quantity, price and planning.
Returns data with the lines record's id and attributes.
Get the line ID from booqable_lines_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=order,owner,tax_category. Example: order

Example input: `{"id":"<id>"}`

### `booqable_lines_list`

List Lines · Read-only

List order or document lines (items and charges), filtered by order, owner or item.
Returns data, a list of lines records (id, type, attributes), with sideloaded records in included.
Use this to see what is on an order.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=order,owner,tax_category. Example: order
- `item_id` (`string`, optional): Filter on item_id (operators: eq, not_eq). Example: example
- `order_id` (`string`, optional): Filter on order_id (operators: eq). Example: example
- `owner_id` (`string`, optional): Filter on owner_id (operators: eq, not_eq). Example: example
- `page` (`string`, optional): The page to request. Example: 1
- `page_size` (`string`, optional): The amount of items per page. Example: 25
- `sort` (`string`, optional): How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at

Example input: `{}`

### `booqable_locations_list`

List Locations · Read-only

List pickup and warehouse locations.
Returns data, a list of locations records (id, type, attributes), with sideloaded records in included.
Use location IDs for orders and stock items.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `archived` (`boolean`, optional): Filter on archived (operators: eq). Example: true
- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=carriers. Example: carriers
- `location_type` (`string`, optional): Filter on location_type (operators: eq). Example: example
- `page` (`string`, optional): The page to request. Example: 1
- `page_size` (`string`, optional): The amount of items per page. Example: 25
- `sort` (`string`, optional): How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at

Example input: `{}`

### `booqable_notes_list`

List Notes · Read-only

List internal notes, optionally for one customer, order or product (owner).
Returns data, a list of notes records (id, type, attributes), with sideloaded records in included.
Use booqable_note_create to add one.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=employee,owner. Example: employee
- `owner_id` (`string`, optional): Filter on owner_id (operators: eq, not_eq). Example: example
- `owner_type` (`string`, optional): Filter on owner_type (operators: eq, not_eq). Example: example
- `page` (`string`, optional): The page to request. Example: 1
- `page_size` (`string`, optional): The amount of items per page. Example: 25
- `sort` (`string`, optional): How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at

Example input: `{}`

### `booqable_order_get`

Get Order · Read-only

Get one order with its period, status, totals, deposit and payment status; include lines or customer to sideload them.
Returns data with the orders record's id and attributes.
Get the order ID from booqable_orders_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=barcode,coupon,customer. Example: customer,lines

Example input: `{"id":"<id>"}`

### `booqable_orders_list`

List Orders · Read-only

List rental orders, optionally by search text, customer, status, payment status or start time.
Returns data, a list of orders records (id, type, attributes), with sideloaded records in included.
Use booqable_order_get for one order with its lines.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_id` (`string`, optional): Filter on customer_id (operators: eq, not_eq). Example: example
- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=customer,coupon,start_location. Example: customer
- `number` (`integer`, optional): Filter on number (operators: eq, not_eq, gt, gte, lt, lte). Example: 10
- `page` (`string`, optional): The page to request. Example: 1
- `page_size` (`string`, optional): The amount of items per page. Example: 25
- `payment_status` (`string`, optional): Filter on payment_status (operators: eq). Example: example
- `q` (`string`, optional): Filter on q (operators: eq). Example: example
- `sort` (`string`, optional): How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
- `starts_at` (`string`, optional): Filter on starts_at (operators: eq, not_eq, gt, gte, lt, lte). Example: example
- `status` (`string`, optional): Filter on status (operators: eq, not_eq). Example: example
- `stops_at` (`string`, optional): Filter on stops_at (operators: eq, not_eq, gt, gte, lt, lte). Example: example

Example input: `{}`

### `booqable_payment_get`

Get Payment · Read-only

Get one payment.
Returns data with the payments record's id and attributes.
Get the ID from booqable_payments_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=order,cart,payment_method. Example: order

Example input: `{"id":"<id>"}`

### `booqable_payments_list`

List Payments · Read-only

List payments with amounts, provider, status times and linked order or customer.
Returns data, a list of payments records (id, type, attributes), with sideloaded records in included.
Filter by order or customer.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_id` (`string`, optional): Filter on customer_id (operators: eq, not_eq). Example: example
- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=order,cart,payment_method. Example: order
- `order_id` (`string`, optional): Filter on order_id (operators: eq, not_eq). Example: example
- `page` (`string`, optional): The page to request. Example: 1
- `page_size` (`string`, optional): The amount of items per page. Example: 25
- `sort` (`string`, optional): How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at

Example input: `{}`

### `booqable_planning_get`

Get Planning · Read-only

Get one planning.
Returns data with the plannings record's id and attributes.
Get the ID from booqable_plannings_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=order,item,downtime. Example: order

Example input: `{"id":"<id>"}`

### `booqable_plannings_list`

List Plannings · Read-only

List plannings (reservations of items for orders) with periods, quantities, status and shortages.
Returns data, a list of plannings records (id, type, attributes), with sideloaded records in included.
Use this to see when items are booked.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=order,item,downtime. Example: order
- `item_id` (`string`, optional): Filter on item_id (operators: eq, not_eq). Example: example
- `order_id` (`string`, optional): Filter on order_id (operators: eq, not_eq). Example: example
- `page` (`string`, optional): The page to request. Example: 1
- `page_size` (`string`, optional): The amount of items per page. Example: 25
- `sort` (`string`, optional): How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
- `starts_at` (`string`, optional): Filter on starts_at (operators: eq, not_eq, gt, gte, lt, lte). Example: example
- `status` (`string`, optional): Filter on status (operators: eq). Example: example
- `stops_at` (`string`, optional): Filter on stops_at (operators: eq, not_eq, gt, gte, lt, lte). Example: example

Example input: `{}`

### `booqable_product_get`

Get Product · Read-only

Get one product variation.
Returns data with the products record's id and attributes.
Get the ID from booqable_products_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=barcode,inventory_levels,photo. Example: barcode

Example input: `{"id":"<id>"}`

### `booqable_product_group_get`

Get Product Group · Read-only

Get one product group with pricing, deposit, tracking and store settings.
Returns data with the product_groups record's id and attributes.
Get the ID from booqable_product_groups_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=photo,properties,tax_category. Example: photo

Example input: `{"id":"<id>"}`

### `booqable_product_groups_list`

List Product Groups · Read-only

List product groups (rentable products with their pricing, deposit and tracking settings).
Returns data, a list of product_groups records (id, type, attributes), with sideloaded records in included.
Use booqable_products_list for variations.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `archived` (`boolean`, optional): Filter on archived (operators: eq). Example: true
- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=photo,properties,price_structure. Example: photo
- `page` (`string`, optional): The page to request. Example: 1
- `page_size` (`string`, optional): The amount of items per page. Example: 25
- `q` (`string`, optional): Filter on q (operators: eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match). Example: example
- `sku` (`string`, optional): Filter on sku (operators: eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match). Example: example
- `sort` (`string`, optional): How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
- `tag_list` (`string`, optional): Filter on tag_list (operators: eq). Example: example

Example input: `{}`

### `booqable_products_list`

List Products · Read-only

List products (the bookable variations of product groups).
Returns data, a list of products records (id, type, attributes), with sideloaded records in included.
Use booqable_product_groups_list for product-level settings.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `archived` (`boolean`, optional): Filter on archived (operators: eq). Example: true
- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=barcode,inventory_levels,photo. Example: barcode
- `page` (`string`, optional): The page to request. Example: 1
- `page_size` (`string`, optional): The amount of items per page. Example: 25
- `product_group_id` (`string`, optional): Filter on product_group_id (operators: eq, not_eq). Example: example
- `q` (`string`, optional): Filter on q (operators: eq). Example: example
- `sku` (`string`, optional): Filter on sku (operators: eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match). Example: example
- `sort` (`string`, optional): How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at

Example input: `{}`

### `booqable_stock_item_get`

Get Stock Item · Read-only

Get one stock item.
Returns data with the stock_items record's id and attributes.
Get the ID from booqable_stock_items_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=barcode,location,properties. Example: barcode

Example input: `{"id":"<id>"}`

### `booqable_stock_items_list`

List Stock Items · Read-only

List stock items (individually tracked units) with identifier, location and status.
Returns data, a list of stock_items records (id, type, attributes), with sideloaded records in included.
Filter by product to see one product's units.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `archived` (`boolean`, optional): Filter on archived (operators: eq). Example: true
- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=product,barcode,location. Example: product
- `location_id` (`string`, optional): Filter on location_id (operators: eq, not_eq). Example: example
- `page` (`string`, optional): The page to request. Example: 1
- `page_size` (`string`, optional): The amount of items per page. Example: 25
- `product_group_id` (`string`, optional): Filter on product_group_id (operators: eq, not_eq). Example: example
- `product_id` (`string`, optional): Filter on product_id (operators: eq, not_eq). Example: example
- `q` (`string`, optional): Filter on q (operators: eq). Example: example
- `sort` (`string`, optional): How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
- `status` (`string`, optional): Filter on status (operators: eq). Example: example

Example input: `{}`

### `booqable_tags_list`

List Tags · Read-only

List the tags used on a resource type (customers, orders, products).
Returns data, a list of tags records (id, type, attributes), with sideloaded records in included.
Use tag names in tag_list fields.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `for` (`string`, optional): Filter on for (operators: eq). Example: example

Example input: `{}`

### `booqable_tax_rates_list`

List Tax Rates · Read-only

List tax rates.
Returns data, a list of tax_rates records (id, type, attributes), with sideloaded records in included.
Use with tax region and category settings.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=owner. Example: owner
- `page` (`string`, optional): The page to request. Example: 1
- `page_size` (`string`, optional): The amount of items per page. Example: 25
- `sort` (`string`, optional): How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at

Example input: `{}`

### `booqable_coupon_create`

Create Coupon · Write

Create a discount coupon with a code, percentage or fixed value, date range and redemption limits.
Returns data with the coupons record's id and attributes.
Apply it to an order with booqable_order_update (coupon_id).

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `coupon_type` (`string`, required): How the discount is calculated. Immutable. Example: percentage
- `identifier` (`string`, required): The code that customers need to type in. Immutable. Example: SPRING10
- `value` (`integer`, required): A percentage for type percentage or a value in cents for cents. Example: 10
- `active` (`boolean`, optional): Whether coupon can be redeemed at the moment. Example: true
- `ends_at` (`string`, optional): Optional end date for redeeming the coupon. Saved at the end of the selected day. Only applied when the coupons improvements feature is enabled; otherwise silently forced to null. Example: 2026-01-15T09:00:00Z
- `max_redemptions` (`integer`, optional): Optional maximum number of times the coupon can be redeemed. Set to null for unlimited redemptions. Only applied when the coupons improvements feature is enabled; otherwise silently forced to null. Example: 10
- `minimum_order_amount_in_cents` (`integer`, optional): Optional minimum order amount in cents required to redeem this coupon. Only applied when the coupons improvements feature is enabled; otherwise silently forced to null. Example: 10
- `one_per_customer` (`boolean`, optional): Optional, whether the coupon can be redeemed only once per customer. Only applied when the coupons improvements feature is enabled; otherwise silently forced to false. Example: true
- `stackable` (`boolean`, optional): Optional, whether the coupon can be combined with a customer discount. Only applied when the coupons improvements feature is enabled; otherwise silently forced to true. Example: true
- `starts_at` (`string`, optional): Optional start date for redeeming the coupon. Saved at the start of the selected day. Only applied when the coupons improvements feature is enabled; otherwise silently forced to null. Example: 2026-03-01T09:00:00

Example input: `{"coupon_type":"<coupon_type>","identifier":"<identifier>","value":10}`

### `booqable_customer_create`

Create Customer · Write

Create a customer (person or company) with email, tags and default deposit and discount.
Returns data with the customers record's id and attributes.
Use booqable_customer_update to change one.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Person or Company name. Example: John Doe
- `deposit_type` (`string`, optional): The deposit added to new orders of this customer by default. Example: example
- `deposit_value` (`number`, optional): The value to use for deposit_type. Example: 10
- `discount_percentage` (`number`, optional): Default discount applied to each new order for this customer. Example: 10
- `email` (`string`, optional): Email address used for communication. Example: john@example.com
- `email_marketing_consented` (`boolean`, optional): Whether the customer has consented to receive email marketing. Example: true
- `legal_type` (`string`, optional): Either person or commercial. Example: example
- `tag_list` (`array`, optional): Case insensitive tag list. Example: ["vip"]
- `tax_region_id` (`string`, optional): Tax region assigned to new orders for this customer. Example: d4e5f6a7-b8c9-d0e1-f2a3-b4c5d6e7f8a9

Example input: `{"name":"<name>"}`

### `booqable_customer_update`

Update Customer · Write

Update a customer's name, email, type, deposit and discount defaults or tags.
Returns data with the customers record's id and attributes.
Get the customer ID from booqable_customers_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
- `deposit_type` (`string`, optional): The deposit added to new orders of this customer by default. Example: example
- `deposit_value` (`number`, optional): The value to use for deposit_type. Example: 10
- `discount_percentage` (`number`, optional): Default discount applied to each new order for this customer. Example: 10
- `email` (`string`, optional): Email address used for communication. Example: john@example.com
- `email_marketing_consented` (`boolean`, optional): Whether the customer has consented to receive email marketing. Example: true
- `legal_type` (`string`, optional): Either person or commercial. Example: example
- `name` (`string`, optional): Person or Company name. Example: John Doe
- `tag_list` (`array`, optional): Case insensitive tag list. Example: ["vip"]
- `tax_region_id` (`string`, optional): Tax region assigned to new orders for this customer. Example: d4e5f6a7-b8c9-d0e1-f2a3-b4c5d6e7f8a9

Example input: `{"id":"<id>"}`

### `booqable_email_send`

Send Email · Write

Send an email from Booqable to recipients, optionally using a template and attaching documents for an order.
Returns data with the emails record's id and attributes.
This emails the recipients immediately.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `recipients` (`string`, required): Comma-separated list of recipient email addresses. All addresses must be valid and properly formatted for the email to be sent. The system validates each address before sending. Multiple recipients can be specified, but there is a limit on the maximum number of recipients per email to prevent abuse. The limit is 10 recipients per email. Example: john@example.com,jane@example.com
- `body` (`string`, optional): The main content of the email. When providing the body directly (without using an EmailTemplate), this is the final text that will be sent. When using a template, this field is automatically populated by rendering the template with data from associated resources. Example: Customer asked for early delivery.
- `customer_id` (`string`, optional): The Customer this email is associated with. When specified and using an EmailTemplate, customer data is available during template rendering. This relationship is useful for customer-specific communications that aren't tied to a particular order, or for providing customer context when an order relationship is also present. The customer's email address is typically used as the default recipient. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
- `document_ids` (`array`, optional): Array of Document IDs to attach to the email as PDF attachments. When the email is sent, each document will be rendered as a PDF and included as an attachment. Common use cases include attaching quotes, contracts, or invoices to customer communications. Note that this is different from document_id, which is used for template variable rendering. Example: ["value"]
- `email_template_id` (`string`, optional): The EmailTemplate used to generate this email's content. When specified, the template is rendered with data from the associated resources to populate the email's subject and body. Templates allow for consistent, branded communication with dynamic content. Example: b293d4e5-f6a7-b8c9-d0e1-f2a3b4c5d6e7
- `order_id` (`string`, optional): The Order this email is associated with. When an email is linked to an order and uses an EmailTemplate, the template can access order data during rendering. Linking an email to an order also helps maintain a clear communication history for that rental transaction. Example: 6f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
- `subject` (`string`, optional): The subject line of the email. When providing the subject directly (without using an EmailTemplate), this is the exact text that will appear in the recipient's inbox. When using a template, this field is automatically populated by rendering the template's subject with the available data from associated resources. Example: Your rental quote

Example input: `{"recipients":"<recipients>"}`

### `booqable_line_create`

Create Line · Write

Add a custom charge or section line to an order or document (owner), with title, quantity and price.
Returns data with the lines record's id and attributes.
Products are booked through Booqable's order fulfillment actions; use this for extra charges. Get the order ID from booqable_orders_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `owner_id` (`string`, required): The resource this Line belongs to. Either the Order directly, or a Document. Example: 6f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
- `owner_type` (`string`, required): The resource type of the owner. One of: orders, documents. Example: orders. One of: `orders`, `documents`.
- `discountable` (`boolean`, optional): Whether line is discountable. Example: true
- `extra_information` (`string`, optional): Extra information about the line. Example: example
- `line_type` (`string`, optional): Type of line. Can be one of: - charge: Regular charge line for rental items or custom charges - section: Visual section for organizing lines (no financial impact) - deposit_charge: Deposit charge line - proration: Partial charge for partial rental periods (invoices only) - refund: Refund line with negative amount - delivery_rate: Delivery charge based on carrier rates - legacy_migration: Legacy proration line Only charge and section line types can be created through the resource. Other types are created by the system. One of: section, deposit_charge, proration, charge, legacy_migration,... Example: section. One of: `section`, `deposit_charge`, `proration`, `charge`, `legacy_migration`, `delivery_rate`.
- `position` (`integer`, optional): The ordering of lines on an order or document. See this section to understand how to sort when using bundles. Example: 10
- `price_each_in_cents` (`integer`, optional): Price of each line. Example: 2500
- `quantity` (`integer`, optional): The quantity to calculate with. When updating quantity of a line with an associated planning, the planning also gets updated, which may lead to a shortage error. Example: 2
- `taxable` (`boolean`, optional): Whether line is taxable. Example: true
- `title` (`string`, optional): Title of the line. Example: Tent 4x4m

Example input: `{"owner_id":"<owner_id>","owner_type":"orders"}`

### `booqable_line_update`

Update Line · Write

Update a line's title, quantity, price, notes or tax flags.
Returns data with the lines record's id and attributes.
Get the line ID from booqable_lines_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
- `confirm_shortage` (`boolean`, optional): Whether to confirm a shortage when updating quantity on a line. When a line has an associated planning and you increase the quantity, the planning's quantity will also be increased. If this results in a shortage (requested quantity exceeds available inventory), the update will fail with a shortage error. Setting this to true confirms that you want to proceed with the update despite the shortage. This is useful when you know you'll be able to fulfill the order through other means, such as acquiring additional inventory before the rental period. Overriding shortage warnings is only possible... Example: true
- `discountable` (`boolean`, optional): Whether line is discountable. Example: true
- `extra_information` (`string`, optional): Extra information about the line. Example: example
- `position` (`integer`, optional): The ordering of lines on an order or document. See this section to understand how to sort when using bundles. Example: 10
- `price_each_in_cents` (`integer`, optional): Price of each line. Example: 2500
- `quantity` (`integer`, optional): The quantity to calculate with. When updating quantity of a line with an associated planning, the planning also gets updated, which may lead to a shortage error. Example: 2
- `taxable` (`boolean`, optional): Whether line is taxable. Example: true
- `title` (`string`, optional): Title of the line. Example: Tent 4x4m

Example input: `{"id":"<id>"}`

### `booqable_note_create`

Create Note · Write

Add an internal note to a customer, order, product or other record.
Returns data with the notes record's id and attributes.
owner_type is the plural resource name, for example customers or orders.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `body` (`string`, required): The content of the note. Example: Customer asked for early delivery.
- `owner_id` (`string`, required): The resource this note is about. Example: 6f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
- `owner_type` (`string`, required): The resource type of the owner. One of: customers, product_groups, products, stock_items, bundles, orders, documents, users. Example: orders. One of: `customers`, `product_groups`, `products`, `stock_items`, `bundles`, `orders`, `documents`, `users`.
- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=employee,owner. Example: employee

Example input: `{"body":"<body>","owner_id":"<owner_id>","owner_type":"customers"}`

### `booqable_order_create`

Create Order · Write

Create a rental order for a customer and period, as new, draft or reserved.
Returns data with the orders record's id and attributes.
Add items with booqable_line_create and change status with booqable_order_status_transition.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `confirm_shortage` (`boolean`, optional): When set to true, this confirms a shortage warning during an update operation. Use this parameter when you receive a shortage warning but want to proceed with the update despite the shortage. Overriding shortage is only possible when the affected ProductGroup is configured to allow shortage. Example: true
- `coupon_id` (`string`, optional): The Coupon added to this Order. Example: 41b293d4-e5f6-a7b8-c9d0-e1f2a3b4c5d6
- `customer_id` (`string`, optional): The Customer this Order is for. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
- `deposit_type` (`string`, optional): How deposit is calculated. One of: none, percentage_total, percentage, fixed. Example: none. One of: `none`, `percentage_total`, `percentage`, `fixed`.
- `deposit_value` (`number`, optional): The value to use for deposit_type. Example: 10
- `discount_type` (`string`, optional): Type of discount. One of: percentage, fixed. Example: percentage. One of: `percentage`, `fixed`.
- `discount_value` (`number`, optional): The value to use for discount_type. Example: 10
- `fulfillment_type` (`string`, optional): Indicates the process used to fulfill this order. Values can be pickup (customer collects items from a location) or delivery (items are delivered to the customer's address). This affects which address fields are required and whether delivery charges apply. One of: pickup, delivery. Example: pickup. One of: `pickup`, `delivery`.
- `start_location_id` (`string`, optional): The Location where the customer will pick up the items. Example: 0a41b293-d4e5-f6a7-b8c9-d0e1f2a3b4c5
- `starts_at` (`string`, optional): When the items on the order become unavailable. This is the date/time when the rental period officially begins. Changing this date may result in shortages if the items are no longer available for the new time period. Date and time at the company's location, with no time zone conversion applied. See Rental Period and Time Zones. Example: 2026-03-01T09:00:00
- `status` (`string`, optional): Simplified status of the order. An order can be in a mixed state (i.e. partially started or stopped). The statuses attribute contains the full list of current statuses, and status_counts specifies how many items are in each state. This attribute can only be written when creating an order. Accepted statuses are new, draft and reserved. One of: new, draft, reserved, started, stopped, archived, canceled. Example: new. One of: `new`, `draft`, `reserved`, `started`, `stopped`, `archived`, `canceled`.
- `stop_location_id` (`string`, optional): The Location where the customer will return the items. Example: 0a41b293-d4e5-f6a7-b8c9-d0e1f2a3b4c5
- `stops_at` (`string`, optional): When the items on the order become available again. This is the date/time when the rental period officially ends, and inventory becomes available for other orders after this point. Extending this date may result in shortages if the items are already booked for other orders. Date and time at the company's location, with no time zone conversion applied. See Rental Period and Time Zones. Example: 2026-03-05T17:00:00
- `tag_list` (`array`, optional): Case insensitive tag list. Example: ["vip"]

Example input: `{}`

### `booqable_order_status_transition`

Change Order Status · Write

Move an order from one status to another (for example new to reserved, or reserved to canceled), optionally reverting or confirming a shortage.
Returns data with the order_status_transitions record's id and attributes.
Get the current status from booqable_order_get. Get the order ID from booqable_orders_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `order_id` (`string`, required): The Order whose status is changed. Example: 6f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
- `transition_from` (`string`, required): The current status of the Order. One of: new, draft, reserved, started, stopped, archived. Example: new. One of: `new`, `draft`, `reserved`, `started`, `stopped`, `archived`.
- `transition_to` (`string`, required): The new status of the Order. It is only possible to transition to started or stopped in combination with revert: true. One of: draft, reserved, started, stopped, archived, canceled. Example: reserved. One of: `draft`, `reserved`, `started`, `stopped`, `archived`, `canceled`.
- `confirm_shortage` (`boolean`, optional): A value of true overrides shortage warnings. This is only possible when _reserving_ an Order. Example: true
- `include` (`string`, optional): List of comma seperated relationships to sideload. ?include=order. Example: order
- `revert` (`boolean`, optional): Indicates if this transition reverts the Order back to an earlier status. "Earlier status" does not require this specific Order to ever have been in that status (e.g. draft can have been skipped). "Earlier" means earlier in the conceptual progressing of statuses of Orders in general. Example: true

Example input: `{"order_id":"<order_id>","transition_from":"new","transition_to":"draft"}`

### `booqable_order_update`

Update Order · Write

Update an order's customer, rental period, locations, deposit, discount, coupon or tags.
Returns data with the orders record's id and attributes.
Use booqable_order_status_transition to change status. Get the order ID from booqable_orders_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
- `confirm_shortage` (`boolean`, optional): When set to true, this confirms a shortage warning during an update operation. Use this parameter when you receive a shortage warning but want to proceed with the update despite the shortage. Overriding shortage is only possible when the affected ProductGroup is configured to allow shortage. Example: true
- `coupon_id` (`string`, optional): The Coupon added to this Order. Example: 41b293d4-e5f6-a7b8-c9d0-e1f2a3b4c5d6
- `customer_id` (`string`, optional): The Customer this Order is for. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
- `deposit_type` (`string`, optional): How deposit is calculated. One of: none, percentage_total, percentage, fixed. Example: none. One of: `none`, `percentage_total`, `percentage`, `fixed`.
- `deposit_value` (`number`, optional): The value to use for deposit_type. Example: 10
- `discount_type` (`string`, optional): Type of discount. One of: percentage, fixed. Example: percentage. One of: `percentage`, `fixed`.
- `discount_value` (`number`, optional): The value to use for discount_type. Example: 10
- `fulfillment_type` (`string`, optional): Indicates the process used to fulfill this order. Values can be pickup (customer collects items from a location) or delivery (items are delivered to the customer's address). This affects which address fields are required and whether delivery charges apply. One of: pickup, delivery. Example: pickup. One of: `pickup`, `delivery`.
- `start_location_id` (`string`, optional): The Location where the customer will pick up the items. Example: 0a41b293-d4e5-f6a7-b8c9-d0e1f2a3b4c5
- `starts_at` (`string`, optional): When items become unavailable, changing this value may result in shortages. Example: 2026-03-01T09:00:00
- `stop_location_id` (`string`, optional): The Location where the customer will return the items. Example: 0a41b293-d4e5-f6a7-b8c9-d0e1f2a3b4c5
- `stops_at` (`string`, optional): When items become available, changing this value may result in shortages. Example: 2026-03-05T17:00:00
- `tag_list` (`array`, optional): Case insensitive tag list. Example: ["vip"]

Example input: `{"id":"<id>"}`

### `booqable_product_group_create`

Create Product Group · Write

Create a rentable product with name, SKU, tracking type, price type and period, base price and deposit.
Returns data with the product_groups record's id and attributes.
Use booqable_stock_item_create to add trackable units.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Name of the item. Example: John Doe
- `allow_shortage` (`boolean`, optional): Whether shortages are allowed. Changing this setting affects availability, and can trigger a shortage warning. Example: true
- `buffer_time_after` (`integer`, optional): The amount of seconds the item should be unavailable after a reservation. Changing this setting affects availability, and can trigger a shortage warning. This attribute is called lag_time in the v1 api and v1 webhooks. Example: 10
- `buffer_time_before` (`integer`, optional): The amount of seconds the item should be unavailable before a reservation. Changing this setting affects availability, and can trigger a shortage warning. This attribute is called lead_time in the v1 api and v1 webhooks. Example: 10
- `deposit_in_cents` (`integer`, optional): The value to use for deposit calculations. Example: 10000
- `discountable` (`boolean`, optional): Whether discounts should be applied to this product groups and products in it (note that price rules will still apply). Example: true
- `excerpt` (`string`, optional): Excerpt used in the online store. Example: example
- `extra_information` (`string`, optional): Extra information about the product group, shown on orders and documents. Example: example
- `flat_fee_price_in_cents` (`integer`, optional): Use this value when price type is simple. Example: 10
- `price_period` (`string`, optional): The period which is the base for price calculation when price type simple. One of: minute, hour, day, week, month. Example: minute. One of: `minute`, `hour`, `day`, `week`, `month`.
- `price_type` (`string`, optional): How prices are calculated for this product group and all products in it. One of: structure, private_structure, fixed, simple, none. Example: structure. One of: `structure`, `private_structure`, `fixed`, `simple`, `none`.
- `product_type` (`string`, optional): Type of product. Can only be set when creating a ProductGroup. The sales_item type used to be called consumable . v1 apis and webhooks will return consumable . One of: rental, sales_item, service. Example: rental. One of: `rental`, `sales_item`, `service`.
- `shortage_limit` (`integer`, optional): The maximum allowed shortage for any date range. Changing this setting affects availability, and can trigger a shortage warning. Example: 25
- `show_in_store` (`boolean`, optional): Whether to show this product group in the online store. Example: true
- `sku` (`string`, optional): Stock keeping unit. Example: TENT-44
- `structure_price_in_cents` (`integer`, optional): Use this value when price type is structure or private_structure. Example: 10
- `taxable` (`boolean`, optional): Whether this product group is taxable. Example: true
- `tracking_type` (`string`, optional): How the product is tracked. Can only be set when creating a ProductGroup. One of: none, bulk, trackable. Example: none. One of: `none`, `bulk`, `trackable`.

Example input: `{"name":"<name>"}`

### `booqable_product_group_update`

Update Product Group · Write

Update a product group's name, SKU, pricing, deposit, store visibility or buffers.
Returns data with the product_groups record's id and attributes.
Get the ID from booqable_product_groups_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
- `allow_shortage` (`boolean`, optional): Whether shortages are allowed. Changing this setting affects availability, and can trigger a shortage warning. Example: true
- `buffer_time_after` (`integer`, optional): The amount of seconds the item should be unavailable after a reservation. Changing this setting affects availability, and can trigger a shortage warning. This attribute is called lag_time in the v1 api and v1 webhooks. Example: 10
- `buffer_time_before` (`integer`, optional): The amount of seconds the item should be unavailable before a reservation. Changing this setting affects availability, and can trigger a shortage warning. This attribute is called lead_time in the v1 api and v1 webhooks. Example: 10
- `deposit_in_cents` (`integer`, optional): The value to use for deposit calculations. Example: 10000
- `discountable` (`boolean`, optional): Whether discounts should be applied to this product groups and products in it (note that price rules will still apply). Example: true
- `excerpt` (`string`, optional): Excerpt used in the online store. Example: example
- `extra_information` (`string`, optional): Extra information about the product group, shown on orders and documents. Example: example
- `flat_fee_price_in_cents` (`integer`, optional): Use this value when price type is simple. Example: 10
- `name` (`string`, optional): Name of the item. Example: John Doe
- `price_period` (`string`, optional): The period which is the base for price calculation when price type simple. One of: minute, hour, day, week, month. Example: minute. One of: `minute`, `hour`, `day`, `week`, `month`.
- `price_type` (`string`, optional): How prices are calculated for this product group and all products in it. One of: structure, private_structure, fixed, simple, none. Example: structure. One of: `structure`, `private_structure`, `fixed`, `simple`, `none`.
- `shortage_limit` (`integer`, optional): The maximum allowed shortage for any date range. Changing this setting affects availability, and can trigger a shortage warning. Example: 25
- `show_in_store` (`boolean`, optional): Whether to show this product group in the online store. Example: true
- `sku` (`string`, optional): Stock keeping unit. Example: TENT-44
- `structure_price_in_cents` (`integer`, optional): Use this value when price type is structure or private_structure. Example: 10
- `taxable` (`boolean`, optional): Whether this product group is taxable. Example: true

Example input: `{"id":"<id>"}`

### `booqable_stock_item_create`

Create Stock Item · Write

Add a trackable stock item (unit) to a product at a location, with identifier and purchase details.
Returns data with the stock_items record's id and attributes.
Get the product ID from booqable_products_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `product_id` (`string`, required): The Product this StockItem is one instance of. Example: 4b0a41b2-93d4-e5f6-a7b8-c9d0e1f2a3b4
- `from` (`string`, optional): When the stock item will be available in stock (temporary items or expected arrival date). Example: 2026-03-01T00:00:00
- `identifier` (`string`, optional): Unique identifier (like serial number). Example: SPRING10
- `location_id` (`string`, optional): Location where this StockItem currently resides. This is the start location of the order if the StockItem is currently out with a customer. Example: 0a41b293-d4e5-f6a7-b8c9-d0e1f2a3b4c5
- `purchase_cost_in_cents` (`integer`, optional): The purchase cost of this specific stock item for ROI calculations. Example: 45000
- `purchased_at` (`string`, optional): When this stock item was purchased. Example: 2026-01-10T00:00:00
- `till` (`string`, optional): When item will be out of stock (temporary items). Example: 2026-03-31T23:59:59

Example input: `{"product_id":"<product_id>"}`

### `booqable_stock_item_update`

Update Stock Item · Write

Update a stock item's identifier, location, availability window or purchase details.
Returns data with the stock_items record's id and attributes.
Get the ID from booqable_stock_items_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
- `confirm_shortage` (`boolean`, optional): Whether to confirm a shortage when updating from, till or location of a stock item. Example: true
- `from` (`string`, optional): When the stock item will be available in stock (temporary items or expected arrival date). Example: 2026-03-01T00:00:00
- `identifier` (`string`, optional): Unique identifier (like serial number). Example: SPRING10
- `location_id` (`string`, optional): Location where this StockItem currently resides. This is the start location of the order if the StockItem is currently out with a customer. Example: 0a41b293-d4e5-f6a7-b8c9-d0e1f2a3b4c5
- `purchase_cost_in_cents` (`integer`, optional): The purchase cost of this specific stock item for ROI calculations. Example: 45000
- `purchased_at` (`string`, optional): When this stock item was purchased. Example: 2026-01-10T00:00:00
- `till` (`string`, optional): When item will be out of stock (temporary items). Example: 2026-03-31T23:59:59

Example input: `{"id":"<id>"}`

### `booqable_customer_archive`

Archive Customer · Destructive

Archive a customer. Booqable keeps archived customers and their orders.
Returns data with the archived or deleted record.
Get the customer ID from booqable_customers_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa

Example input: `{"id":"<id>"}`

### `booqable_line_delete`

Delete Line · Destructive

Remove a line from an order or document.
Returns data with the archived or deleted record.
Get the line ID from booqable_lines_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa

Example input: `{"id":"<id>"}`

### `booqable_note_delete`

Delete Note · Destructive

Delete a note.
Returns data with the archived or deleted record.
Get the ID from booqable_notes_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa

Example input: `{"id":"<id>"}`

### `booqable_product_group_archive`

Archive Product Group · Destructive

Archive a product group so it can no longer be booked.
Returns data with the archived or deleted record.
Get the ID from booqable_product_groups_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa

Example input: `{"id":"<id>"}`

## Related

Other Calendar connectors ([all 25](/agentkit/connectors/?category=calendar)):

- [Google Calendar](/agentkit/connectors/googlecalendar/): Scalekit connector, OAuth, 30 tools
- [Zoom](/agentkit/connectors/zoom/): Scalekit connector, OAuth, 58 tools
- [Calendly](/agentkit/connectors/calendly/): Scalekit connector, OAuth, 64 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
