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.
- Tools
- 50
- What they doRead · write · destructive
- 32 · 14 · 432 read14 write4 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Booqable connection
In AgentKit > Connections, create a Booqable connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts 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.actionsconst connector = 'booqable'const identifier = 'user_123'// Generate an authorization link for the userconst { 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 callconst result = await actions.executeTool({connector,identifier,toolName: 'booqable_bundles_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_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.actionsconnection_name = "booqable"identifier = "user_123"# Generate an authorization link for the userlink_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 callresult = actions.execute_tool(tool_input={},tool_name="booqable_bundles_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Booqable credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolbooqable_bundle_getGet one bundle; include bundle_items to see its contents.Read-onlyGet Bundle
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.
Inputs
idstringrequired- ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
includestring- List of comma seperated relationships to sideload. ?include=photo,bundle_items,tax_category. Example: bundle_items
booqable_bundles_listList bundles (packages of products rented together).Read-onlyList Bundles
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.
Inputs
archivedboolean- Filter on archived (operators: eq). Example: true
includestring- List of comma seperated relationships to sideload. ?include=photo,inventory_levels. Example: photo
pagestring- The page to request. Example: 1
page_sizestring- The amount of items per page. Example: 25
qstring- Filter on q (operators: eq). Example: example
sortstring- How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
booqable_collections_listList store collections (product categories).Read-onlyList Collections
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.
Inputs
pagestring- The page to request. Example: 1
page_sizestring- The amount of items per page. Example: 25
parent_idstring- Filter on parent_id (operators: eq, not_eq). Example: example
qstring- Filter on q (operators: eq). Example: example
sortstring- How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
booqable_company_getGet the Booqable company the token belongs to, with address, currency, timezone and plan details.Read-onlyGet Company
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.
Inputs
This tool takes no inputs.
booqable_coupons_listList discount coupons with code, value, type and limits.Read-onlyList Coupons
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.
Inputs
activeboolean- Filter on active (operators: eq). Example: true
archivedboolean- Filter on archived (operators: eq). Example: true
includestring- List of comma seperated relationships to sideload. ?include=coupon_items. Example: coupon_items
pagestring- The page to request. Example: 1
page_sizestring- The amount of items per page. Example: 25
qstring- Filter on q (operators: eq). Example: example
sortstring- How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
booqable_customer_getGet one customer with contact details, deposit and discount defaults, tags and order totals.Read-onlyGet Customer
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.
Inputs
idstringrequired- ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
includestring- List of comma seperated relationships to sideload. ?include=barcode,properties,tax_region. Example: barcode
booqable_customers_listList customers, optionally searching by name or email (q) or filtering by email, tag or archived state.Read-onlyList Customers
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.
Inputs
archivedboolean- Filter on archived (operators: eq). Example: true
emailstring- Filter on email (operators: eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match). Example: jane@example.com
includestring- List of comma seperated relationships to sideload. ?include=barcode,properties,tax_region. Example: barcode
namestring- Filter on name (operators: eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match). Example: Example name
pagestring- The page to request. Example: 1
page_sizestring- The amount of items per page. Example: 25
qstring- Filter on q (operators: eq). Example: example
sortstring- How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
tag_liststring- Filter on tag_list (operators: eq). Example: example
booqable_document_getGet one quote, contract or invoice with totals and status; include lines to sideload them.Read-onlyGet Document
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.
Inputs
idstringrequired- ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
includestring- List of comma seperated relationships to sideload. ?include=signature,coupon,properties. Example: lines
booqable_documents_listList quotes, contracts and invoices, by order, customer, type or status.Read-onlyList Documents
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.
Inputs
customer_idstring- Filter on customer_id (operators: eq, not_eq). Example: example
document_typestring- Filter on document_type (operators: eq, not_eq). Example: example
finalizedboolean- Filter on finalized (operators: eq). Example: true
includestring- List of comma seperated relationships to sideload. ?include=customer,order. Example: customer
order_idstring- Filter on order_id (operators: eq, not_eq). Example: example
pagestring- The page to request. Example: 1
page_sizestring- The amount of items per page. Example: 25
qstring- Filter on q (operators: eq). Example: example
sortstring- How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
booqable_emails_listList emails sent from Booqable, by customer, order or template.Read-onlyList Emails
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.
Inputs
customer_idstring- Filter on customer_id (operators: eq, not_eq). Example: example
email_template_idstring- Filter on email_template_id (operators: eq, not_eq). Example: jane@example.com
includestring- List of comma seperated relationships to sideload. ?include=customer,order. Example: customer
order_idstring- Filter on order_id (operators: eq, not_eq). Example: example
pagestring- The page to request. Example: 1
page_sizestring- The amount of items per page. Example: 25
sortstring- How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
booqable_employees_listList the employees (staff accounts) in the company.Read-onlyList Employees
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.
Inputs
activeboolean- Filter on active (operators: eq). Example: true
emailstring- Filter on email (operators: eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match). Example: jane@example.com
pagestring- The page to request. Example: 1
page_sizestring- The amount of items per page. Example: 25
sortstring- How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
booqable_inventory_levels_listGet stock and availability levels for items over a period, per location.Read-onlyList Inventory Levels
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.
Inputs
fromstring- Filter on from (operators: eq). Example: example
includestring- List of comma seperated relationships to sideload. ?include=item,location. Example: item
item_idstring- Filter on item_id (operators: eq). Example: example
location_idstring- Filter on location_id (operators: eq). Example: example
order_idstring- Filter on order_id (operators: eq). Example: example
pagestring- The page to request. Example: 1
page_sizestring- The amount of items per page. Example: 25
sortstring- How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
tillstring- Filter on till (operators: eq). Example: example
booqable_item_getGet one item (product or bundle).Read-onlyGet Item
Get one item (product or bundle). Returns data with the items record's id and attributes. Get the ID from booqable_items_list.
Inputs
idstringrequired- ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
includestring- List of comma seperated relationships to sideload. ?include=barcode,bundle_items,collection_items. Example: barcode
booqable_items_listList all bookable items (products and bundles) in one list, by search text or type.Read-onlyList Items
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.
Inputs
archivedboolean- Filter on archived (operators: eq). Example: true
includestring- List of comma seperated relationships to sideload. ?include=barcode,bundle_items,collection_items. Example: barcode
pagestring- The page to request. Example: 1
page_sizestring- The amount of items per page. Example: 25
qstring- Filter on q (operators: eq). Example: example
sortstring- How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
tag_liststring- Filter on tag_list (operators: eq). Example: example
typestring- Filter on type (operators: eq, not_eq). Example: example
booqable_line_getGet one line with quantity, price and planning.Read-onlyGet Line
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.
Inputs
idstringrequired- ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
includestring- List of comma seperated relationships to sideload. ?include=order,owner,tax_category. Example: order
booqable_lines_listList order or document lines (items and charges), filtered by order, owner or item.Read-onlyList Lines
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.
Inputs
includestring- List of comma seperated relationships to sideload. ?include=order,owner,tax_category. Example: order
item_idstring- Filter on item_id (operators: eq, not_eq). Example: example
order_idstring- Filter on order_id (operators: eq). Example: example
owner_idstring- Filter on owner_id (operators: eq, not_eq). Example: example
pagestring- The page to request. Example: 1
page_sizestring- The amount of items per page. Example: 25
sortstring- How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
booqable_locations_listList pickup and warehouse locations.Read-onlyList Locations
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.
Inputs
archivedboolean- Filter on archived (operators: eq). Example: true
includestring- List of comma seperated relationships to sideload. ?include=carriers. Example: carriers
location_typestring- Filter on location_type (operators: eq). Example: example
pagestring- The page to request. Example: 1
page_sizestring- The amount of items per page. Example: 25
sortstring- How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
booqable_notes_listList internal notes, optionally for one customer, order or product (owner).Read-onlyList Notes
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.
Inputs
includestring- List of comma seperated relationships to sideload. ?include=employee,owner. Example: employee
owner_idstring- Filter on owner_id (operators: eq, not_eq). Example: example
owner_typestring- Filter on owner_type (operators: eq, not_eq). Example: example
pagestring- The page to request. Example: 1
page_sizestring- The amount of items per page. Example: 25
sortstring- How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
booqable_order_getGet one order with its period, status, totals, deposit and payment status; include lines or customer to sideload them.Read-onlyGet Order
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.
Inputs
idstringrequired- ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
includestring- List of comma seperated relationships to sideload. ?include=barcode,coupon,customer. Example: customer,lines
booqable_orders_listList rental orders, optionally by search text, customer, status, payment status or start time.Read-onlyList Orders
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.
Inputs
customer_idstring- Filter on customer_id (operators: eq, not_eq). Example: example
includestring- List of comma seperated relationships to sideload. ?include=customer,coupon,start_location. Example: customer
numberinteger- Filter on number (operators: eq, not_eq, gt, gte, lt, lte). Example: 10
pagestring- The page to request. Example: 1
page_sizestring- The amount of items per page. Example: 25
payment_statusstring- Filter on payment_status (operators: eq). Example: example
qstring- Filter on q (operators: eq). Example: example
sortstring- How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
starts_atstring- Filter on starts_at (operators: eq, not_eq, gt, gte, lt, lte). Example: example
statusstring- Filter on status (operators: eq, not_eq). Example: example
stops_atstring- Filter on stops_at (operators: eq, not_eq, gt, gte, lt, lte). Example: example
booqable_payment_getGet one payment.Read-onlyGet Payment
Get one payment. Returns data with the payments record's id and attributes. Get the ID from booqable_payments_list.
Inputs
idstringrequired- ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
includestring- List of comma seperated relationships to sideload. ?include=order,cart,payment_method. Example: order
booqable_payments_listList payments with amounts, provider, status times and linked order or customer.Read-onlyList Payments
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.
Inputs
customer_idstring- Filter on customer_id (operators: eq, not_eq). Example: example
includestring- List of comma seperated relationships to sideload. ?include=order,cart,payment_method. Example: order
order_idstring- Filter on order_id (operators: eq, not_eq). Example: example
pagestring- The page to request. Example: 1
page_sizestring- The amount of items per page. Example: 25
sortstring- How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
booqable_planning_getGet one planning.Read-onlyGet Planning
Get one planning. Returns data with the plannings record's id and attributes. Get the ID from booqable_plannings_list.
Inputs
idstringrequired- ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
includestring- List of comma seperated relationships to sideload. ?include=order,item,downtime. Example: order
booqable_plannings_listList plannings (reservations of items for orders) with periods, quantities, status and shortages.Read-onlyList Plannings
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.
Inputs
includestring- List of comma seperated relationships to sideload. ?include=order,item,downtime. Example: order
item_idstring- Filter on item_id (operators: eq, not_eq). Example: example
order_idstring- Filter on order_id (operators: eq, not_eq). Example: example
pagestring- The page to request. Example: 1
page_sizestring- The amount of items per page. Example: 25
sortstring- How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
starts_atstring- Filter on starts_at (operators: eq, not_eq, gt, gte, lt, lte). Example: example
statusstring- Filter on status (operators: eq). Example: example
stops_atstring- Filter on stops_at (operators: eq, not_eq, gt, gte, lt, lte). Example: example
booqable_product_getGet one product variation.Read-onlyGet Product
Get one product variation. Returns data with the products record's id and attributes. Get the ID from booqable_products_list.
Inputs
idstringrequired- ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
includestring- List of comma seperated relationships to sideload. ?include=barcode,inventory_levels,photo. Example: barcode
booqable_product_group_getGet one product group with pricing, deposit, tracking and store settings.Read-onlyGet Product Group
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.
Inputs
idstringrequired- ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
includestring- List of comma seperated relationships to sideload. ?include=photo,properties,tax_category. Example: photo
booqable_product_groups_listList product groups (rentable products with their pricing, deposit and tracking settings).Read-onlyList Product Groups
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.
Inputs
archivedboolean- Filter on archived (operators: eq). Example: true
includestring- List of comma seperated relationships to sideload. ?include=photo,properties,price_structure. Example: photo
pagestring- The page to request. Example: 1
page_sizestring- The amount of items per page. Example: 25
qstring- Filter on q (operators: eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match). Example: example
skustring- Filter on sku (operators: eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match). Example: example
sortstring- How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
tag_liststring- Filter on tag_list (operators: eq). Example: example
booqable_products_listList products (the bookable variations of product groups).Read-onlyList Products
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.
Inputs
archivedboolean- Filter on archived (operators: eq). Example: true
includestring- List of comma seperated relationships to sideload. ?include=barcode,inventory_levels,photo. Example: barcode
pagestring- The page to request. Example: 1
page_sizestring- The amount of items per page. Example: 25
product_group_idstring- Filter on product_group_id (operators: eq, not_eq). Example: example
qstring- Filter on q (operators: eq). Example: example
skustring- Filter on sku (operators: eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match). Example: example
sortstring- How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
booqable_stock_item_getGet one stock item.Read-onlyGet Stock Item
Get one stock item. Returns data with the stock_items record's id and attributes. Get the ID from booqable_stock_items_list.
Inputs
idstringrequired- ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
includestring- List of comma seperated relationships to sideload. ?include=barcode,location,properties. Example: barcode
booqable_stock_items_listList stock items (individually tracked units) with identifier, location and status.Read-onlyList Stock Items
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.
Inputs
archivedboolean- Filter on archived (operators: eq). Example: true
includestring- List of comma seperated relationships to sideload. ?include=product,barcode,location. Example: product
location_idstring- Filter on location_id (operators: eq, not_eq). Example: example
pagestring- The page to request. Example: 1
page_sizestring- The amount of items per page. Example: 25
product_group_idstring- Filter on product_group_id (operators: eq, not_eq). Example: example
product_idstring- Filter on product_id (operators: eq, not_eq). Example: example
qstring- Filter on q (operators: eq). Example: example
sortstring- How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
statusstring- Filter on status (operators: eq). Example: example
booqable_tax_rates_listList tax rates.Read-onlyList Tax Rates
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.
Inputs
includestring- List of comma seperated relationships to sideload. ?include=owner. Example: owner
pagestring- The page to request. Example: 1
page_sizestring- The amount of items per page. Example: 25
sortstring- How to sort the data. ?sort=attribute1,-attribute2. Example: -created_at
booqable_coupon_createCreate a discount coupon with a code, percentage or fixed value, date range and redemption limits.WriteCreate Coupon
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).
Inputs
coupon_typestringrequired- How the discount is calculated. Immutable. Example: percentage
identifierstringrequired- The code that customers need to type in. Immutable. Example: SPRING10
valueintegerrequired- A percentage for type percentage or a value in cents for cents. Example: 10
activeboolean- Whether coupon can be redeemed at the moment. Example: true
ends_atstring- 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_redemptionsinteger- 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_centsinteger- 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_customerboolean- 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
stackableboolean- 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_atstring- 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
booqable_customer_createCreate a customer (person or company) with email, tags and default deposit and discount.WriteCreate Customer
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.
Inputs
namestringrequired- Person or Company name. Example: John Doe
deposit_typestring- The deposit added to new orders of this customer by default. Example: example
deposit_valuenumber- The value to use for deposit_type. Example: 10
discount_percentagenumber- Default discount applied to each new order for this customer. Example: 10
emailstring- Email address used for communication. Example: john@example.com
email_marketing_consentedboolean- Whether the customer has consented to receive email marketing. Example: true
legal_typestring- Either person or commercial. Example: example
tag_listarray- Case insensitive tag list. Example: ["vip"]
tax_region_idstring- Tax region assigned to new orders for this customer. Example: d4e5f6a7-b8c9-d0e1-f2a3-b4c5d6e7f8a9
booqable_customer_updateUpdate a customer's name, email, type, deposit and discount defaults or tags.WriteUpdate Customer
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.
- Idempotent
Inputs
idstringrequired- ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
deposit_typestring- The deposit added to new orders of this customer by default. Example: example
deposit_valuenumber- The value to use for deposit_type. Example: 10
discount_percentagenumber- Default discount applied to each new order for this customer. Example: 10
emailstring- Email address used for communication. Example: john@example.com
email_marketing_consentedboolean- Whether the customer has consented to receive email marketing. Example: true
legal_typestring- Either person or commercial. Example: example
namestring- Person or Company name. Example: John Doe
tag_listarray- Case insensitive tag list. Example: ["vip"]
tax_region_idstring- Tax region assigned to new orders for this customer. Example: d4e5f6a7-b8c9-d0e1-f2a3-b4c5d6e7f8a9
booqable_email_sendSend an email from Booqable to recipients, optionally using a template and attaching documents for an order.WriteSend Email
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.
Inputs
recipientsstringrequired- 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
bodystring- 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_idstring- 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_idsarray- 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_idstring- 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_idstring- 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
subjectstring- 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
booqable_line_createAdd a custom charge or section line to an order or document (owner), with title, quantity and price.WriteCreate Line
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.
Inputs
owner_idstringrequired- The resource this Line belongs to. Either the Order directly, or a Document. Example: 6f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
owner_typestringrequired- The resource type of the owner. One of: orders, documents. Example: ordersone of
ordersdocuments discountableboolean- Whether line is discountable. Example: true
extra_informationstring- Extra information about the line. Example: example
line_typestring- 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: sectionone of
sectiondeposit_chargeprorationchargelegacy_migrationdelivery_rate positioninteger- 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_centsinteger- Price of each line. Example: 2500
quantityinteger- 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
taxableboolean- Whether line is taxable. Example: true
titlestring- Title of the line. Example: Tent 4x4m
booqable_line_updateUpdate a line's title, quantity, price, notes or tax flags.WriteUpdate Line
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.
- Idempotent
Inputs
idstringrequired- ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
confirm_shortageboolean- 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
discountableboolean- Whether line is discountable. Example: true
extra_informationstring- Extra information about the line. Example: example
positioninteger- 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_centsinteger- Price of each line. Example: 2500
quantityinteger- 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
taxableboolean- Whether line is taxable. Example: true
titlestring- Title of the line. Example: Tent 4x4m
booqable_note_createAdd an internal note to a customer, order, product or other record.WriteCreate Note
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.
Inputs
bodystringrequired- The content of the note. Example: Customer asked for early delivery.
owner_idstringrequired- The resource this note is about. Example: 6f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
owner_typestringrequired- The resource type of the owner. One of: customers, product_groups, products, stock_items, bundles, orders, documents, users. Example: ordersone of
customersproduct_groupsproductsstock_itemsbundlesordersdocumentsusers includestring- List of comma seperated relationships to sideload. ?include=employee,owner. Example: employee
booqable_order_createCreate a rental order for a customer and period, as new, draft or reserved.WriteCreate Order
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.
Inputs
confirm_shortageboolean- 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_idstring- The Coupon added to this Order. Example: 41b293d4-e5f6-a7b8-c9d0-e1f2a3b4c5d6
customer_idstring- The Customer this Order is for. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
deposit_typestring- How deposit is calculated. One of: none, percentage_total, percentage, fixed. Example: noneone of
nonepercentage_totalpercentagefixed deposit_valuenumber- The value to use for deposit_type. Example: 10
discount_typestring- Type of discount. One of: percentage, fixed. Example: percentageone of
percentagefixed discount_valuenumber- The value to use for discount_type. Example: 10
fulfillment_typestring- 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: pickupone of
pickupdelivery start_location_idstring- The Location where the customer will pick up the items. Example: 0a41b293-d4e5-f6a7-b8c9-d0e1f2a3b4c5
starts_atstring- 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
statusstring- 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: newone of
newdraftreservedstartedstoppedarchivedcanceled stop_location_idstring- The Location where the customer will return the items. Example: 0a41b293-d4e5-f6a7-b8c9-d0e1f2a3b4c5
stops_atstring- 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_listarray- Case insensitive tag list. Example: ["vip"]
booqable_order_status_transitionMove an order from one status to another (for example new to reserved, or reserved to canceled), optionally reverting or confirming a shortage.WriteChange Order Status
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.
Inputs
order_idstringrequired- The Order whose status is changed. Example: 6f1c2a9e-4b0a-41b2-93d4-e5f6a7b8c9d0
transition_fromstringrequired- The current status of the Order. One of: new, draft, reserved, started, stopped, archived. Example: newone of
newdraftreservedstartedstoppedarchived transition_tostringrequired- 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: reservedone of
draftreservedstartedstoppedarchivedcanceled confirm_shortageboolean- A value of true overrides shortage warnings. This is only possible when _reserving_ an Order. Example: true
includestring- List of comma seperated relationships to sideload. ?include=order. Example: order
revertboolean- 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
booqable_order_updateUpdate an order's customer, rental period, locations, deposit, discount, coupon or tags.WriteUpdate Order
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.
- Idempotent
Inputs
idstringrequired- ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
confirm_shortageboolean- 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_idstring- The Coupon added to this Order. Example: 41b293d4-e5f6-a7b8-c9d0-e1f2a3b4c5d6
customer_idstring- The Customer this Order is for. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
deposit_typestring- How deposit is calculated. One of: none, percentage_total, percentage, fixed. Example: noneone of
nonepercentage_totalpercentagefixed deposit_valuenumber- The value to use for deposit_type. Example: 10
discount_typestring- Type of discount. One of: percentage, fixed. Example: percentageone of
percentagefixed discount_valuenumber- The value to use for discount_type. Example: 10
fulfillment_typestring- 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: pickupone of
pickupdelivery start_location_idstring- The Location where the customer will pick up the items. Example: 0a41b293-d4e5-f6a7-b8c9-d0e1f2a3b4c5
starts_atstring- When items become unavailable, changing this value may result in shortages. Example: 2026-03-01T09:00:00
stop_location_idstring- The Location where the customer will return the items. Example: 0a41b293-d4e5-f6a7-b8c9-d0e1f2a3b4c5
stops_atstring- When items become available, changing this value may result in shortages. Example: 2026-03-05T17:00:00
tag_listarray- Case insensitive tag list. Example: ["vip"]
booqable_product_group_createCreate a rentable product with name, SKU, tracking type, price type and period, base price and deposit.WriteCreate Product Group
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.
Inputs
namestringrequired- Name of the item. Example: John Doe
allow_shortageboolean- Whether shortages are allowed. Changing this setting affects availability, and can trigger a shortage warning. Example: true
buffer_time_afterinteger- 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_beforeinteger- 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_centsinteger- The value to use for deposit calculations. Example: 10000
discountableboolean- Whether discounts should be applied to this product groups and products in it (note that price rules will still apply). Example: true
excerptstring- Excerpt used in the online store. Example: example
extra_informationstring- Extra information about the product group, shown on orders and documents. Example: example
flat_fee_price_in_centsinteger- Use this value when price type is simple. Example: 10
price_periodstring- The period which is the base for price calculation when price type simple. One of: minute, hour, day, week, month. Example: minuteone of
minutehourdayweekmonth price_typestring- How prices are calculated for this product group and all products in it. One of: structure, private_structure, fixed, simple, none. Example: structureone of
structureprivate_structurefixedsimplenone product_typestring- 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: rentalone of
rentalsales_itemservice shortage_limitinteger- The maximum allowed shortage for any date range. Changing this setting affects availability, and can trigger a shortage warning. Example: 25
show_in_storeboolean- Whether to show this product group in the online store. Example: true
skustring- Stock keeping unit. Example: TENT-44
structure_price_in_centsinteger- Use this value when price type is structure or private_structure. Example: 10
taxableboolean- Whether this product group is taxable. Example: true
tracking_typestring- How the product is tracked. Can only be set when creating a ProductGroup. One of: none, bulk, trackable. Example: noneone of
nonebulktrackable
booqable_product_group_updateUpdate a product group's name, SKU, pricing, deposit, store visibility or buffers.WriteUpdate Product Group
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.
- Idempotent
Inputs
idstringrequired- ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
allow_shortageboolean- Whether shortages are allowed. Changing this setting affects availability, and can trigger a shortage warning. Example: true
buffer_time_afterinteger- 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_beforeinteger- 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_centsinteger- The value to use for deposit calculations. Example: 10000
discountableboolean- Whether discounts should be applied to this product groups and products in it (note that price rules will still apply). Example: true
excerptstring- Excerpt used in the online store. Example: example
extra_informationstring- Extra information about the product group, shown on orders and documents. Example: example
flat_fee_price_in_centsinteger- Use this value when price type is simple. Example: 10
namestring- Name of the item. Example: John Doe
price_periodstring- The period which is the base for price calculation when price type simple. One of: minute, hour, day, week, month. Example: minuteone of
minutehourdayweekmonth price_typestring- How prices are calculated for this product group and all products in it. One of: structure, private_structure, fixed, simple, none. Example: structureone of
structureprivate_structurefixedsimplenone shortage_limitinteger- The maximum allowed shortage for any date range. Changing this setting affects availability, and can trigger a shortage warning. Example: 25
show_in_storeboolean- Whether to show this product group in the online store. Example: true
skustring- Stock keeping unit. Example: TENT-44
structure_price_in_centsinteger- Use this value when price type is structure or private_structure. Example: 10
taxableboolean- Whether this product group is taxable. Example: true
booqable_stock_item_createAdd a trackable stock item (unit) to a product at a location, with identifier and purchase details.WriteCreate Stock Item
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.
Inputs
product_idstringrequired- The Product this StockItem is one instance of. Example: 4b0a41b2-93d4-e5f6-a7b8-c9d0e1f2a3b4
fromstring- When the stock item will be available in stock (temporary items or expected arrival date). Example: 2026-03-01T00:00:00
identifierstring- Unique identifier (like serial number). Example: SPRING10
location_idstring- 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_centsinteger- The purchase cost of this specific stock item for ROI calculations. Example: 45000
purchased_atstring- When this stock item was purchased. Example: 2026-01-10T00:00:00
tillstring- When item will be out of stock (temporary items). Example: 2026-03-31T23:59:59
booqable_stock_item_updateUpdate a stock item's identifier, location, availability window or purchase details.WriteUpdate Stock Item
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.
- Idempotent
Inputs
idstringrequired- ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
confirm_shortageboolean- Whether to confirm a shortage when updating from, till or location of a stock item. Example: true
fromstring- When the stock item will be available in stock (temporary items or expected arrival date). Example: 2026-03-01T00:00:00
identifierstring- Unique identifier (like serial number). Example: SPRING10
location_idstring- 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_centsinteger- The purchase cost of this specific stock item for ROI calculations. Example: 45000
purchased_atstring- When this stock item was purchased. Example: 2026-01-10T00:00:00
tillstring- When item will be out of stock (temporary items). Example: 2026-03-31T23:59:59
booqable_customer_archiveArchive a customer.DestructiveArchive Customer
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.
- Idempotent
Inputs
idstringrequired- ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
booqable_line_deleteRemove a line from an order or document.DestructiveDelete Line
Remove a line from an order or document. Returns data with the archived or deleted record. Get the line ID from booqable_lines_list.
- Idempotent
Inputs
idstringrequired- ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
booqable_note_deleteDelete a note.DestructiveDelete Note
Delete a note. Returns data with the archived or deleted record. Get the ID from booqable_notes_list.
- Idempotent
Inputs
idstringrequired- ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
booqable_product_group_archiveArchive a product group so it can no longer be booked.DestructiveArchive Product Group
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.
- Idempotent
Inputs
idstringrequired- ID. Example: b047cd19-e6ec-4914-8ddb-960e2ed984fa
No tools match.