Store Product Inventory Items
When a store product uses item-level inventory tracking (inventory_tracking: "item"), each unit of stock is represented as an individual inventory item. This enables assigning identifiers and barcodes to individual items.
note
These endpoints only work for products with track_inventory: true and inventory_tracking: "item". For products using group tracking, use the Adjust Inventory endpoint instead.
Item-Level vs Group-Level Tracking
| Feature | Group Tracking | Item Tracking |
|---|---|---|
| Stock representation | Single quantity number | Individual item records |
| Identifiers | Not applicable | Each item can have a unique identifier |
| Barcodes | Product-level only | Per-item barcodes |
| Stock adjustment | Increment/decrement quantity | Add/remove individual items |
Inventory Item Properties
- Identifier -- A label for the item (e.g., serial number, asset tag). When adding multiple items with an identifier, they are auto-numbered (e.g., "WIDGET-1", "WIDGET-2").
- Unique identifier -- System-generated unique ID.
- Variation -- Optionally link the item to a specific product variation.
- Barcode -- Items can have barcodes attached (managed via the portal).
Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/store-products/{id}/inventory-items | List inventory items |
| GET | /v1/store-products/{id}/inventory-items/{itemId} | Get an inventory item |
| POST | /v1/store-products/{id}/inventory-items | Add inventory items |
| PUT | /v1/store-products/{id}/inventory-items/{itemId} | Update an inventory item |
| DELETE | /v1/store-products/{id}/inventory-items/{itemId} | Delete an inventory item |