Skip to main content
Booqable logo
  • Category: scheduling & booking
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 49
  • Triggers: 0
  • Slug: BOOQABLE
  • Version: 20261101_00

Tools

Slug: BOOQABLE_CREATE_CUSTOMERTool to create a new customer. Use when onboarding a new client and you have verified their details. Example: Create ‘Jane Doe’ with email jane@doe.com.

Input Parameters

string
required
The name of the customer
string
E-mail address of the customer
string
Customer’s phone number
integer
Associated tax region ID
array
List of custom properties for the customer

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_CREATE_ORDERTool to create a new order. Use after collecting valid customer ID and timing details. Example: Create an order for customer ‘297f2584-…’ starting at ‘2018-01-01T09:00:00Z’.

Input Parameters

string
Order stop datetime in ISO8601 format, e.g., ‘2018-02-01T09:00:00Z’.
string
Order start datetime in ISO8601 format, e.g., ‘2018-01-01T09:00:00Z’.
string
required
ID of the customer for the order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_CREATE_PRODUCT_GROUPTool to create a new product group in Booqable. Use when you have defined the group’s name and pricing details and want to organize items under a shared group.

Input Parameters

string
Stock Keeping Unit identifier for the product group.
string
required
Name of the product group.
string
Pricing type (e.g., ‘simple’).
string
Pricing period (e.g., ‘day’).
integer
Base price in cents for the product group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_DELETE_CUSTOMERTool to delete (archive) a customer by ID. Use after confirming the customer should be hidden from searches.

Input Parameters

string
required
The unique identifier (UUID or numeric ID) of the customer to delete (archive).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_DELETE_ORDERTool to delete (archive) an order by ID. Use when you need to hide completed or canceled orders from active listings.

Input Parameters

string
required
The UUID or numeric ID of the order to archive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_DELETE_PRODUCT_GROUPTool to delete a product group by ID. Use when you need to permanently remove a product group from your catalog after confirming its identifier.

Input Parameters

string
required
The unique identifier of the product group to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_GET_CUSTOMERTool to fetch a specific customer by ID. Use after obtaining a customer identifier to retrieve full customer details.

Input Parameters

string
required
Unique identifier (UUID) or customer number to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_GET_CUSTOMERSTool to retrieve a list of customers. Use when you need to paginate through customers.

Input Parameters

integer
Number of customers per page. If None, server default is used.
integer
Page number to retrieve, must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_GET_INVENTORY_LEVELSFetch inventory-level snapshots for products over a date range, optionally filtered by order or location. These raw stock and planned quantities are for reporting, not determining whether a product can be booked; the underlying endpoint is deprecated.

Input Parameters

string
Number of items per page for pagination.
string
required
Start date for inventory level query in ISO 8601 format (YYYY-MM-DD). Required.
string
required
End date for inventory level query in ISO 8601 format (YYYY-MM-DD). Required.
string
Page number for pagination.
string
UUID of the item (product) to check inventory levels for. Either item_id or order_id must be supplied.
string
UUID of the order to check inventory levels for. Either item_id or order_id must be supplied.
string
UUID of specific location to filter inventory levels.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_GET_NEW_ORDERRetrieve an existing or new order for the current employee, for use in an order creation workflow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_GET_ORDERTool to retrieve a specific order by ID. Use when you need complete details of a known order, including optional relationships like customer or coupon. Call after confirming the order ID.

Input Parameters

string
required
Unique identifier (UUID or numeric) of the order to fetch.
array
List of order fields to include in the response, e.g., [‘created_at’,‘updated_at’,‘number’].
array
List of related resources to include, e.g., [‘customer’,‘coupon’,‘start_location’].

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_GET_PRODUCTTool to fetch a specific product by ID. Use after obtaining a product identifier to retrieve detailed inventory item data.

Input Parameters

string
required
Unique identifier of the product to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_GET_PRODUCT_GROUPTool to fetch a specific product group by ID. Use after obtaining the product group identifier to retrieve its full details.

Input Parameters

string
required
Unique identifier (UUID) of the product group to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_BARCODESTool to retrieve a list of barcodes. Use when you need to list barcodes with pagination, filtering by owner, type, or dates.

Input Parameters

