Booqable

These are the Booqable actions available to the apps you build with Snow. Connecting an account does not make Snow run these on its own.

• Create Customer

  Tool 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.

• Create Order

  Tool 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'.

• Get Customer

  Tool to fetch a specific customer by ID. Use after obtaining a customer identifier to retrieve full customer details.

• Get Customers

  Tool to retrieve a list of customers. Use when you need to paginate through customers.

• Get Inventory Levels

  Tool to fetch inventory levels for products. Shows availability of products across locations for a date range. Use when checking product availability or stock levels.

• Get Order

  Tool 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.

• Get Product

  Tool to fetch a specific product by ID. Use after obtaining a product identifier to retrieve detailed inventory item data.

• List Bundle Items

  Tool to retrieve a list of bundle items. Use when you need to see which products are included in bundles, with their quantities and discounts.

• List Coupons

  Tool to retrieve a list of coupons. Use when you need to list or search for discount coupons with pagination and filtering.

• List Documents

  Tool to retrieve a list of documents. Use when you need to fetch invoices, quotes, contracts, or packing slips with optional filtering and pagination.

• List Employees

  Tool to retrieve a list of employees from Booqable. Use when you need to list employee accounts with pagination and filtering options.

• List Items

  Tool to retrieve a list of items (products and product groups). Use when you need to browse the catalog with pagination and filtering.

• List Lines

  Tool to retrieve a paginated list of lines from orders. Use when you need to list line items, with support for filtering by order, product, or other attributes.

• List Orders

  Tool 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.

• List Payments

  Tool to list all payments from Booqable. Use when you need to retrieve payment records with optional filtering by created_at, order_id, payment_method, or payment_status.

• List Plannings

  Tool to retrieve planning records that track product and bundle reservations across locations and time periods. Use when you need to check what items are planned or reserved for specific dates, locations, or orders.

• List Price Rulesets

  Tool to list price rulesets. Use when you need to retrieve price rulesets with optional filtering by archived status, name, or ID, and pagination support.

• List Price Structures

  Tool to list price structures. Use when you need to retrieve price structures with optional filtering by name, ID, or product group, and pagination support.

• List Product Groups

  Tool to list product groups from Booqable API v4. Use when you need to retrieve multiple product groups with filtering, pagination, and field selection options.

• List Products

  Tool to retrieve a list of products. Use when you need to browse products with pagination and filtering.

• List Properties

  Tool to retrieve a list of properties. Use when you need to list custom properties associated with customers, products, or other resources in Booqable.

• List Stock Items

  Tool to retrieve a list of stock items. Use when you need to list physical inventory items with tracking identifiers like serial numbers or barcodes.

• List Tax Rates

  Tool to retrieve a list of tax rates. Use when you need to list or search for tax rates with pagination and filtering.

• List Users

  Tool to retrieve a list of users from Booqable. Use when you need to list user accounts with pagination and filtering options.

• Search Bundles

  Tool 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.

• Search Customers

  Tool to search customers in the Booqable system. Use when you need to retrieve customer data with optional field selection and relationship inclusion.

• Search Documents

  Tool to search documents using advanced filtering with logical operators. Use when you need to find documents matching complex criteria with AND/OR conditions.

• Search Items

  Tool to search items (products and bundles) with advanced filtering. Use when you need to find items by specific criteria (name, product_type, archived status, etc.) using complex queries.

• Search Orders

  Tool 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.

• Search Plannings

  Tool to search plannings with advanced filtering. Use when you need to find planning records by specific criteria using complex queries with logical operators.

• Create Product Group

  Tool 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.

• Delete Customer

  Tool to delete (archive) a customer by ID. Use after confirming the customer should be hidden from searches.

• Delete Order

  Tool to delete (archive) an order by ID. Use when you need to hide completed or canceled orders from active listings.

• Delete Product Group

  Tool to delete a product group by ID. Use when you need to permanently remove a product group from your catalog after confirming its identifier.

• Get New Order

  Tool to retrieve a new order template with default values. Use when you need to initialize an order creation form or fetch default order settings before creating an order.

• Get Product Group

  Tool to fetch a specific product group by ID. Use after obtaining the product group identifier to retrieve its full details.

• List Barcodes

  Tool to retrieve a list of barcodes. Use when you need to list barcodes with pagination, filtering by owner, type, or dates.

• List Clusters

  Tool to retrieve a list of clusters from Booqable. Use when you need to list clusters with optional filtering, field selection, and pagination support.

• List Default Properties

  Tool to retrieve a list of default properties from Booqable. Use when you need to view custom property definitions with pagination, filtering, or sorting options.

• List Email Templates

  Tool to list email templates from Booqable. Use when you need to retrieve available email templates with optional filtering, pagination, and sorting.

• List Inventory Breakdowns

  Tool 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.

• List Locations

  Tool to retrieve a list of locations from Booqable. Use when you need to view available locations with pagination, filtering, or sorting options.

• List Notes

  Tool to retrieve a list of notes. Use when you need to list notes with optional filtering by owner, date, or content.

• List Payment Methods

  Tool 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.

• List Photos

  Tool 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.

• List Provinces

  Tool to retrieve a list of provinces. Use when you need to list available provinces, optionally filtered by country.

• List Stock Item Plannings

  Tool to retrieve a list of stock item plannings. Use when you need to list stock item plannings with filtering and pagination.

• List Tax Values

  Tool to retrieve a list of tax values. Use when you need to fetch tax rates with optional filtering, pagination, and sorting.

• Update Company

  Tool 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.