Booqable

App · 20 actions

Run your Booqable rental business: create orders and book products on them, reserve, archive or cancel orders, manage customers and product groups, check availability, and list invoices and payments. Start workflows on new orders, status changes and new customers.

Actions

ActionWhat it does
Archive customerArchive a customer so they no longer show in lists.
Archive product groupArchive a product group and its products so they can't be booked any more.
Book product on orderAdd a quantity of a product to an order, which holds that stock for the rental period.
Change order statusSave an order as a draft, reserve it (its items are then held for it), archive it, cancel it, or set it back to started or stopped.
Check availabilitySee how many units of a product are free to book for a rental period at a location, after existing reservations.
Create customerCreate a customer, a person or a company, to put orders under.
Create orderCreate an order for a rental period, optionally for a customer.
Create product groupAdd something to rent or sell.
Get customerGet one customer with their email, type, discount and order totals.
Get orderGet one order with its rental period, status, customer and amounts.
Get product groupGet one product group with its type, pricing, deposit and stock settings.
List customersList customers by name, optionally matching a search or an exact email.
List documentsList invoices, quotes and contracts, newest first, optionally of one order or customer.
List ordersList orders, newest first, filtered by status, payment status, customer, rental start or a search.
List paymentsList payments (charges, card authorizations and refunds), newest first, optionally of one order or customer, with their status.
List product groupsList product groups (the items you rent or sell, with their pricing) by name.
List productsList the products you can book on orders (a product group's product, or each of its variations), optionally of one group.
Update customerChange a customer's name, email, type, default discount or tags.
Update orderChange an order's customer, rental period, pick-up and return locations or tags.
Update product groupChange a product group's name, SKU, pricing, price, deposit, description, store visibility or tags.

Archive customer

Archive a customer so they no longer show in lists. Their orders and documents stay.

Inputs

Customercustomer_idtextRequired
The customer. Pick one, or give their id from an earlier step.

Outputs

archivedtrue/false
Always true once archived
customerobject
The customer, now archived
customer_idtext
The customer archived
Example output
{
  "archived": true,
  "customer": {
    "archived": true,
    "balance_due_in_cents": 0,
    "created_at": "2026-01-10T09:00:00.000000+00:00",
    "deposit_type": "default",
    "discount_percentage": 0.0,
    "email": "jo@example.com",
    "id": "5e7fb1d5-a69a-4dad-8f6c-0a321ec6da2c",
    "legal_type": "person",
    "name": "Jo Bloggs",
    "number": 12,
    "order_count": 3,
    "properties": {},
    "revenue_in_cents": 45000,
    "tag_list": [
      "vip"
    ],
    "updated_at": "2026-10-01T09:00:00.000000+00:00"
  },
  "customer_id": "5e7fb1d5-a69a-4dad-8f6c-0a321ec6da2c"
}

Archive product group

Archive a product group and its products so they can't be booked any more. Past orders keep them.

Inputs

Product groupproduct_group_idtextRequired
The product group. Pick one, or give its id from an earlier step.

Outputs

archivedtrue/false
Always true once archived
product_groupobject
The product group, now archived
product_group_idtext
The product group archived
Example output
{
  "archived": true,
  "product_group": {
    "archived": true,
    "base_price_in_cents": 7500,
    "created_at": "2026-02-01T09:00:00.000000+00:00",
    "deposit_in_cents": 50000,
    "description": "Full-frame mirrorless camera.",
    "flat_fee_price_in_cents": 7500,
    "has_variations": false,
    "id": "66a43973-a27a-4282-8f4a-c125934b1469",
    "name": "Canon EOS R5",
    "price_period": "day",
    "price_type": "simple",
    "product_type": "rental",
    "show_in_store": true,
    "sku": "CAM-R5",
    "slug": "canon-eos-r5",
    "tag_list": [
      "cameras"
    ],
    "trackable": false,
    "tracking_type": "bulk",
    "updated_at": "2026-02-01T09:00:00.000000+00:00"
  },
  "product_group_id": "66a43973-a27a-4282-8f4a-c125934b1469"
}

Book product on order

Add a quantity of a product to an order, which holds that stock for the rental period. Booking the same product again adds to its line.

Inputs

Order IDorder_idtextRequired
The order's id, from 'List orders', a trigger or an earlier step.
Productproduct_idtextRequired
The product (a product group's product, or one of its variations). Pick one, or give its id from 'List products'.
Quantityquantitynumber
How many to book. Defaults to 1.At least 1.
Go ahead despite a shortageconfirm_shortagetrue/false
Turn on to go ahead when Booqable warns that there isn't enough stock, where the product allows a shortage.Default: false.

Outputs

lineslist
The order lines added or changed
orderobject
The order, with its new totals
quantitynumber
How many were booked
Example output
{
  "lines": [
    {
      "id": "8b0d61c7-3a5e-4b8a-9c1d-2f6e7a8b9c0d",
      "item_id": "ed6e7fb4-7f13-4729-8dce-0f8b8c640d0b",
      "line_type": "charge",
      "planning_id": "1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f",
      "price_each_in_cents": 15000,
      "price_in_cents": 15000,
      "quantity": 1,
      "title": "Canon EOS R5"
    }
  ],
  "order": {
    "created_at": "2026-11-10T14:00:00.000000+00:00",
    "customer_id": "5e7fb1d5-a69a-4dad-8f6c-0a321ec6da2c",
    "deposit_in_cents": 10000,
    "fulfillment_type": "pickup",
    "grand_total_in_cents": 15000,
    "grand_total_with_tax_in_cents": 18150,
    "id": "3475c076-354c-4870-8326-459b23381f95",
    "item_count": 1,
    "location_shortage": false,
    "number": 1042,
    "paid_in_cents": 0,
    "payment_status": "payment_due",
    "price_in_cents": 15000,
    "properties": {},
    "start_location_id": "595f65d5-8218-4704-83ae-39aff6d1aeb4",
    "starts_at": "2026-12-01T09:00:00.000000+00:00",
    "status": "reserved",
    "status_counts": {
      "draft": 0,
      "new": 0,
      "reserved": 1,
      "started": 0
    },
    "statuses": [
      "reserved"
    ],
    "stop_location_id": "595f65d5-8218-4704-83ae-39aff6d1aeb4",
    "stops_at": "2026-12-03T17:00:00.000000+00:00",
    "tag_list": [
      "webshop"
    ],
    "tax_in_cents": 3150,
    "to_be_paid_in_cents": 28150,
    "total_in_cents": 28150,
    "updated_at": "2026-11-10T14:05:00.000000+00:00"
  },
  "quantity": 1
}

Change order status

Save an order as a draft, reserve it (its items are then held for it), archive it, cancel it, or set it back to started or stopped. Nothing changes if it is already in that status.

Inputs

Order IDorder_idtextRequired
The order's id, from 'List orders', a trigger or an earlier step.
New statusstatustextRequired
The status to move the order to.One of: draft, reserved, archived, canceled, started (Back to started), stopped (Back to stopped).
Go ahead despite a shortageconfirm_shortagetrue/false
Turn on to go ahead when Booqable warns that there isn't enough stock, where the product allows a shortage.Default: false.

Outputs

changedtrue/false
False if it was already in that status
orderobject
The order, as it is now
previous_statustext
The status it had before
Example output
{
  "changed": true,
  "order": {
    "created_at": "2026-11-10T14:00:00.000000+00:00",
    "customer_id": "5e7fb1d5-a69a-4dad-8f6c-0a321ec6da2c",
    "deposit_in_cents": 10000,
    "fulfillment_type": "pickup",
    "grand_total_in_cents": 15000,
    "grand_total_with_tax_in_cents": 18150,
    "id": "3475c076-354c-4870-8326-459b23381f95",
    "item_count": 1,
    "location_shortage": false,
    "number": 1042,
    "paid_in_cents": 0,
    "payment_status": "payment_due",
    "price_in_cents": 15000,
    "properties": {},
    "start_location_id": "595f65d5-8218-4704-83ae-39aff6d1aeb4",
    "starts_at": "2026-12-01T09:00:00.000000+00:00",
    "status": "reserved",
    "status_counts": {
      "draft": 0,
      "new": 0,
      "reserved": 1,
      "started": 0
    },
    "statuses": [
      "reserved"
    ],
    "stop_location_id": "595f65d5-8218-4704-83ae-39aff6d1aeb4",
    "stops_at": "2026-12-03T17:00:00.000000+00:00",
    "tag_list": [
      "webshop"
    ],
    "tax_in_cents": 3150,
    "to_be_paid_in_cents": 28150,
    "total_in_cents": 28150,
    "updated_at": "2026-11-10T14:05:00.000000+00:00"
  },
  "previous_status": "draft"
}

Check availability

See how many units of a product are free to book for a rental period at a location, after existing reservations.

Inputs

Productproduct_idtextRequired
The product (a product group's product, or one of its variations). Pick one, or give its id from 'List products'.
Fromfrom_timedate and timeRequired
The start of the rental period.
Untiltill_timedate and timeRequired
The end of the rental period.
Locationlocation_idtext
Where to check. Leave empty for Booqable's first location.

Outputs

availablenumber
How many units are free for the whole period
fromtext
The start, in the company's local time
location_idtext
The location checked
plannablenumber
How many can be booked, counting an allowed shortage
product_idtext
The product checked
tilltext
The end, in the company's local time
Example output
{
  "available": 2,
  "from": "2026-12-01T09:00:00Z",
  "location_id": "595f65d5-8218-4704-83ae-39aff6d1aeb4",
  "plannable": 2,
  "product_id": "ed6e7fb4-7f13-4729-8dce-0f8b8c640d0b",
  "till": "2026-12-03T17:00:00Z"
}

Create customer

Create a customer, a person or a company, to put orders under.

Inputs

NamenametextRequired
The person's or company's name.
Emailemailtext
Their email address.
Typelegal_typetext
A person or a company.One of: person, commercial (Company).
Default discount (%)discount_percentagenumber
A discount applied to each new order of theirs, 0 to 100.From 0 to 100.
Tagstagslist
Tags to set. They replace the tags already there.

Outputs

customerobject
The customer
Example output
{
  "customer": {
    "archived": false,
    "balance_due_in_cents": 0,
    "created_at": "2026-01-10T09:00:00.000000+00:00",
    "deposit_type": "default",
    "discount_percentage": 0.0,
    "email": "jo@example.com",
    "id": "5e7fb1d5-a69a-4dad-8f6c-0a321ec6da2c",
    "legal_type": "person",
    "name": "Jo Bloggs",
    "number": 12,
    "order_count": 3,
    "properties": {},
    "revenue_in_cents": 45000,
    "tag_list": [
      "vip"
    ],
    "updated_at": "2026-10-01T09:00:00.000000+00:00"
  }
}

Create order

Create an order for a rental period, optionally for a customer. It starts empty: use 'Book product on order' to add products.

Inputs

Customercustomer_idtext
Who the order is for. Pick one, or give their id.
Rental startsstarts_atdate and timeRequired
When the items go out and stop being available to others.
Rental endsstops_atdate and timeRequired
When the items are back and available again.
Pick-up locationstart_location_idtext
Where the items are collected. Leave empty for Booqable's first location.
Return locationstop_location_idtext
Where the items are returned. Leave empty for Booqable's first location.
Tagstagslist
Tags to set. They replace the tags already there.
Statusstatustext
Where it starts. Booqable's default is New, which only you see until it is saved as a draft or reserved.One of: new (New (only you see it)), draft, reserved.

Outputs

orderobject
The order
Example output
{
  "order": {
    "created_at": "2026-11-10T14:00:00.000000+00:00",
    "customer_id": "5e7fb1d5-a69a-4dad-8f6c-0a321ec6da2c",
    "deposit_in_cents": 10000,
    "fulfillment_type": "pickup",
    "grand_total_in_cents": 15000,
    "grand_total_with_tax_in_cents": 18150,
    "id": "3475c076-354c-4870-8326-459b23381f95",
    "item_count": 1,
    "location_shortage": false,
    "number": 1042,
    "paid_in_cents": 0,
    "payment_status": "payment_due",
    "price_in_cents": 15000,
    "properties": {},
    "start_location_id": "595f65d5-8218-4704-83ae-39aff6d1aeb4",
    "starts_at": "2026-12-01T09:00:00.000000+00:00",
    "status": "draft",
    "status_counts": {
      "draft": 0,
      "new": 0,
      "reserved": 1,
      "started": 0
    },
    "statuses": [
      "reserved"
    ],
    "stop_location_id": "595f65d5-8218-4704-83ae-39aff6d1aeb4",
    "stops_at": "2026-12-03T17:00:00.000000+00:00",
    "tag_list": [
      "webshop"
    ],
    "tax_in_cents": 3150,
    "to_be_paid_in_cents": 28150,
    "total_in_cents": 28150,
    "updated_at": "2026-11-10T14:05:00.000000+00:00"
  }
}

Create product group

Add something to rent or sell. Booqable makes its product with it, which 'List products' finds for booking.

Inputs

NamenametextRequired
The product's name, as customers see it.
Typeproduct_typetext
What kind of product. Defaults to Rental. Can't be changed later.One of: rental, sales_item (Sales item), service. Default: rental.
Stock trackingtracking_typetext
How stock is counted. Defaults to bulk for rentals and not tracked for the rest. Can't be changed later.One of: bulk (Bulk (count only)), trackable (Trackable (each item has an identifier)), none (Not tracked (services and sales items)).
SKUskutext
Your stock keeping unit code.
Pricingprice_typetext
How it is priced.One of: simple (A price per period), fixed (A fixed price), none (Free).
Price periodprice_periodtext
What the price is per, for a price per period.One of: hour (Per hour), day (Per day), week (Per week), month (Per month), minute (Per minute).
Pricepricenumber
The price in your Booqable currency, such as 25.00.At least 0.
Depositdepositnumber
The deposit asked per item, such as 100.00.At least 0.
Descriptiondescriptiontext
The description shown in your online store.
Show in online storeshow_in_storetrue/false
Whether it appears in your Booqable online store.
Tagstagslist
Tags to set. They replace the tags already there.

Outputs

product_groupobject
The product group
Example output
{
  "product_group": {
    "archived": false,
    "base_price_in_cents": 7500,
    "created_at": "2026-02-01T09:00:00.000000+00:00",
    "deposit_in_cents": 50000,
    "description": "Full-frame mirrorless camera.",
    "flat_fee_price_in_cents": 7500,
    "has_variations": false,
    "id": "66a43973-a27a-4282-8f4a-c125934b1469",
    "name": "Canon EOS R5",
    "price_period": "day",
    "price_type": "simple",
    "product_type": "rental",
    "show_in_store": true,
    "sku": "CAM-R5",
    "slug": "canon-eos-r5",
    "tag_list": [
      "cameras"
    ],
    "trackable": false,
    "tracking_type": "bulk",
    "updated_at": "2026-02-01T09:00:00.000000+00:00"
  }
}

Get customer

Get one customer with their email, type, discount and order totals.

Inputs

Customercustomer_idtextRequired
The customer. Pick one, or give their id from an earlier step.

Outputs

customerobject
The customer
Example output
{
  "customer": {
    "archived": false,
    "balance_due_in_cents": 0,
    "created_at": "2026-01-10T09:00:00.000000+00:00",
    "deposit_type": "default",
    "discount_percentage": 0.0,
    "email": "jo@example.com",
    "id": "5e7fb1d5-a69a-4dad-8f6c-0a321ec6da2c",
    "legal_type": "person",
    "name": "Jo Bloggs",
    "number": 12,
    "order_count": 3,
    "properties": {},
    "revenue_in_cents": 45000,
    "tag_list": [
      "vip"
    ],
    "updated_at": "2026-10-01T09:00:00.000000+00:00"
  }
}

Get order

Get one order with its rental period, status, customer and amounts.

Inputs

Order IDorder_idtextRequired
The order's id, from 'List orders', a trigger or an earlier step.

Outputs

orderobject
The order
Example output
{
  "order": {
    "created_at": "2026-11-10T14:00:00.000000+00:00",
    "customer_id": "5e7fb1d5-a69a-4dad-8f6c-0a321ec6da2c",
    "deposit_in_cents": 10000,
    "fulfillment_type": "pickup",
    "grand_total_in_cents": 15000,
    "grand_total_with_tax_in_cents": 18150,
    "id": "3475c076-354c-4870-8326-459b23381f95",
    "item_count": 1,
    "location_shortage": false,
    "number": 1042,
    "paid_in_cents": 0,
    "payment_status": "payment_due",
    "price_in_cents": 15000,
    "properties": {},
    "start_location_id": "595f65d5-8218-4704-83ae-39aff6d1aeb4",
    "starts_at": "2026-12-01T09:00:00.000000+00:00",
    "status": "reserved",
    "status_counts": {
      "draft": 0,
      "new": 0,
      "reserved": 1,
      "started": 0
    },
    "statuses": [
      "reserved"
    ],
    "stop_location_id": "595f65d5-8218-4704-83ae-39aff6d1aeb4",
    "stops_at": "2026-12-03T17:00:00.000000+00:00",
    "tag_list": [
      "webshop"
    ],
    "tax_in_cents": 3150,
    "to_be_paid_in_cents": 28150,
    "total_in_cents": 28150,
    "updated_at": "2026-11-10T14:05:00.000000+00:00"
  }
}

Get product group

Get one product group with its type, pricing, deposit and stock settings.

Inputs

Product groupproduct_group_idtextRequired
The product group. Pick one, or give its id from an earlier step.

Outputs

product_groupobject
The product group
Example output
{
  "product_group": {
    "archived": false,
    "base_price_in_cents": 7500,
    "created_at": "2026-02-01T09:00:00.000000+00:00",
    "deposit_in_cents": 50000,
    "description": "Full-frame mirrorless camera.",
    "flat_fee_price_in_cents": 7500,
    "has_variations": false,
    "id": "66a43973-a27a-4282-8f4a-c125934b1469",
    "name": "Canon EOS R5",
    "price_period": "day",
    "price_type": "simple",
    "product_type": "rental",
    "show_in_store": true,
    "sku": "CAM-R5",
    "slug": "canon-eos-r5",
    "tag_list": [
      "cameras"
    ],
    "trackable": false,
    "tracking_type": "bulk",
    "updated_at": "2026-02-01T09:00:00.000000+00:00"
  }
}

List customers

List customers by name, optionally matching a search or an exact email. Gets one page; run it again with the next page number to see more.

Inputs

Searchsearchtext
Words to look for, as in Booqable's own search box.
Emailemailtext
Only the customer with exactly this email address.
Archivedarchivedtext
Whether to include archived ones. Defaults to not archived.One of: active (Not archived (default)), archived (Archived only), all (Both). Default: active.
Pagepagenumber
Which page to get, starting at 1.At least 1.
Page sizepage_sizenumber
How many to return, 1 to 100. Booqable's default is 25.From 1 to 100.

Outputs

countnumber
How many are on this page
customerslist
The customers
has_moretrue/false
True when the page was full, so there may be another
pagenumber
The page number
Example output
{
  "count": 1,
  "customers": [
    {
      "archived": false,
      "balance_due_in_cents": 0,
      "created_at": "2026-01-10T09:00:00.000000+00:00",
      "deposit_type": "default",
      "discount_percentage": 0.0,
      "email": "jo@example.com",
      "id": "5e7fb1d5-a69a-4dad-8f6c-0a321ec6da2c",
      "legal_type": "person",
      "name": "Jo Bloggs",
      "number": 12,
      "order_count": 3,
      "properties": {},
      "revenue_in_cents": 45000,
      "tag_list": [
        "vip"
      ],
      "updated_at": "2026-10-01T09:00:00.000000+00:00"
    }
  ],
  "has_more": false,
  "page": 1
}

List documents

List invoices, quotes and contracts, newest first, optionally of one order or customer.

Inputs

Typedocument_typetext
Only invoices, quotes or contracts.One of: invoice, quote, contract.
Order IDorder_idtext
Only those of this order.
Customercustomer_idtext
Only those of this customer.
Archivedarchivedtext
Whether to include archived ones. Defaults to not archived.One of: active (Not archived (default)), archived (Archived only), all (Both). Default: active.
Pagepagenumber
Which page to get, starting at 1.At least 1.
Page sizepage_sizenumber
How many to return, 1 to 100. Booqable's default is 25.From 1 to 100.

Outputs

countnumber
How many are on this page
documentslist
The documents
has_moretrue/false
True when the page was full, so there may be another
pagenumber
The page number
Example output
{
  "count": 1,
  "documents": [
    {
      "archived": false,
      "created_at": "2026-11-10T14:05:00.000000+00:00",
      "customer_id": "5e7fb1d5-a69a-4dad-8f6c-0a321ec6da2c",
      "date": "2026-11-10",
      "document_type": "invoice",
      "due_date": "2026-11-24",
      "finalized": true,
      "grand_total_with_tax_in_cents": 18150,
      "id": "a216b9f8-4f61-4eda-8672-3c6e94c9fbe2",
      "name": "Jo Bloggs",
      "number": 2026001,
      "order_id": "3475c076-354c-4870-8326-459b23381f95",
      "paid_in_cents": 0,
      "prefix_with_number": "2026001",
      "sent": false,
      "status": "payment_due",
      "to_be_paid_in_cents": 28150
    }
  ],
  "has_more": false,
  "page": 1
}

List orders

List orders, newest first, filtered by status, payment status, customer, rental start or a search. Gets one page; run it again with the next page number to see more.

Inputs

Statusstatustext
Only orders in this status. Leave empty for any saved order.One of: new (New (not saved yet)), draft, reserved, started (Started (picked up)), stopped (Stopped (returned)), archived, canceled.
Payment statuspayment_statustext
Only orders with this payment status.One of: payment_due (Payment due), partially_paid (Partially paid), paid, overpaid, process_deposit (Deposit to process).
Customercustomer_idtext
Only those of this customer.
Searchsearchtext
An order number, or words in the customer's name, email or address, the tags or custom fields.
Starting on or afterstarts_fromdate
Only rentals that start on or after this day.
Starting on or beforestarts_untildate
Only rentals that start on or before this day.
Order bysorttext
How to sort them. Defaults to newest first.One of: -created_at (Newest first (default)), created_at (Oldest first), starts_at (Starting soonest), -updated_at (Recently changed). Default: -created_at.
Pagepagenumber
Which page to get, starting at 1.At least 1.
Page sizepage_sizenumber
How many to return, 1 to 100. Booqable's default is 25.From 1 to 100.

Outputs

countnumber
How many are on this page
has_moretrue/false
True when the page was full, so there may be another
orderslist
The orders
pagenumber
The page number
Example output
{
  "count": 1,
  "has_more": false,
  "orders": [
    {
      "created_at": "2026-11-10T14:00:00.000000+00:00",
      "customer_id": "5e7fb1d5-a69a-4dad-8f6c-0a321ec6da2c",
      "deposit_in_cents": 10000,
      "fulfillment_type": "pickup",
      "grand_total_in_cents": 15000,
      "grand_total_with_tax_in_cents": 18150,
      "id": "3475c076-354c-4870-8326-459b23381f95",
      "item_count": 1,
      "location_shortage": false,
      "number": 1042,
      "paid_in_cents": 0,
      "payment_status": "payment_due",
      "price_in_cents": 15000,
      "properties": {},
      "start_location_id": "595f65d5-8218-4704-83ae-39aff6d1aeb4",
      "starts_at": "2026-12-01T09:00:00.000000+00:00",
      "status": "reserved",
      "status_counts": {
        "draft": 0,
        "new": 0,
        "reserved": 1,
        "started": 0
      },
      "statuses": [
        "reserved"
      ],
      "stop_location_id": "595f65d5-8218-4704-83ae-39aff6d1aeb4",
      "stops_at": "2026-12-03T17:00:00.000000+00:00",
      "tag_list": [
        "webshop"
      ],
      "tax_in_cents": 3150,
      "to_be_paid_in_cents": 28150,
      "total_in_cents": 28150,
      "updated_at": "2026-11-10T14:05:00.000000+00:00"
    }
  ],
  "page": 1
}

List payments

List payments (charges, card authorizations and refunds), newest first, optionally of one order or customer, with their status.

Inputs

Typepayment_typetext
Only charges, authorizations or refunds.One of: payment_charges (Charges), payment_authorizations (Authorizations), payment_refunds (Refunds).
Order IDorder_idtext
Only those of this order.
Customercustomer_idtext
Only those of this customer.
Succeeded on or aftersucceeded_fromdate
Only payments that went through on or after this day.
Pagepagenumber
Which page to get, starting at 1.At least 1.
Page sizepage_sizenumber
How many to return, 1 to 100. Booqable's default is 25.From 1 to 100.

Outputs

countnumber
How many are on this page
has_moretrue/false
True when the page was full, so there may be another
pagenumber
The page number
paymentslist
The payments
Example output
{
  "count": 1,
  "has_more": false,
  "page": 1,
  "payments": [
    {
      "amount_in_cents": 18150,
      "created_at": "2026-11-10T14:09:00.000000+00:00",
      "currency": "usd",
      "customer_id": "5e7fb1d5-a69a-4dad-8f6c-0a321ec6da2c",
      "deposit_in_cents": 10000,
      "description": "",
      "id": "829cbadd-91ff-44e3-850b-28fb5b5dd16f",
      "order_id": "3475c076-354c-4870-8326-459b23381f95",
      "provider": "stripe",
      "provider_method": "card",
      "status": "succeeded",
      "succeeded_at": "2026-11-10T14:10:00.000000+00:00",
      "total_in_cents": 28150,
      "type": "payment_charges"
    }
  ]
}

List product groups

List product groups (the items you rent or sell, with their pricing) by name. Gets one page; run it again with the next page number to see more.

Inputs

Searchsearchtext
Words to look for, as in Booqable's own search box.
Typeproduct_typetext
Only rentals, sales items or services.One of: rental, sales_item (Sales item), service.
Archivedarchivedtext
Whether to include archived ones. Defaults to not archived.One of: active (Not archived (default)), archived (Archived only), all (Both). Default: active.
Pagepagenumber
Which page to get, starting at 1.At least 1.
Page sizepage_sizenumber
How many to return, 1 to 100. Booqable's default is 25.From 1 to 100.

Outputs

countnumber
How many are on this page
has_moretrue/false
True when the page was full, so there may be another
pagenumber
The page number
product_groupslist
The product groups
Example output
{
  "count": 1,
  "has_more": false,
  "page": 1,
  "product_groups": [
    {
      "archived": false,
      "base_price_in_cents": 7500,
      "created_at": "2026-02-01T09:00:00.000000+00:00",
      "deposit_in_cents": 50000,
      "description": "Full-frame mirrorless camera.",
      "flat_fee_price_in_cents": 7500,
      "has_variations": false,
      "id": "66a43973-a27a-4282-8f4a-c125934b1469",
      "name": "Canon EOS R5",
      "price_period": "day",
      "price_type": "simple",
      "product_type": "rental",
      "show_in_store": true,
      "sku": "CAM-R5",
      "slug": "canon-eos-r5",
      "tag_list": [
        "cameras"
      ],
      "trackable": false,
      "tracking_type": "bulk",
      "updated_at": "2026-02-01T09:00:00.000000+00:00"
    }
  ]
}

List products

List the products you can book on orders (a product group's product, or each of its variations), optionally of one group.

Inputs

Product groupproduct_group_idtext
Only the products of this product group.
Searchsearchtext
Words to look for, as in Booqable's own search box.
Typeproduct_typetext
Only rentals, sales items or services.One of: rental, sales_item (Sales item), service.
Pagepagenumber
Which page to get, starting at 1.At least 1.
Page sizepage_sizenumber
How many to return, 1 to 100. Booqable's default is 25.From 1 to 100.

Outputs

countnumber
How many are on this page
has_moretrue/false
True when the page was full, so there may be another
pagenumber
The page number
productslist
The products
Example output
{
  "count": 1,
  "has_more": false,
  "page": 1,
  "products": [
    {
      "archived": false,
      "base_price_in_cents": 7500,
      "created_at": "2026-02-01T09:00:00.000000+00:00",
      "group_name": "Canon EOS R5",
      "id": "ed6e7fb4-7f13-4729-8dce-0f8b8c640d0b",
      "name": "Canon EOS R5",
      "price_period": "day",
      "price_type": "simple",
      "product_group_id": "66a43973-a27a-4282-8f4a-c125934b1469",
      "product_type": "rental",
      "sku": "CAM-R5",
      "tracking_type": "bulk",
      "variation_values": []
    }
  ]
}

Update customer

Change a customer's name, email, type, default discount or tags.

Inputs

Customercustomer_idtextRequired
The customer. Pick one, or give their id from an earlier step.
Namenametext
The person's or company's name. Leave empty to keep it.
Emailemailtext
Their email address. Leave empty to keep it.
Typelegal_typetext
A person or a company. Leave empty to keep it.One of: person, commercial (Company).
Default discount (%)discount_percentagenumber
A discount applied to each new order of theirs, 0 to 100.From 0 to 100.
Tagstagslist
Tags to set. They replace the tags already there.

Outputs

customerobject
The customer
Example output
{
  "customer": {
    "archived": false,
    "balance_due_in_cents": 0,
    "created_at": "2026-01-10T09:00:00.000000+00:00",
    "deposit_type": "default",
    "discount_percentage": 0.0,
    "email": "jo@example.com",
    "id": "5e7fb1d5-a69a-4dad-8f6c-0a321ec6da2c",
    "legal_type": "person",
    "name": "Jo Bloggs",
    "number": 12,
    "order_count": 3,
    "properties": {},
    "revenue_in_cents": 45000,
    "tag_list": [
      "vip"
    ],
    "updated_at": "2026-10-01T09:00:00.000000+00:00"
  }
}

Update order

Change an order's customer, rental period, pick-up and return locations or tags. A new customer brings their discount and deposit settings; new dates can cause a shortage.

Inputs

Order IDorder_idtextRequired
The order's id, from 'List orders', a trigger or an earlier step.
Customercustomer_idtext
Who the order is for. Pick one, or give their id. Leave empty to keep it.
Rental startsstarts_atdate and time
When the items go out and stop being available to others. Leave empty to keep it.
Rental endsstops_atdate and time
When the items are back and available again. Leave empty to keep it.
Pick-up locationstart_location_idtext
Where the items are collected. Leave empty for Booqable's first location.
Return locationstop_location_idtext
Where the items are returned. Leave empty for Booqable's first location.
Tagstagslist
Tags to set. They replace the tags already there.
Go ahead despite a shortageconfirm_shortagetrue/false
Turn on to go ahead when Booqable warns that there isn't enough stock, where the product allows a shortage.Default: false.

Outputs

orderobject
The order
Example output
{
  "order": {
    "created_at": "2026-11-10T14:00:00.000000+00:00",
    "customer_id": "5e7fb1d5-a69a-4dad-8f6c-0a321ec6da2c",
    "deposit_in_cents": 10000,
    "fulfillment_type": "pickup",
    "grand_total_in_cents": 15000,
    "grand_total_with_tax_in_cents": 18150,
    "id": "3475c076-354c-4870-8326-459b23381f95",
    "item_count": 1,
    "location_shortage": false,
    "number": 1042,
    "paid_in_cents": 0,
    "payment_status": "payment_due",
    "price_in_cents": 15000,
    "properties": {},
    "start_location_id": "595f65d5-8218-4704-83ae-39aff6d1aeb4",
    "starts_at": "2026-12-01T09:00:00.000000+00:00",
    "status": "reserved",
    "status_counts": {
      "draft": 0,
      "new": 0,
      "reserved": 1,
      "started": 0
    },
    "statuses": [
      "reserved"
    ],
    "stop_location_id": "595f65d5-8218-4704-83ae-39aff6d1aeb4",
    "stops_at": "2026-12-03T17:00:00.000000+00:00",
    "tag_list": [
      "webshop"
    ],
    "tax_in_cents": 3150,
    "to_be_paid_in_cents": 28150,
    "total_in_cents": 28150,
    "updated_at": "2026-11-10T14:05:00.000000+00:00"
  }
}

Update product group

Change a product group's name, SKU, pricing, price, deposit, description, store visibility or tags.

Inputs

Product groupproduct_group_idtextRequired
The product group. Pick one, or give its id from an earlier step.
Namenametext
The product's name, as customers see it. Leave empty to keep it.
SKUskutext
Your stock keeping unit code. Leave empty to keep it.
Pricingprice_typetext
How it is priced. Leave empty to keep it.One of: simple (A price per period), fixed (A fixed price), none (Free).
Price periodprice_periodtext
What the price is per, for a price per period. Leave empty to keep it.One of: hour (Per hour), day (Per day), week (Per week), month (Per month), minute (Per minute).
Pricepricenumber
The price in your Booqable currency, such as 25.00. Leave empty to keep it.At least 0.
Depositdepositnumber
The deposit asked per item, such as 100.00. Leave empty to keep it.At least 0.
Descriptiondescriptiontext
The description shown in your online store. Leave empty to keep it.
Show in online storeshow_in_storetrue/false
Whether it appears in your Booqable online store.
Tagstagslist
Tags to set. They replace the tags already there.

Outputs

product_groupobject
The product group
Example output
{
  "product_group": {
    "archived": false,
    "base_price_in_cents": 7500,
    "created_at": "2026-02-01T09:00:00.000000+00:00",
    "deposit_in_cents": 50000,
    "description": "Full-frame mirrorless camera.",
    "flat_fee_price_in_cents": 7500,
    "has_variations": false,
    "id": "66a43973-a27a-4282-8f4a-c125934b1469",
    "name": "Canon EOS R5",
    "price_period": "day",
    "price_type": "simple",
    "product_type": "rental",
    "show_in_store": true,
    "sku": "CAM-R5",
    "slug": "canon-eos-r5",
    "tag_list": [
      "cameras"
    ],
    "trackable": false,
    "tracking_type": "bulk",
    "updated_at": "2026-02-01T09:00:00.000000+00:00"
  }
}

On this page