string
Sort results by field(s). Prefix with ’-’ for descending order (e.g., ‘-created_at’).
array
Specify which fields to return instead of defaults.
string
Sideload related resources (e.g., ‘owner’ to load the owner entity).
string
Filter barcodes by ID.
integer
Number of barcodes per page. If None, server default (25) is used.
string
Request count metadata (e.g., ‘count’ to get total count).
integer
Page number to retrieve, must be >= 1.
string
Filter barcodes by barcode number.
string
Filter barcodes by owner ID.
string
Filter barcodes by creation date (supports operators like [gt], [gte], [lt], [lte]).
string
Filter barcodes by owner type (e.g., ‘customers’, ‘products’).
string
Filter barcodes by update date (supports operators like [gt], [gte], [lt], [lte]).
string
Filter barcodes by barcode type (e.g., ‘qr_code’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_BUNDLE_ITEMSTool to retrieve a list of bundle items. Use when you need to see which products are included in bundles, with their quantities and discounts.

Input Parameters

string
Sort order using field names. Prefix with ’-’ for descending order. Example: ‘position’ or ‘-created_at’
array
Specify which fields to include instead of defaults. Example: [‘id’, ‘bundle_id’, ‘quantity’]
string
Load related resources (comma-separated). Available: bundle, product
string
Filter by specific bundle item ID (UUID format).
integer
Number of items per page (e.g., 10, 25, 50).
integer
Pagination page number to retrieve, must be >= 1.
integer
Filter bundle items by position in the bundle.
integer
Filter bundle items by quantity.
string
Filter bundle items by bundle ID (UUID format).
string
Filter bundle items by product ID (UUID format).
number
Filter bundle items by discount percentage.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_CLUSTERSRetrieve a list of clusters from Booqable with optional field selection and pagination.

Input Parameters

string
Controls data ordering. Prefix with ’-’ for descending order (e.g., ‘-created_at’).
array
Allows selection of specific attributes to include in the response instead of defaults.
string
Loads associated resources (sideloading). Comma-separated list of relationships.
integer
Sets the quantity of items per page.
integer
Specifies which page to retrieve, must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_COUPONSList Booqable discount coupons with pagination, sorting, and filters such as archived status, ID, and creation or update time. You can also request related resources and select response fields.

Input Parameters

string
Sort order for the results. Use field name optionally prefixed with ’-’ for descending order (e.g., ‘name’ or ‘-created_at’).
array
List of specific fields to include in the response instead of default fields.
string
Comma-separated list of relationships to sideload.
string
Filter by coupon ID using exact match.
string
The number of items per page.
string
Filter by coupon code.
string
The page number to request for pagination.
string
Filter by archived status.
string
Filter by creation timestamp.
string
Filter by percentage value.
string
Filter by last update timestamp.
string
Filter by archived timestamp.
string
Filter by discount type (percentage or fixed_amount).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_DEFAULT_PROPERTIESTool to retrieve a list of default properties from Booqable. Use when you need to view custom property definitions with pagination, filtering, or sorting options.

Input Parameters

string
Metadata requests (e.g., meta[total][]=count for total count).
string
Sort by attributes using format: field1,-field2 (minus prefix for descending).
array
List of specific fields to include instead of defaults.
string
Comma-separated list of relationships to sideload.
string
Filter by default property ID.
integer
Number of items per page for pagination.
string
Filter by name of the default property.
integer
Page number for pagination, must be >= 1.
string
Filter by created_at timestamp (use operators like [gt], [lt], [gte], [lte]).
string
Filter by updated_at timestamp (use operators like [gt], [lt], [gte], [lte]).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_DOCUMENTSRetrieve a list of Booqable documents, including invoices, quotes, and contracts, with optional filtering and pagination.

Input Parameters

string
Search query to filter documents.
string
Sort order. Prefix with - for descending. Examples: created_at, -updated_at, number
string
Comma-separated list of fields to include instead of defaults.
string
Comma-separated list of related resources to sideload. Options: order, lines, customer, company, tax_values
integer
Number of documents per page. If None, server default is used.
integer
Page number to retrieve, must be >= 1.
string
Filter by document status.
boolean
Filter documents by archived status.
string
Filter documents by order ID.
string
Filter by document type (e.g., quote, contract, invoice, packing_slip).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_EMAIL_TEMPLATESTool to list email templates from Booqable. Use when you need to retrieve available email templates with optional filtering, pagination, and sorting.

Input Parameters

string
Sort results by attributes. Prefix with ’-’ for descending order. Example: ‘name’ or ‘-created_at’
array
List of specific fields to include in the response instead of defaults. Example: [‘name’, ‘subject’]
string
Comma-separated list of relationships to sideload with the templates.
string
Filter by email template ID (uuid).
integer
Number of items per page. Must be >= 1.
string
Filter by email template name (string).
integer
Page number for pagination. Must be >= 1.
string
Filter by created_at datetime. Use operators like [eq], [gt], [lt]. Example: ‘2024-01-01’
string
Filter by updated_at datetime. Use operators like [eq], [gt], [lt]. Example: ‘2024-01-01’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_EMPLOYEESTool to retrieve a list of employees from Booqable. Use when you need to list employee accounts with pagination and filtering options.

Input Parameters

string
Sort order (e.g., ‘name’ for ascending, ‘-name’ for descending). Comma-separated for multiple fields.
array
Specify which employee fields to return. If not provided, all default fields are returned.
string
Sideload relationships. Use comma-separated values for multiple relationships.
integer
Number of employees per page. If None, server default is used.
string
Filter employees by name.
integer
Page number to retrieve, must be >= 1.
string
Filter employees by email address.
boolean
Filter employees by active status (true or false).
string
Filter employees by creation date. Use operators like ‘eq’, ‘gt’, ‘gte’, ‘lt’, ‘lte’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_INVENTORY_BREAKDOWNSTool to retrieve a list of inventory breakdowns filtered by status and product/product group. Use when you need to analyze inventory allocation across locations. Note: Both status filter and either product_id or product_group_id filter are required.

Input Parameters

string
Sort results by field. Prefix with ’-’ for descending order.
array
Specify which fields to return in the response.
string
Comma-separated list of related resources to include. Available: product, location, inventory_levels.
integer
Number of items per page, must be >= 1.
integer
Page number for pagination, must be >= 1.
string ("expected" | "in_stock" | "archived")
required
Status of inventory breakdowns to retrieve. This is a required filter.
string
Filter by specific product ID. Either product_id or product_group_id must be specified.
string
Filter by product group ID. Either product_id or product_group_id must be specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_ITEMSRetrieve a list of catalog items, including products, product groups, and bundles, with pagination and filtering.

Input Parameters

string
Sort order using field names. Prefix with ’-’ for descending order. Example: ‘name’ or ‘-created_at’
array
Specify which fields to include instead of defaults. Example: [‘id’, ‘name’, ‘slug’]
string
Load related resources (comma-separated). Example: ‘photos,properties’
string
Number of items per page (e.g., ‘10’, ‘25’, ‘50’).
string
Filter items by name.
string
Filter items by slug.
string
Pagination page number to retrieve.
boolean
Filter items by archived status.
string
Filter items by product type (e.g., ‘rental’, ‘sales_item’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_LINESRetrieve a paginated list of lines associated with orders, including lines owned by documents. Supports filtering by order, product, or other attributes.

Input Parameters

string
Sort results by attributes. Prefix with ’-’ for descending order (e.g., ‘-created_at’).
array
Specify which fields to include instead of defaults.
string
Sideload related resources (comma-separated). Supported: order, product, tax_category.
string
Filter lines by ID.
integer
Number of items per page for pagination.
integer
Page number for pagination. Must be >= 1.
string
Filter lines by title.
boolean
Filter lines by taxable status.
boolean
Filter lines by archived status.
string
Filter lines by order ID.
integer
Filter lines by quantity.
string
Filter lines by creation date. Use ISO 8601 format or comparison operators.
string
Filter lines by product ID.
string
Filter lines by last update date. Use ISO 8601 format or comparison operators.
boolean
Filter lines by discountable status.
string
Filter lines by tax category ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_LOCATIONSTool to retrieve a list of locations from Booqable. Use when you need to view available locations with pagination, filtering, or sorting options.

Input Parameters

string
Metadata requests (e.g., total[]=count for total count).
string
Sort by attributes using format: field1,-field2 (minus prefix for descending).
array
List of specific fields to include instead of defaults.
string
Comma-separated list of relationships to sideload (e.g., photo).
string
Filter by location ID.
integer
Number of items per page for pagination.
string
Filter by location name.
string
Filter by location slug.
integer
Page number for pagination, must be >= 1.
boolean
Filter by archived status.
string
Filter by created_at timestamp (use operators like [gt], [lt], [gte], [lte]).
string
Filter by updated_at timestamp (use operators like [gt], [lt], [gte], [lte]).
string
Filter by archived_at timestamp (use operators like [gt], [lt], [gte], [lte]).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_NOTESTool to retrieve a list of notes. Use when you need to list notes with optional filtering by owner, date, or content.

Input Parameters

string
How to sort the data. Format: ‘attribute1,-attribute2’ where ’-’ prefix means descending order.
array
List of fields to include instead of default fields. Examples: ‘id’, ‘body’, ‘owner_id’, ‘owner_type’, ‘created_at’, ‘updated_at’.
string
Comma-separated list of relationships to include. Acceptable: ‘owner’.
string
Filter notes by ID. Supports exact match or operators.
integer
Number of notes per page.
string
Filter notes by text content (searches in body field).
integer
Page number to retrieve, must be >= 1.
string
Filter notes by owner ID (the resource this note is attached to).
string
Filter notes by creation date. Use operators like ‘gt’, ‘gte’, ‘lt’, ‘lte’ with ISO8601 timestamps.
string
Filter notes by owner type (e.g., ‘customers’, ‘orders’).
string
Filter notes by last update date. Use operators like ‘gt’, ‘gte’, ‘lt’, ‘lte’ with ISO8601 timestamps.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_ORDERSTool to retrieve a paginated list of orders. Use when you need to browse orders with support for filtering by status, customer, dates, and other attributes.

Input Parameters

string
Sort results by attributes. Prefix with ’-’ for descending order (e.g., ‘-created_at’).
array
Specify which fields to include instead of defaults. Example: [‘id’, ‘number’, ‘status’]
string
Sideload related resources (comma-separated). Supported: customer, coupon, start_location.
string
Number of items per page for pagination.
string
Page number for pagination.
integer
Filter orders by order number.
string
Filter orders by order status (e.g., reserved, confirmed).
boolean
Filter orders by archived status.
string
Filter orders by rental end date. Use ISO 8601 format or comparison operators.
string
Filter orders by rental start date. Use ISO 8601 format or comparison operators.
string
Filter orders by creation date. Use ISO 8601 format or comparison operators.
string
Filter orders by last update date. Use ISO 8601 format or comparison operators.
string
Filter orders by customer ID.
string
Filter orders by tax region ID.
string
Filter orders by payment status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_PAYMENT_METHODSTool to retrieve a list of payment methods from Booqable. Use when you need to list payment methods with optional filtering by creation date, customer, status, or ID, and support for pagination.

Input Parameters

object
Sends metadata with the request as a JSON object.
string
Controls data ordering. Prefix with ’-’ for descending order (e.g., ‘-created_at’).
array
Allows selection of specific attributes to include in the response.
string
Loads associated resources (sideloading). Comma-separated list of relationships.
integer
Sets the quantity of items per page.
integer
Specifies which page to retrieve, must be >= 1.
string
Filter by payment method ID (equal). Format: UUID.
string
Filter by payment method ID (not equal). Format: UUID.
string
Filter by status (equal). Possible values depend on the API specification.
string
Filter by creation date (equal). Format: ISO 8601 datetime.
string
Filter by creation date (greater than). Format: ISO 8601 datetime.
string
Filter by creation date (less than). Format: ISO 8601 datetime.
string
Filter by creation date (greater than or equal). Format: ISO 8601 datetime.
string
Filter by creation date (less than or equal). Format: ISO 8601 datetime.
string
Filter by customer ID (equal). Format: UUID.
string
Filter by customer ID (not equal). Format: UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_PAYMENTSList a page of Booqable payment records, optionally filtered by creation time, payment ID, or order ID. Payment status must be inspected in the returned records rather than used as a filter.

Input Parameters

string
Request metadata like aggregation counts. Use format: meta[total][]=count
string
Sort by fields. Use - prefix for descending order (e.g., -created_at).
array
Specify which fields to return instead of defaults. Provide as a list of field names.
string
Sideload related resources (comma-separated list of relationships).
string
Filter by payment ID (uuid).
string
Items per page for pagination.
string
Page number for pagination.
string
Filter by order ID (uuid).
string
Filter by created_at datetime. Use operators like filter[created_at][gte]=2024-01-01.
string
Filter by payment method.
string
Filter by payment status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_PHOTOSTool to retrieve a paginated list of photos from Booqable. Use when you need to list photos with support for filtering by owner resource and pagination.

Input Parameters

string
Sort results by attributes. Prefix with ’-’ for descending order (e.g., ‘-created_at’).
array
Specify which fields to include instead of defaults. Example: [‘id’, ‘filename’, ‘alt_text’]
string
Sideload related resources (comma-separated). Example: ‘owner’
integer
Number of items per page for pagination.
integer
Page number for pagination. Must be >= 1.
string
Filter photos by owner ID (UUID format).
string
Filter photos by owner type (e.g., ‘products’, ‘product_groups’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_PLANNINGSList planning records for product and bundle activities, including orders and downtime. Filter by item or order and by reservation start and end bounds; the date bounds select records starting at or after the supplied start and ending at or before the supplied end.

Input Parameters

string
Sort order (e.g., ‘starts_at’ for ascending, ‘-starts_at’ for descending).
array
List of specific fields to include in the response instead of defaults.
string
Comma-separated list of relationships to include (e.g., ‘product’, ‘bundle’, ‘location’, ‘order’).
integer
Number of plannings per page.
integer
Page number to retrieve, must be >= 1.
string
Filter plannings by item ID (products or bundles).
string
Filter plannings by order ID.
string
Filter plannings with reserved_from at or after this date-time (ISO 8601 format).
string
Filter plannings with reserved_till at or before this date-time (ISO 8601 format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_PRICE_RULESETSList price rulesets with optional filtering by archived status, name, or ID, and pagination support. The account’s plan must include advanced pricing.

Input Parameters

string
Sort criteria. Prefix with - for descending. Example: name or -created_at
array
Comma-separated fields to return instead of defaults. Example: id,name
string
Comma-separated relationships to sideload. Available: price_rules
string
Filter by price ruleset ID (UUID). Supports eq, not_eq operators.
integer
Number of items per page.
string
Filter by name. Supports eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match operators.
integer
Page number to retrieve, must be >= 1.
boolean
Filter by archived status. True returns only archived rulesets, false returns non-archived.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_PRICE_STRUCTURESTool to list price structures. Use when you need to retrieve price structures with optional filtering by name, ID, or product group, and pagination support.

Input Parameters

string
Sort criteria. Prefix with - for descending. Example: name or -created_at
array
Comma-separated fields to return instead of defaults. Example: id,name,created_at
string
Comma-separated relationships to sideload. Available: price_tiles
string
Filter by price structure ID (UUID). Supports eq, not_eq operators.
integer
Number of items per page.
string
Filter by name. Supports eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match operators.
integer
Page number to retrieve, must be >= 1.
string
Filter by product group ID (UUID). Supports eq, not_eq operators.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_PRODUCT_GROUPSLists product groups from Booqable API v4 with pagination and field selection options.

Input Parameters

string
Field to sort by. Prefix with ’-’ for descending order (e.g., ‘-created_at’ for newest first).
array
List of fields to include in the response (e.g., [‘id’, ‘name’, ‘slug’]). If not specified, all fields are returned.
string
Filter criteria to apply. Use syntax like ‘archived:false’ or ‘product_type:rental’.
string
Comma-separated list of relationships to include (e.g., ‘photo,tax_category’).
string
Number of items per page. If not specified, server default is used.
string
Page number to retrieve. Defaults to 1 if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_PRODUCTSTool to retrieve a list of products. Use when you need to browse products with pagination and filtering.

Input Parameters

string
Sort order using field names. Prefix with ’-’ for descending order. Example: ‘name’ or ‘-created_at’
array
Specify which fields to include instead of defaults. Example: [‘id’, ‘name’, ‘slug’]
string
Load related resources (comma-separated). Available: ‘photos’, ‘inventory_levels’, ‘tax_category’, ‘product_group’. Example: ‘photos,product_group’
string
Number of products per page (e.g., ‘10’, ‘25’, ‘50’).
string
Filter products by name.
string
Pagination page number to retrieve.
boolean
Filter products by taxable status.
boolean
Filter products by archived status.
string
Filter products by tag.
boolean
Filter products by discountable status.
string
Filter products by product group ID (UUID).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_PROPERTIESTool to retrieve a list of properties. Use when you need to list custom properties associated with customers, products, or other resources in Booqable.

Input Parameters

string
Request metadata like aggregations. Use syntax like ‘total[]=count’.
string
Sort order. Prefix with ’-’ for descending. Examples: ‘name’, ‘-created_at’, ‘property_type’.
array
Specify which fields to return instead of defaults. Use field names like ‘name’, ‘value’, ‘property_type’.
string
Apply filters using syntax like ‘name eq value’ or ‘owner_id eq uuid’. Supports operators: eq, neq, gt, gte, lt, lte.
string
Sideload related resources (comma-separated). Available: owner, default_property.
integer
Number of items per page, must be >= 1.
integer
Page number for pagination, must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_PROVINCESTool to retrieve a list of provinces. Use when you need to list available provinces, optionally filtered by country.

Input Parameters

string
Sort order for provinces. Use field name for ascending, prefix with minus for descending (e.g., ‘name’ or ‘-name’).
object
Filter conditions to apply. Supports filtering by country_id, name, created_at, updated_at, id.
integer
Number of provinces per page. If None, server default is used.
integer
Page number to retrieve, must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_STOCK_ITEM_PLANNINGSTool to retrieve a list of stock item plannings. Use when you need to list stock item plannings with filtering and pagination.

Input Parameters

string
Include metadata like total count. Use ‘total_count’ to include count.
string
Sort criteria using format attribute1,-attribute2. Prefix with ’-’ for descending order.
array
Comma-separated fields to return in the response.
string
Comma-separated list of related resources to sideload (e.g., ‘stock_item,planning’).
string
Filter by id with operators: eq, not_eq. Format: operator:value.
integer
Number of stock item plannings per page.
integer
Page number to retrieve, must be >= 1.
boolean
Filter by archived status (true or false).
string
Filter by created_at with operators: eq, not_eq, gt, gte, lt, lte. Format: operator:value (e.g., ‘gte:2024-01-01’).
string
Filter by planning_id with operators: eq, not_eq. Format: operator:value.
string
Filter by stock_item_id with operators: eq, not_eq. Format: operator:value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_STOCK_ITEMSTool to retrieve a list of stock items. Use when you need to list physical inventory items with tracking identifiers like serial numbers or barcodes.

Input Parameters

string
Sort order for the results (e.g., ‘created_at’ for ascending, ‘-created_at’ for descending).
string
Comma-separated list of fields to include in the response (e.g., ‘id,barcode,status’).
string
Filter criteria in the format ‘field[operator]=value’ (e.g., ‘status[eq]=available’). Filterable fields: archived, archived_at, created_at, id, location_id, product_id, status, stock_item_type, updated_at.
string
Comma-separated list of related resources to include (sideload) in the response.
string
Number of stock items per page. Used to control pagination size.
string
The page number to retrieve. Used for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_TAX_RATESList Booqable tax rates, with optional ID filtering, pagination, and sorting. The results provide tax rate records for reviewing the rates associated with tax categories or regions.

Input Parameters

string
Sort order for the results. Use field name optionally prefixed with ’-’ for descending order (e.g., ‘name’ or ‘-created_at’).
array
List of specific fields to include in the response instead of default fields.
string
Comma-separated list of relationships to sideload (e.g., ‘tax_category,region’).
string
Filter by tax rate ID using exact match.
string
The number of items per page.
string
Filter by tax rate name.
string
The page number to request for pagination.
string
Filter by region ID.
string
Filter by percentage value.
string
Filter by tax category ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_TAX_VALUESRetrieve a list of calculated tax values, with optional filtering, pagination, and sorting. Tax values describe amounts taxed for specific rates on transactions.

Input Parameters

string
Sort results by attributes. Use ’-’ prefix for descending order (e.g., ‘created_at’ or ‘-percentage’).
string
Comma-separated list of relationships to include (e.g., ‘tax_category’).
object
Filter by exact match. Provide field name and value (e.g., {‘tax_category_id’: ‘uuid’}).
integer
Number of tax values per page.
integer
Page number to retrieve for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_LIST_USERSList Booqable web shop user accounts with pagination and filtering options. The returned disabled flag defaults to false when absent from the API response; check the user’s status for its actual state.

Input Parameters

string
Sort order (e.g., ‘name’ for ascending, ‘-name’ for descending). Comma-separated for multiple fields.
array
Specify which user fields to return. If not provided, all default fields are returned.
string
Sideload relationships (e.g., ‘company’). Use comma-separated values for multiple relationships.
integer
Number of users per page. If None, server default is used.
string
Filter users by name.
integer
Page number to retrieve, must be >= 1.
string
Filter users by email address.
boolean
Filter users by disabled status (true or false).
string
Filter users by creation date. Use operators like ‘eq’, ‘gt’, ‘gte’, ‘lt’, ‘lte’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_SEARCH_BUNDLESTool to search bundles with advanced filtering. Use when you need to find bundles by specific criteria (discountable, taxable, show_in_store, etc.) using complex queries with logical operators.

Input Parameters

object
Fields specification for bundle resources.
object
Filter structure for searching bundles.
integer
Number of bundles per page. If not specified, server default is used.
integer
Page number to retrieve, must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_SEARCH_CUSTOMERSRetrieve a page of Booqable customers through the search endpoint, with optional customer field selection and relationship requests. The tool does not accept customer search criteria, and separately included resource data is not returned.

Input Parameters

string
Comma-separated list of relationships to include (e.g., ‘orders,notes’).
integer
Number of customers per page. If not specified, server default is used.
integer
Page number to retrieve, must be >= 1.
string
Comma-separated list of customer fields to return (e.g., ‘id,name,email’). If not specified, all fields are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_SEARCH_DOCUMENTSTool to search documents using advanced filtering with logical operators. Use when you need to find documents matching complex criteria with AND/OR conditions.

Input Parameters

object
Object specifying which fields to return for documents.
object
Filter conditions as field-operator-value pairs (e.g., {‘status’: {‘eq’: ‘confirmed’}, ‘archived’: {‘eq’: false}}). Multiple fields act as implicit AND.
integer
Number of documents per page. If not specified, server default is used.
integer
Page number to retrieve, must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_SEARCH_ITEMSSearch items, including products, product groups, and bundles, using filters on criteria such as name, product type, and archived status. Conditions are combined in a single AND or OR group.

Input Parameters

string
Comma-separated list of relationships to include (e.g., ‘photo,tax_category’).
integer
Number of items per page. If not specified, server default is used.
integer
Page number to retrieve, must be >= 1.
string
Comma-separated list of item fields to return (e.g., ‘id,name,product_type,sku’). If not specified, all fields are returned.
object
Filter conditions with logical operator.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_SEARCH_ORDERSTool to search orders with advanced filtering using logical operators. Use when you need to find orders by specific criteria (status, dates, customer) with complex queries like date ranges or multiple conditions.

Input Parameters

string
Comma-separated list of relationships to sideload (e.g., ‘customer,lines,plannings’).
integer
Number of orders per page. If not specified, server default is used.
integer
Page number to retrieve, must be >= 1.
string
Comma-separated list of order fields to return (e.g., ‘id,number,status,customer_id’). If not specified, all fields are returned.
object
Filter conditions with logical operator for order search.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_SEARCH_PLANNINGSSearch Booqable planning records using a group of conditions combined with an AND or OR operator. Specify pagination, select planning fields, and include related resources to tailor the results.

Input Parameters

object
Field selection specification for controlling response fields.
string
Comma-separated list of relationships to include (e.g., ‘product’, ‘bundle’, ‘location’, ‘order’).
integer
Number of plannings per page. If not specified, server default is used.
integer
Page number to retrieve, must be >= 1.
object
Filter conditions with logical operator for advanced search.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOQABLE_UPDATE_COMPANIESTool to update the current company’s information in Booqable. Use when you need to modify company details such as name, contact information, address, or billing settings.

Input Parameters

string
City name
string
Company name
string
Company email address
string
Company phone number
string
State or region
string
Country name
string
Company website URL
string
Postal/ZIP code
string
Company timezone (e.g., ‘America/New_York’, ‘Europe/Amsterdam’)
string
VAT or tax identification number
string
Billing email address (if different from main email)
string
First line of the company address
string
Second line of the company address (optional)
boolean
Whether to use a separate billing address

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not