Consumables

Manage consumable items via the API

The Consumables API allows you to manage consumable items like toner cartridges, paper, and other supplies.

List Consumables

cURL

curl -X GET "https://your-domain.com/api/v1/consumables" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

limit · integer · default: "50"

Number of results to return

offset · integer · default: "0"

Offset for pagination

search · string

Search string to filter results

sort · string · default: "created_at"

Column to sort by. Allowed values: id, name, category, location, company, manufacturer, supplier, qty, min_amt, model_number, item_no, order_number, purchase_date, purchase_cost

order · string · default: "desc"

Sort order: asc or desc

category_id · integer

Filter by category ID

company_id · integer

Filter by company ID

manufacturer_id · integer

Filter by manufacturer ID

supplier_id · integer

Filter by supplier ID

location_id · integer

Filter by location ID

total · integer

Total number of consumables

rows · array

Array of consumable objects

Show Consumable Object

id · integer

Consumable ID

name · string

Consumable name

model_number · string

Model number

item_no · string

Item number

qty · integer

Total quantity

remaining · integer

Remaining quantity available

min_amt · integer

Minimum quantity threshold

category · object

Category information

company · object

Company information

manufacturer · object

Manufacturer information

supplier · object

Supplier information

location · object

Location information

order_number · string

Order number

purchase_date · string

Purchase date

purchase_cost · string

Purchase cost

notes · string

Consumable notes

Get Consumable by ID

cURL

curl -X GET "https://your-domain.com/api/v1/consumables/{consumable_id}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

consumable_id · integer · required

The consumable ID

Create Consumable

cURL

curl -X POST "https://your-domain.com/api/v1/consumables" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Printer Toner HP 12A",
    "qty": 20,
    "category_id": 3,
    "company_id": 1
  }'

name · string · required

Consumable name

qty · integer · required

Total quantity

category_id · integer · required

Category ID

company_id · integer

Company ID

manufacturer_id · integer

Manufacturer ID

supplier_id · integer

Supplier ID

location_id · integer

Location ID

model_number · string

Model number

item_no · string

Item/SKU number

order_number · string

Order number

purchase_date · string

Purchase date (YYYY-MM-DD)

purchase_cost · number

Purchase cost

min_amt · integer

Minimum quantity threshold for alerts

notes · string

Consumable notes

Update Consumable

cURL

curl -X PATCH "https://your-domain.com/api/v1/consumables/{consumable_id}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Consumable Name",
    "qty": 30
  }'

consumable_id · integer · required

The consumable ID

Delete Consumable

cURL

curl -X DELETE "https://your-domain.com/api/v1/consumables/{consumable_id}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

consumable_id · integer · required

The consumable ID

Checkout Consumable

cURL

curl -X POST "https://your-domain.com/api/v1/consumables/{consumable_id}/checkout" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "assigned_to": 123,
    "note": "Issued to employee"
  }'

consumable_id · integer · required

The consumable ID

assigned_to · integer · required

User ID to checkout to

note · string

Checkout note

Consumables do not have a checkin process since they are consumed when checked out. The quantity automatically decrements.

Get Users Who Have Consumable

cURL

curl -X GET "https://your-domain.com/api/v1/consumables/{consumable_id}/users" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

consumable_id · integer · required

The consumable ID

limit · integer · default: "50"

Number of results to return

offset · integer · default: "0"

Offset for pagination

Returns a list of users who have been assigned this consumable.