inventory-count
v0.0.6
Published
Scoped inventory count and audit sessions for Medusa v2 with strict out-of-scope scan validation.
Downloads
857
Maintainers
Readme
Inventory Count
Scoped inventory count / stock-take sessions for Medusa v2 with strict out-of-scope scan validation (Option 3).
Features
- Create an audit session locked to
all,category,collection, ormanualvariant/product IDs at a stock location - Snapshot
expected_quantityfrom inventory levels at create time - Scan barcodes; out-of-scope items return
400withITEM_OUT_OF_SCOPEand do not mutate counts - Remove a mistaken extra scan with
quantity: -1(oritem_id) — counted quantity never goes below 0 - Complete → discrepancy report (
matched/missing/over) - While in
review, recount and refresh the report - Fix remaining quantities (
apply) writesstocked_quantity = counted_quantityfor discrepancies only, or Close report without stock changes
Install
npm install [email protected]Register in medusa-config.ts:
plugins: [
{
resolve: "inventory-count",
options: {},
},
],
modules: {
inventory_count: {
resolve: "inventory-count/modules/inventory-count",
},
},Then migrate:
npx medusa db:migrateAdmin APIs
| Method | Path | Purpose |
|---|---|---|
| POST | /admin/inventory-counts | Create session |
| GET | /admin/inventory-counts | List sessions |
| GET | /admin/inventory-counts/:id | Session + items (counted_only=true for scanned lines) |
| POST | /admin/inventory-counts/:id/scan | Scan barcode (quantity: -1 removes one) |
| POST | /admin/inventory-counts/:id/complete | Build report → review |
| POST | /admin/inventory-counts/:id/apply | Apply remaining discrepancies |
| POST | /admin/inventory-counts/:id/close | Close without stock writes |
| POST | /admin/inventory-counts/:id/cancel | Cancel open session |
Create body
{
"scope_type": "category",
"scope_ids": ["pcat_123"],
"location_id": "sloc_456"
}Scan body
{
"barcode": "123456789012",
"quantity": 1
}Remove one counted unit (mistaken extra beep):
{
"item_id": "icitem_123",
"quantity": -1
}Admin UI
Sidebar route: Inventory Counts.
Development
npm install
npm test
npm run build