Skip to main content
The Inventory resource allows you to manage furniture inventory records, including tracking stock levels, monitoring low stock items, and updating quantities.

​
The Inventory Object

​
id
integer
Unique identifier for the inventory record
​
productId
integer
ID of the associated product
​
quantityAvailable
integer
Current quantity of the product available in stock
​
minimumStockLevel
integer
Minimum stock level threshold for low stock alerts
​
lastRestockedDate
string
Timestamp of when the inventory was last restocked (ISO 8601 format)

​
Available Endpoints

​
CRUD Operations

​
Stock Operations

The list endpoint supports multiple filters:
  • GET /api/v1/inventory/product/{productId} - Get inventory by product
  • GET /api/v1/inventory/low-stock - Get low stock items
  • GET /api/v1/inventory/out-of-stock - Get out of stock items
  • GET /api/v1/inventory/available - Get available stock
  • GET /api/v1/inventory/pagination - List with pagination

​
Common Use Cases

​
Stock Monitoring

Track inventory levels and identify low stock or out-of-stock items using specialized endpoints.

​
Inventory Management

Create and update inventory records to maintain accurate stock levels across your furniture catalog.

​
Stock Updates

Decrease stock quantities when processing orders to maintain real-time inventory accuracy.

Build docs developers (and LLMs) love

Get started for freeTalk to us