PUT
/
api
/
items
/
{id}

Headers

​
Authorization
string
required

Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Path Parameters

​
id
number
required

The item id

Body

application/json
​
name
string
required

Item name

Example:

"Ergonomic Office Chair Model X-2000"

​
type
enum<string>
required

Item type

Available options:
service,
non-inventory,
inventory
Example:

"inventory"

​
code
string

Item code/SKU

Example:

"CHAIR-X2000"

​
purchasable
boolean

Whether the item can be purchased

Example:

true

​
costPrice
number

Cost price of the item

Required range: x >= 0
Example:

299.99

​
costAccountId
number

ID of the cost account

Required range: x >= 0
Example:

1001

​
sellable
boolean

Whether the item can be sold

Example:

true

​
sellPrice
number

Selling price of the item

Required range: x >= 0
Example:

399.99

​
sellAccountId
number

ID of the sell account

Required range: x >= 0
Example:

2001

​
inventoryAccountId
number

ID of the inventory account (required for inventory items)

Required range: x >= 0
Example:

3001

​
sellDescription
string

Description shown on sales documents

Example:

"Premium ergonomic office chair with adjustable height, lumbar support, and breathable mesh back"

​
purchaseDescription
string

Description shown on purchase documents

Example:

"Ergonomic office chair - Model X-2000 with standard features"

​
sellTaxRateId
number

ID of the tax rate applied to sales

Example:

1

​
purchaseTaxRateId
number

ID of the tax rate applied to purchases

Example:

1

​
categoryId
number

ID of the item category

Required range: x >= 0
Example:

5

​
note
string

Additional notes about the item

Example:

"Available in black, gray, and navy colors. 5-year warranty included."

​
active
boolean
default:true

Whether the item is active

Example:

true

​
mediaIds
number[]

IDs of media files associated with the item

Example:
[1, 2, 3]

Response

The item has been successfully updated.