API - Corsair

Every booqable.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Barcodes

listBarcodes

barcodes.listBarcodes Retrieve a list of barcodes. Risk: read

await corsair.booqable.api.barcodes.listBarcodes({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: barcodes,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Bundle Items

listBundleItems

bundleItems.listBundleItems Retrieve a list of bundle items. Risk: read

await corsair.booqable.api.bundleItems.listBundleItems({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: bundle_items,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Bundles

searchBundles

bundles.searchBundles Search bundles with advanced filtering. Risk: read

await corsair.booqable.api.bundles.searchBundles({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: bundles,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Clusters

listClusters

clusters.listClusters Retrieve a list of clusters. Risk: read

await corsair.booqable.api.clusters.listClusters({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: clusters,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Companies

updateCompany

companies.updateCompany Update the current company information. Risk: write

await corsair.booqable.api.companies.updateCompany({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: companies,
  attributes?: {
  },
  relationships?: {
  }
}

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Coupons

listCoupons

coupons.listCoupons Retrieve a list of coupons. Risk: read

await corsair.booqable.api.coupons.listCoupons({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: coupons,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Customers

createCustomer

customers.createCustomer Create a new customer in Booqable. Risk: write

await corsair.booqable.api.customers.createCustomer({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: customers,
  attributes?: {
  },
  relationships?: {
  }
}

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

deleteCustomer

customers.deleteCustomer Delete (archive) a customer by ID. Risk: destructive · Irreversible

await corsair.booqable.api.customers.deleteCustomer({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output: object

Output full type

{
  data: {
    id: string,
    type: customers,
    attributes?: {
    },
    relationships?: {
    }
  },
  included?: {
    id: string,
    type: string,
    attributes?: {
    },
    relationships?: {
    }
  }[],
  links?: {
  },
  meta?: {
  }
} | {
  data: null,
  links?: {
  },
  meta?: {
  }
}

getCustomer

customers.getCustomer Fetch a specific customer by ID. Risk: read

await corsair.booqable.api.customers.getCustomer({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: customers,
  attributes?: {
  },
  relationships?: {
  }
}

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

getCustomers

customers.getCustomers Retrieve a paginated list of customers. Risk: read

await corsair.booqable.api.customers.getCustomers({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: customers,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

searchCustomers

customers.searchCustomers Search customers with advanced filtering. Risk: read

await corsair.booqable.api.customers.searchCustomers({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: customers,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Default Properties

listDefaultProperties

defaultProperties.listDefaultProperties Retrieve default property definitions. Risk: read

await corsair.booqable.api.defaultProperties.listDefaultProperties({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: default_properties,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Documents

listDocuments

documents.listDocuments Retrieve a list of documents. Risk: read

await corsair.booqable.api.documents.listDocuments({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: documents,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

searchDocuments

documents.searchDocuments Search documents with advanced filtering. Risk: read

await corsair.booqable.api.documents.searchDocuments({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: documents,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Email Templates

listEmailTemplates

emailTemplates.listEmailTemplates List email templates. Risk: read

await corsair.booqable.api.emailTemplates.listEmailTemplates({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: email_templates,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Employees

listEmployees

employees.listEmployees Retrieve a list of employees. Risk: read

await corsair.booqable.api.employees.listEmployees({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: employees,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Inventory Breakdowns

listInventoryBreakdowns

inventoryBreakdowns.listInventoryBreakdowns Retrieve inventory breakdowns by status and product. Risk: read

await corsair.booqable.api.inventoryBreakdowns.listInventoryBreakdowns({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: inventory_breakdowns,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Inventory Levels

getInventoryLevels

inventoryLevels.getInventoryLevels Fetch inventory levels for products across locations. Risk: read

await corsair.booqable.api.inventoryLevels.getInventoryLevels({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: inventory_levels,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Items

listItems

items.listItems Retrieve a list of items (products and product groups). Risk: read

await corsair.booqable.api.items.listItems({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: items,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

searchItems

items.searchItems Search items with advanced filtering. Risk: read

await corsair.booqable.api.items.searchItems({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: items,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Lines

listLines

lines.listLines Retrieve a paginated list of order lines. Risk: read

await corsair.booqable.api.lines.listLines({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: lines,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Locations

listLocations

locations.listLocations Retrieve a list of locations. Risk: read

await corsair.booqable.api.locations.listLocations({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: locations,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Notes

listNotes

notes.listNotes Retrieve a list of notes. Risk: read

await corsair.booqable.api.notes.listNotes({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: notes,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Orders

createOrder

orders.createOrder Create a new order. Risk: write

await corsair.booqable.api.orders.createOrder({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: orders,
  attributes?: {
  },
  relationships?: {
  }
}

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

deleteOrder

orders.deleteOrder Delete (archive) an order by ID. Risk: destructive · Irreversible

await corsair.booqable.api.orders.deleteOrder({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output: object

Output full type

{
  data: {
    id: string,
    type: orders,
    attributes?: {
    },
    relationships?: {
    }
  },
  included?: {
    id: string,
    type: string,
    attributes?: {
    },
    relationships?: {
    }
  }[],
  links?: {
  },
  meta?: {
  }
} | {
  data: null,
  links?: {
  },
  meta?: {
  }
}

getNewOrder

orders.getNewOrder Retrieve a new order template with default values. Risk: read

await corsair.booqable.api.orders.getNewOrder({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: orders,
  attributes?: {
  },
  relationships?: {
  }
}

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

getOrder

orders.getOrder Retrieve a specific order by ID. Risk: read

await corsair.booqable.api.orders.getOrder({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: orders,
  attributes?: {
  },
  relationships?: {
  }
}

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

listOrders

orders.listOrders Retrieve a paginated list of orders. Risk: read

await corsair.booqable.api.orders.listOrders({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: orders,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

searchOrders

orders.searchOrders Search orders with advanced filtering. Risk: read

await corsair.booqable.api.orders.searchOrders({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: orders,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Payment Methods

listPaymentMethods

paymentMethods.listPaymentMethods Retrieve a list of payment methods. Risk: read

await corsair.booqable.api.paymentMethods.listPaymentMethods({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: payment_methods,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Payments

listPayments

payments.listPayments List all payments. Risk: read

await corsair.booqable.api.payments.listPayments({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: payments,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Photos

listPhotos

photos.listPhotos Retrieve a paginated list of photos. Risk: read

await corsair.booqable.api.photos.listPhotos({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: photos,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Plannings

listPlannings

plannings.listPlannings Retrieve planning records for reservations. Risk: read

await corsair.booqable.api.plannings.listPlannings({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: plannings,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

searchPlannings

plannings.searchPlannings Search plannings with advanced filtering. Risk: read

await corsair.booqable.api.plannings.searchPlannings({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: plannings,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Price Rulesets

listPriceRulesets

priceRulesets.listPriceRulesets List price rulesets. Risk: read

await corsair.booqable.api.priceRulesets.listPriceRulesets({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: price_rulesets,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Price Structures

listPriceStructures

priceStructures.listPriceStructures List price structures. Risk: read

await corsair.booqable.api.priceStructures.listPriceStructures({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: price_structures,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Product Groups

createProductGroup

productGroups.createProductGroup Create a new product group. Risk: write

await corsair.booqable.api.productGroups.createProductGroup({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: product_groups,
  attributes?: {
  },
  relationships?: {
  }
}

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

deleteProductGroup

productGroups.deleteProductGroup Delete a product group by ID. Risk: destructive · Irreversible

await corsair.booqable.api.productGroups.deleteProductGroup({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output: object

Output full type

{
  data: {
    id: string,
    type: product_groups,
    attributes?: {
    },
    relationships?: {
    }
  },
  included?: {
    id: string,
    type: string,
    attributes?: {
    },
    relationships?: {
    }
  }[],
  links?: {
  },
  meta?: {
  }
} | {
  data: null,
  links?: {
  },
  meta?: {
  }
}

getProductGroup

productGroups.getProductGroup Fetch a specific product group by ID. Risk: read

await corsair.booqable.api.productGroups.getProductGroup({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: product_groups,
  attributes?: {
  },
  relationships?: {
  }
}

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

listProductGroups

productGroups.listProductGroups List product groups with filtering and pagination. Risk: read

await corsair.booqable.api.productGroups.listProductGroups({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: product_groups,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Products

getProduct

products.getProduct Fetch a specific product by ID. Risk: read

await corsair.booqable.api.products.getProduct({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: products,
  attributes?: {
  },
  relationships?: {
  }
}

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

listProducts

products.listProducts Retrieve a paginated list of products. Risk: read

await corsair.booqable.api.products.listProducts({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: products,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Properties

listProperties

properties.listProperties Retrieve a list of custom properties. Risk: read

await corsair.booqable.api.properties.listProperties({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: properties,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Provinces

listProvinces

provinces.listProvinces Retrieve a list of provinces. Risk: read

await corsair.booqable.api.provinces.listProvinces({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: provinces,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Stock Item Plannings

listStockItemPlannings

stockItemPlannings.listStockItemPlannings Retrieve stock item plannings. Risk: read

await corsair.booqable.api.stockItemPlannings.listStockItemPlannings({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: stock_item_plannings,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Stock Items

listStockItems

stockItems.listStockItems Retrieve a list of stock items. Risk: read

await corsair.booqable.api.stockItems.listStockItems({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: stock_items,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Tax Rates

listTaxRates

taxRates.listTaxRates Retrieve a list of tax rates. Risk: read

await corsair.booqable.api.taxRates.listTaxRates({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: tax_rates,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Tax Values

listTaxValues

taxValues.listTaxValues Retrieve a list of tax values. Risk: read

await corsair.booqable.api.taxValues.listTaxValues({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: tax_values,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

Users

listUsers

users.listUsers Retrieve a list of users. Risk: read

await corsair.booqable.api.users.listUsers({});

Input

Name	Type	Required	Description
`companySlug`	`string`	No	—
`body`	`any`	No	—
`query`	`object`	No	—
`headers`	`object`	No	—

query full type

{
}

headers full type

{
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`included`	`object[]`	No	—
`links`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  id: string,
  type: users,
  attributes?: {
  },
  relationships?: {
  }
}[]

included full type

{
  id: string,
  type: string,
  attributes?: {
  },
  relationships?: {
  }
}[]

links full type

{
}

meta full type

{
}

​Barcodes

​listBarcodes

​Bundle Items

​listBundleItems

​Bundles

​searchBundles

​Clusters

​listClusters

​Companies

​updateCompany

​Coupons

​listCoupons

​Customers

​createCustomer

​deleteCustomer

​getCustomer

​getCustomers

​searchCustomers

​Default Properties

​listDefaultProperties

​Documents

​listDocuments

​searchDocuments

​Email Templates

​listEmailTemplates

​Employees

​listEmployees

​Inventory Breakdowns

​listInventoryBreakdowns

​Inventory Levels

​getInventoryLevels

​Items

​listItems

​searchItems

​Lines

​listLines

​Locations

​listLocations

​Notes

​listNotes

​Orders

​createOrder

​deleteOrder

​getNewOrder

​getOrder

​listOrders

​searchOrders

​Payment Methods

​listPaymentMethods

​Payments

​listPayments

​Photos

​listPhotos

​Plannings

​listPlannings

​searchPlannings

​Price Rulesets

​listPriceRulesets

​Price Structures

​listPriceStructures

​Product Groups

​createProductGroup

​deleteProductGroup

​getProductGroup

​listProductGroups

​Products

​getProduct

​listProducts

​Properties

​listProperties

​Provinces

​listProvinces

​Stock Item Plannings

​listStockItemPlannings

​Stock Items

​listStockItems

​Tax Rates

​listTaxRates

​Tax Values

​listTaxValues

Barcodes

listBarcodes

Bundle Items

listBundleItems

Bundles

searchBundles

Clusters

listClusters

Companies

updateCompany

Coupons

listCoupons

Customers

createCustomer

deleteCustomer

getCustomer

getCustomers

searchCustomers

Default Properties

listDefaultProperties

Documents

listDocuments

searchDocuments

Email Templates

listEmailTemplates

Employees

listEmployees

Inventory Breakdowns

listInventoryBreakdowns

Inventory Levels

getInventoryLevels

Items

listItems

searchItems

Lines

listLines

Locations

listLocations

Notes

listNotes

Orders

createOrder

deleteOrder

getNewOrder

getOrder

listOrders

searchOrders

Payment Methods

listPaymentMethods

Payments

listPayments

Photos

listPhotos

Plannings

listPlannings

searchPlannings

Price Rulesets

listPriceRulesets

Price Structures

listPriceStructures

Product Groups

createProductGroup

deleteProductGroup

getProductGroup

listProductGroups

Products

getProduct

listProducts

Properties

listProperties

Provinces

listProvinces

Stock Item Plannings

listStockItemPlannings

Stock Items

listStockItems

Tax Rates

listTaxRates

Tax Values

listTaxValues