For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Developer
Developer
Search docs
/
Dev Portal
Docs
API Reference
Learn
Community
Changelog
GraphQL
Admin
Types
Objects
AggregatedProductInventory
OBJECT
Copy page
Aggregated product inventory.
Fields
availableToSell
Long
Optional
The number of items available to sell.
onHand
Long
Optional
The number of items on hand.
safetyStock
Long
Optional
The number of items that are considered safety stock.
warningLevel
Long
Optional
The number of items that are considered a warning level.
backorderLimit
Long
Optional
The number of items that can be backordered.
qtyBackordered
Long
Optional
The number of items that are backordered.
Referenced by
Fields
ProductInventory.aggregated
