Booqable
booqableBooqable is a rental software platform that helps businesses manage inventory, bookings, and online reservations.
Acciones disponibles (14)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Create CustomerBOOQABLE_CREATE_CUSTOMERAcciónTool 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.
BOOQABLE_CREATE_CUSTOMERAcciónTool 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.
Parámetros de entrada
namestringObligatorioThe name of the customer
emailstringE-mail address of the customer
phonestringCustomer's phone number
tax_region_idintegerAssociated tax region ID
properties_attributesobject[]List of custom properties for the customer
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create OrderBOOQABLE_CREATE_ORDERAcciónTool 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'.
BOOQABLE_CREATE_ORDERAcciónTool 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'.
Parámetros de entrada
stops_atstringOrder stop datetime in ISO8601 format, e.g., '2018-02-01T09:00:00Z'.
starts_atstringOrder start datetime in ISO8601 format, e.g., '2018-01-01T09:00:00Z'.
customer_idstringObligatorioID of the customer for the order.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Product GroupBOOQABLE_CREATE_PRODUCT_GROUPAcciónTool 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.
BOOQABLE_CREATE_PRODUCT_GROUPAcciónTool 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.
Parámetros de entrada
skustringStock Keeping Unit identifier for the product group.
namestringObligatorioName of the product group.
price_typestringPricing type (e.g., 'simple').
price_periodstringPricing period (e.g., 'day').
base_price_in_centsintegerBase price in cents for the product group.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete CustomerBOOQABLE_DELETE_CUSTOMERAcciónTool to delete (archive) a customer by id. use after confirming the customer should be hidden from searches.
BOOQABLE_DELETE_CUSTOMERAcciónTool to delete (archive) a customer by id. use after confirming the customer should be hidden from searches.
Parámetros de entrada
idstringObligatorioThe unique identifier (UUID or numeric ID) of the customer to delete (archive).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete OrderBOOQABLE_DELETE_ORDERAcciónTool to delete (archive) an order by id. use when you need to hide completed or canceled orders from active listings.
BOOQABLE_DELETE_ORDERAcciónTool to delete (archive) an order by id. use when you need to hide completed or canceled orders from active listings.
Parámetros de entrada
idstringObligatorioThe UUID or numeric ID of the order to archive.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Product GroupBOOQABLE_DELETE_PRODUCT_GROUPAcciónTool to delete a product group by id. use when you need to permanently remove a product group from your catalog after confirming its identifier.
BOOQABLE_DELETE_PRODUCT_GROUPAcciónTool to delete a product group by id. use when you need to permanently remove a product group from your catalog after confirming its identifier.
Parámetros de entrada
idstringObligatorioThe unique identifier of the product group to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get CustomerBOOQABLE_GET_CUSTOMERAcciónTool to fetch a specific customer by id. use after obtaining a customer identifier to retrieve full customer details.
BOOQABLE_GET_CUSTOMERAcciónTool to fetch a specific customer by id. use after obtaining a customer identifier to retrieve full customer details.
Parámetros de entrada
idstringObligatorioUnique identifier (UUID) or customer number to fetch.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get CustomersBOOQABLE_GET_CUSTOMERSAcciónTool to retrieve a list of customers. use when you need to paginate through customers.
BOOQABLE_GET_CUSTOMERSAcciónTool to retrieve a list of customers. use when you need to paginate through customers.
Parámetros de entrada
perintegerNumber of customers per page. If None, server default is used.
pageintegerPage number to retrieve, must be >= 1.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get OrderBOOQABLE_GET_ORDERAcciónTool 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.
BOOQABLE_GET_ORDERAcciónTool 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.
Parámetros de entrada
idstringObligatorioUnique identifier (UUID or numeric) of the order to fetch.
includestring[]List of related resources to include, e.g., ['customer','coupon','start_location'].
fields[orders]string[]List of order fields to include in the response, e.g., ['created_at','updated_at','number'].
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get OrdersBOOQABLE_GET_ORDERSAcciónTool to list all orders. use when you need to retrieve orders, optionally filtered by search term or paginated.
BOOQABLE_GET_ORDERSAcciónTool to list all orders. use when you need to retrieve orders, optionally filtered by search term or paginated.
Parámetros de entrada
qstringSearch term to filter orders.
perintegerLimits the number of orders per page.
pageintegerPage number to display. Defaults to 1.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ProductBOOQABLE_GET_PRODUCTAcciónTool to fetch a specific product by id. use after obtaining a product identifier to retrieve detailed inventory item data.
BOOQABLE_GET_PRODUCTAcciónTool to fetch a specific product by id. use after obtaining a product identifier to retrieve detailed inventory item data.
Parámetros de entrada
idstringObligatorioUnique identifier of the product to fetch.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Product GroupBOOQABLE_GET_PRODUCT_GROUPAcciónTool to fetch a specific product group by id. use after obtaining the product group identifier to retrieve its full details.
BOOQABLE_GET_PRODUCT_GROUPAcciónTool to fetch a specific product group by id. use after obtaining the product group identifier to retrieve its full details.
Parámetros de entrada
idstringObligatorioUnique identifier (UUID) of the product group to fetch.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Product GroupsBOOQABLE_GET_PRODUCT_GROUPSAcciónTool to retrieve a list of product groups. use when you need to browse product catalog by pages.
BOOQABLE_GET_PRODUCT_GROUPSAcciónTool to retrieve a list of product groups. use when you need to browse product catalog by pages.
Parámetros de entrada
perintegerNumber of product groups per page. If None, server default is used.
pageintegerPage number to retrieve, must be >= 1.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ProductsBOOQABLE_GET_PRODUCTSAcciónTool to retrieve a list of products. use when you need to list inventory items with pagination and filtering.
BOOQABLE_GET_PRODUCTSAcciónTool to retrieve a list of products. use when you need to list inventory items with pagination and filtering.
Parámetros de entrada
qstringSearch term to filter products by name or description.
perintegerNumber of products per page. If None, server default is used.
skustringFilter products by SKU.
pageintegerPage number to retrieve, must be >= 1.
sortstringSort key for products (e.g., name, sku, created_at).
activebooleanFilter products by active status (true or false).
barcodestringFilter products by barcode.
category_idstringFilter products by category ID.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not