Skip to main content
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
Example:
organization-id
string
required

Path Parameters

id
number
required

Response

id
number
required
Example:
name
string
required
Example:
type
enum<string>
required
Available options:
service,
non-inventory,
inventory
Example:
typeFormatted
string
required
Example:
sellable
boolean
required
Example:
purchasable
boolean
required
Example:
currencyCode
string
required
Example:
active
boolean
required
Example:
createdAt
string<date-time>
required
Example:
updatedAt
string<date-time>
required
Example:
code
string
Example:
sellPrice
number
Example:
sellPriceFormatted
string
Example:
costPrice
number
Example:
costPriceFormatted
string
Example:
costAccountId
number
Example:
costAccount
object
inventoryAccountId
number
Example:
inventoryAccount
object
sellAccountId
number
Example:
sellAccount
object
categoryId
number
Example:
category
object
sellDescription
string
Example:
purchaseDescription
string
Example:
quantityOnHand
number
Example:
note
string
Example:
sellTaxRateId
number
Example:
sellTaxRate
object
purchaseTaxRateId
number
Example:
purchaseTaxRate
object
itemWarehouses
any[]