Itemra Docs
Itemra documentation
The manual for setting up, operating, migrating, and integrating Itemra.
Start here
- Getting startedFrom signing in to your first item, stock record, movement, and count — a complete first-hour walkthrough.
- Console tourThe shell, navigation styles, command palette, search, the Help menu, appearance controls, shortcuts, and the feedback widget.
- Onboarding & demo dataThe getting-started checklist, the showcase demo dataset, and how to remove sample data cleanly.
- Mobile & floor modeThe touch-first floor launcher, guided mobile flows, the scanner, offline behavior, and installing Itemra as an app.
Inventory
- ItemsThe item catalog: list, filters, creating and editing items, and the item detail page tab by tab.
- Advanced item managementVariants, relationships and alternates, templates, duplicate detection and merging, bulk editing, and data enrichment.
- Sites & locationsModel the physical world: sites, the location tree, bulk generation, occupancy, archiving, and site scoping.
- ContainersMovable holders — totes, cases, pallets: creating them, nesting, moving them whole, and reading their history.
- VehiclesVans and service vehicles as mobile stock locations: creating, assigning drivers, and running van stock.
- Stock operationsStock records, availability, and the drawer operations: adjust, quarantine and release, cost correction, issue, consume, and return.
- The movement ledgerEvery stock change as an auditable movement: reading the ledger, movement detail, reversing, correcting, and bulk entry.
Daily operations
- ReceivingThe receiving worklist, receiving against purchase orders, ad-hoc receipts, the mobile flow, and put-away.
- Moving stockQuick moves from the stock tab, the guided mobile move, and how to verify a move in the ledger.
- Site transfersTwo-legged moves between sites: sending, stock in transit, receiving with variances, and cancelling.
- CountingCount tasks, blind counts and thresholds, executing on desktop and mobile, variance review, and cycle-count schedules.
- Picking & reservationsReserve stock for demand, build pick lists, execute guided picks with shorts and substitutions, and issue or consume the result.
- ScanningThe global scanner, camera and hardware scanners, what a scan resolves to, and the supported barcode formats.
- Labels & printingLabel templates and the editor, printing item, location, and container labels, batch printing, and printer output profiles.
Purchasing
- SuppliersThe supplier register: detail tabs, item links with prices and lead times, offers, performance, and archiving.
- Purchase ordersCreate, send, and receive purchase orders: lines and currency, partial deliveries, reminders, budget approvals, and closing.
- Reorder & replenishmentSite reorder rules, reorder suggestions, auto-replenishment with guardrails, and location replenishment tasks.
Projects & BOMs
- ProjectsProjects as the demand anchor: lifecycle, linking BOM revisions, reserving material, and following consumption.
- BOMsBills of materials: drafting lines, approval into immutable revisions, comparing revisions, coverage, and building kits.
- Importing BOMsBring bills of materials in from EDA tools and spreadsheets: presets, auto-detection, mapping, and validation.
Tools & assets
Reports & insights
- Reports overviewThe reports hub, shared report controls, exporting, and how to investigate a number you don't believe.
- Stock reportsCurrent stock, by-location and by-category views, valuation, dead and stale stock, unplaced items, and COGS.
- Stock analyticsTurnover, aging, ABC classification, and stock confidence — what each measures and what to do with it.
- Movement & counting reportsMovement history and rollups, top adjustments, counting variance, and high-variance adjustment review.
- Purchasing reportsPO status, supplier performance, price history, order frequency, and reorder analysis.
- Project & tool reportsPlanned vs actual material usage, tool checkout history, calibration due, and the asset inventory.
- Scheduled reportsReport subscriptions on a cadence: formats, channels, cron schedules, run-now, and delivery states.
- ExportsBackground export jobs: the kinds catalog, job lifecycle, signed downloads, and exports as evidence.
- InsightsAI-surfaced anomalies — consumption spikes, silent drops, project risk, supplier drift — and the dashboard widgets.
- The audit logThe organization-wide audit trail: what it records, filtering, event detail, exporting, and retention.
Collaboration
- Comments & mentionsDiscussion threads on records, @mentions, and watching objects for changes.
- Notes & attachmentsPinned notes on records, and file attachments: images, primary photos, documents, and where they surface.
- Saved viewsSave list configurations — filters, columns, sorting — as personal defaults or shared team views.
- NotificationsThe bell, the notification center, per-kind delivery preferences, quiet hours, and e-mail unsubscribe.
- ApprovalsFour-eyes control for high-risk actions: what needs approval, the queue, deciding, delegation, and the decision trail.
Administration
- UsersMembership lifecycle: inviting, roles at a glance, site scoping, deactivation, and session revocation.
- Roles & permissionsThe four roles, the permission matrix, customizing role permissions, and how capability gating interacts.
- Security & identitySession management, step-up re-authentication, SSO and SCIM, and support-access consent.
- Organization settingsThe settings hub, organization defaults — language, time zone, currency, valuation model — numbering formats, and e-mail.
- Categories, tags, units & fieldsThe controlled vocabularies: category tree, tags with merging, units and conversions, conditions, reason codes, and custom fields.
- AlertsAlert rules across all kinds — stock, counts, purchasing, transfers, tools, exports — plus threshold overrides and noise control.
- Workflow automationEvent-driven rules: triggers, conditions, actions, dry-run testing, the execution log, and safe rollout.
- Billing & plansThe plan catalog, quotas and usage, trials and grace periods, checkout, the billing portal, and invoices.
- Data lifecycleAudit retention configuration, tenant data export, and the erasure request process.
Integrations
- API keysScoped keys for the public API: live vs dev environments, one-time secrets, rotation, IP allowlists, and usage.
- WebhooksPush events to your systems: subscriptions, the event catalog, signing secrets, test deliveries, and the delivery log.
- AccountingConnect Fiken, QuickBooks Online, Xero, or Tripletex; map accounts; run journal exports; and reconcile deliveries.
Migration
- Migrate data into ItemraPlan a controlled CSV migration with mapping, preview, validation, and reconciliation.
- The import wizardCSV imports for items, locations, stock, and BOMs: upload, mapping with suggestions, preview, error resolution, and commit.
- Migrate from PartsBoxPrepare a PartsBox JSON or table CSV export, preview the mapping, and reconcile catalog, locations, and opening stock.
- Migrate from SortlyExport the Sortly Inventory Summary as CSV, review folders and quantities, and reconcile the current inventory snapshot.
- Migrate from InvenTreeExport relevant InvenTree tables as CSV, preserve filtered scope deliberately, and reconcile parts, locations, and stock.
Developers
- API overviewThe Customer API: base URL, bearer authentication, scopes, sandbox, versioning, pagination, idempotency, rate limits, and errors.
- QuickstartFrom a scoped key to your first request, paged results, a queued import, and receiving changes.
- API resourcesA map of the ~250 operations by area — what lives where, and which scope it needs.
- The events feedPull-based change consumption: the envelope, cursor paging, type filters, checkpoints, and events vs webhooks.
- Webhooks (developer)Receiving Itemra webhooks correctly: headers, HMAC verification, idempotent consumption, retries, and replay.
- SDKs & artifactsThe developer kit: TypeScript and C# SDKs, the Postman collection, and the governed OpenAPI contract.
- MCP & connectorsThe Itemra MCP server for AI agents, and the Zapier and Make connector sources.