GET
/
api
/
items
/
{id}
{
  "id": 1,
  "name": "Ergonomic Office Chair Model X-2000",
  "type": "inventory",
  "typeFormatted": "Inventory Item",
  "code": "CHAIR-X2000",
  "sellable": true,
  "purchasable": true,
  "sellPrice": 399.99,
  "sellPriceFormatted": "$399.99",
  "costPrice": 299.99,
  "costPriceFormatted": "$299.99",
  "currencyCode": "USD",
  "costAccountId": 1001,
  "costAccount": {},
  "inventoryAccountId": 3001,
  "inventoryAccount": {},
  "sellAccountId": 2001,
  "sellAccount": {},
  "categoryId": 5,
  "category": {},
  "sellDescription": "Premium ergonomic office chair with adjustable height and lumbar support",
  "purchaseDescription": "Ergonomic office chair - Model X-2000 with standard features",
  "quantityOnHand": 50,
  "note": "Available in black, gray, and navy colors. 5-year warranty included.",
  "active": true,
  "sellTaxRateId": 1,
  "sellTaxRate": {},
  "purchaseTaxRateId": 1,
  "purchaseTaxRate": {},
  "itemWarehouses": [
    "<any>"
  ],
  "createdAt": "2024-03-20T10:00:00Z",
  "updatedAt": "2024-03-20T10:00:00Z"
}

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

Response

The item details have been successfully retrieved.

​
id
number
required

The unique identifier of the item

Example:

1

​
name
string
required

The name of the item

Example:

"Ergonomic Office Chair Model X-2000"

​
type
enum<string>
required

The type of the item

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

"inventory"

​
typeFormatted
string
required

The formatted type of the item

Example:

"Inventory Item"

​
sellable
boolean
required

Whether the item can be sold

Example:

true

​
purchasable
boolean
required

Whether the item can be purchased

Example:

true

​
currencyCode
string
required

The currency code of the item

Example:

"USD"

​
active
boolean
required

Whether the item is active

Example:

true

​
createdAt
string<date-time>
required

The date when the item was created

Example:

"2024-03-20T10:00:00Z"

​
updatedAt
string<date-time>
required

The date when the item was last updated

Example:

"2024-03-20T10:00:00Z"

​
code
string

The item code/SKU

Example:

"CHAIR-X2000"

​
sellPrice
number

The selling price of the item

Example:

399.99

​
sellPriceFormatted
string

The formatted selling price of the item

Example:

"$399.99"

​
costPrice
number

The cost price of the item

Example:

299.99

​
costPriceFormatted
string

The formatted cost price of the item

Example:

"$299.99"

​
costAccountId
number

The ID of the cost account

Example:

1001

​
costAccount
object

The cost account details

​
inventoryAccountId
number

The ID of the inventory account

Example:

3001

​
inventoryAccount
object

The inventory account details

​
sellAccountId
number

The ID of the sell account

Example:

2001

​
sellAccount
object

The sell account details

​
categoryId
number

The ID of the item category

Example:

5

​
category
object

The category details

​
sellDescription
string

The description shown on sales documents

Example:

"Premium ergonomic office chair with adjustable height and lumbar support"

​
purchaseDescription
string

The description shown on purchase documents

Example:

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

​
quantityOnHand
number

The quantity of the item in stock (for inventory items)

Example:

50

​
note
string

Additional notes about the item

Example:

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

​
sellTaxRateId
number

The ID of the tax rate applied to sales

Example:

1

​
sellTaxRate
object

The tax rate details for sales

​
purchaseTaxRateId
number

The ID of the tax rate applied to purchases

Example:

1

​
purchaseTaxRate
object

The tax rate details for purchases

​
itemWarehouses
any[]

The warehouse quantities for the item