• Documentation >
• Apps >
• Productivity >
• Booqable

Booqable

With Booqable modules in Ibexa Connect, you can create, update, list, retrieve, and delete orders, order lines, customers, product groups, and planning.

To get started with Booqable, create an account at booqable.com.

Connecting Booqable to Ibexa Connect

To connect to Booqable account, you need to obtain API Key from your account.

1. Log in to your Booqable account.

2. Click your profile icon > User Settings > New authentication method.

   

3. Enter a name for the token, select the token, and click Save.

   

4. Copy the token to your clipboard.

   

5. Log in to your Ibexa Connect account, insert Unleashed Software module in your scenario and click the Add button next to the Connection field.

   

6. In the Connection name field, enter a name for the connection.

7. In the Company Name field, enter the company name you have provided when creating the account.

8. In the API Key field, enter the token copied in step 4 and click Save.

You have successfully connected the Booqable app and can now build scenarios.

Customers

You can create, update, retrieve, list, restore and archive customers using the following modules.

Create a Customer

Creates a new customer.

For field descriptions, see the Booqable API reference.

Update a Customer

Updates an existing customer.

Customer ID	Select or map the Customer ID whose details you want to update.

For field descriptions, see the Booqable API reference.

Get a Customer

Retrieves an existing customer.

Customer ID	Select or map the Customer ID whose details you want to retrieve.

List Customers

Retrieves a list of customers.

Limit	Set the maximum number of customers Ibexa Connect will return during one execution cycle.

Restore a Customer

Restores an existing customer.

Customer ID	Enter the Customer ID whom you want to restore.

Archive a Customer

Archives an existing customer.

Customer ID	Select or map the Customer ID whom you want to archive.

Product Group

You can create, update, retrieve, list, restore, and archive product groups using the following modules.

Create a Product Group

Creates a new product group.

For field descriptions, see the Booqable API reference.

Update a Product Group

Updates an existing product group.

Product Group ID	Select or map the Product Group ID whose details you want to update.

For field descriptions, see the Booqable API reference.

Get a Product Group

Retrieves an existing product group.

Product Group ID	elect or map the Product Group ID whose details you want to retrieve.

List Product Groups

Retrieves a list of product groups.

Limit	Set the maximum number of product groups Ibexa Connect will return during one execution cycle.

Get a Product Pricing Structure

Retrieves the pricing structure of the product.

Product Group ID	Select or map the Product Group ID whose product details you want to retrieve.
Product ID	Enter the Product ID whose pricing structure you want to retrieve.

Restore a Product Group

Restores an existing product group.

Product Group ID	Enter the Product Group ID whom you want to restore.

Archive a Product Group

Archives an existing product group.

Product Group ID	Enter the Product Group ID whom you want to archive.

Orders

You can create, update, retrieve, list, reverse, start, stop, cancel, duplicate, and archive orders using the following modules.

Create an Order

Creates a new order.

For field descriptions, see the Booqable API reference.

Update an Order

Updates an existing order.

Order Number	Select or map the order number whose details you want to update.

For field descriptions, see the Booqable API reference.

Get an Order

Retrieves an existing order.

Order Number	Select or map the Order Number whose details you want to retrieve.

List Orders

Retrieves a list of orders.

Term	Enter a term to search orders that match the specified term. For example, term=John would return all orders with the term John.
Limit	Set the maximum number of product groups Ibexa Connect will return during one execution cycle.

Book Order's Items

Reserves items for the duration of the order.

Order Number	Select or map the order number whose items you want to book.

For field descriptions, see the Booqable API reference.

Save an Order as a Concept

Saves an order as a concept.

Order ID	Enter the Order ID which you want to save as a concept.

Reserve an Order

Reserves an order and book all the products in it.

Order ID	Enter the Order ID which you want to reserve.

Start Order

Starts an order.

Order Number	Select or map the order number whose order you want to start.

For field descriptions, see the Booqable API reference.

Stop Order

Stops an order.

Order Number	Select or map the order number whose order you want to stop.

For field descriptions, see the Booqable API reference.

Cancel Order

Cancels an order.

Order Number	Select or map the order number whose order you want to cancel.

Revert Order to a Status

Reverts an order to a given status.

Order ID	Select or map the Order ID whose status you want to revert.
Status	Select the order status: Concept Reserved Started

Duplicate an Order

Duplicates an existing order.

Order ID	Select or map the Order ID which you want to duplicate.

Recalculates Prices

Recalculates the prices for the given order.

Order ID	Select or map the Order ID whose prices you want to recalculate.

Archive an Order

Archives an order.

Order ID	Select or map the Order ID you want to archive.

Planning

You can delete planning from an order using the following module.

Delete a Planning

Deletes planning from an order.

Order Number	Select or map the Order Number whose details you want to delete.
Planning ID	Enter the Planning ID you want to delete.

Order Lines

You can create, update and delete order lines using the following modules.

Create an Order Line

Creates a new line in the order.

Order Number	Select or map the Order Number whose order line you want to create.

For field descriptions, see the Booqable API reference.

Update an Order Line

Updates an existing order line.

Order Number	Select or map the Order Number whose order line you want to update.

For field descriptions, see the Booqable API reference.

Delete an Order Line

Deletes an existing order line.

Order Number	Select or map the Order Number whose order line you want to delete.
Line ID	Enter the Line ID you want to delete.

Other

You can call APIs using the following module.

Make an API Call

Performs an arbitrary authorized API call.

URL	Enter a path relative to https://www-integromat-com.booqable.com. For example: /api/1/orders.
Method	GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry.
Headers	Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String	Enter the request query string.
Body	Enter the body content for your API call.

Example of use - List Product Groups

The following API call returns all product groups from your account.

URL: /api/1/product_groups

Method: GET

The search matches can be found in the module's Output under Bundle > Body > product_groups.

In our example 5 product groups were returned: