Inventory Items

The InventoryItem Object

The InventoryItem object represents a stock-managed promotional item that can be associated with prizes. It tracks available/on-hand quantities (including current values), commercial metadata (SKU, value per unit), active date range, and campaign/category context. It’s the object to use when you need a reliable view of promo stock availability and movement context.

ValueTypeDescription
uuidstringInventory item UUID.
descriptionstringDescription.
qty_availableintegerAvailable quantity.
qty_on_handintegerOn-hand quantity.
current_qty_availableintegerCurrent available quantity.
current_qty_on_handintegerCurrent on-hand quantity.
vpunumberValue-per-unit.
skustringSKU.
ad_hoc_enabledbooleanAd-hoc enabled flag.
start_datestringStart date/time.
end_datestringEnd date/time.
listener_notesstringListener notes.
campaignobjectSerialized Campaign object via CampaignBlueprint when present.
station_uuidstringStation UUID when station_id is present.
categoryobjectInline object with uuid, name when category exists.
archived_atstringArchive timestamp.
created_atstringRecord creation timestamp.
updated_atstringRecord update timestamp.