Inventory products
Get inventory products
GET /api/internal/v1/partners/:partner_id/inventory-products
Path Parameters
partner_id
integer
The ID of the partner.
Query Parameters
page
integer
The page number.
per_page
integer
How many items to returns per page.
Create a new inventory product
POST /api/internal/v1/partners/:partner_id/inventory-products
Path Parameters
partner_id
integer
The ID of the partner.
Request Body
facility_ids
integer
The IDs of the facilities in which the inventory product will be available.
name
string
The name of the product.
short_name
string
The short name of the product.
description
string
The description of the product.
max_available_units
string
The number of max available units for the product.
accounting_code
string
The accounting code of the product.
bookable_online
boolean
Indicate if the product will be bookable online or not.
min_booking_mins
number
Indicate the minimum amount of time a product must be booked.
max_booking_mins
number
Indicate the maximum amount of time a product can be booked.
lead_mins
number
Indicate for how many minutes before a booking the product will not be available.
follow_up_mins
number
Indicate for how many minutes after the booking ended the inventory product will not be available for another booking.
vat_id
integer
The ID of the VAT that should be applied to the price.
amount
number
The price of the inventory product.
form
string
The price form. Allowed values: net and gross.
billing_type
string
Indicate if the product should have a fixed price or it should be billed per hour. Allowed values: fixed and hourly
Get a specific inventory product
GET /api/internal/v1/partners/:partner_id/inventory-products/:inventory_product_id
Path Parameters
partner_id
integer
The ID of the partner.
inventory_product_id
integer
The ID of the inventory product.
Update inventory product
PUT /api/internal/v1/partners/:partner_id/inventory-products/:inventory_product_id
Path Parameters
partner_id
integer
The ID of the partner.
inventory_product_id
integer
The ID of the inventory product.
Request Body
facility_ids
array
The ids of the facilities in which the inventory product will be available.
name
string
short_name
string
description
string
max_available_units
number
accounting_code
string
bookable_online
boolean
max_booking_mins
number
min_booking_mins
number
lead_mins
number
follow_up_mins
number
form
string
The price form. Allowed values: gross and net.
billing_type
string
Indicates if the product should have a fixed price or if it should be billed per hour. Allowed values: fixed or hourly.
amount
integer
The price of the inventory product.
vat_id
integer
The ID of the VAT that should be applied for the product price.
Delete inventory product
DELETE /api/internal/v1/partners/:partner_id/inventory-products/:inventory_product_id
Path Parameters
partner_id
integer
The ID of the partner.
inventory_product_id
integer
The ID of the inventory product.
Last updated
Was this helpful?