Skip to main content

A store product's current on-hand quantity.

id
string
required

Store product ID

Pattern: ^[0-9]+$
barcode
string
required

Barcode scanned at the register for this product.

current
string | null
required

Quantity currently on hand. Goes negative when sales outrun the last count. Null when the product has never been counted.

Pattern: ^-?[0-9]+(\.[0-9]+)?$
Example:

"199.99"

store_department_id
string
required

The department the product belongs to.

Pattern: ^[0-9]+$
store_id
string
required

The store the product belongs to.

Pattern: ^[0-9]+$
updated_at
string<date-time> | null
required

When the on-hand quantity was last written, regardless of the date the change applies to. A count entered today but dated last week carries today. Null when the product has never been counted.