API reference

Choose a section or search for an endpoint. This reference is generated from the application's OpenAPI specification, preserving the original field names and schema descriptions.

Replace https://inventory.example.com/api/v1 with your own instance address. Authentication and your first request explain the different tokens and permissions. Test session-authenticated requests on your application instance; requests from another domain are subject to its CORS rules.

Download OpenAPI JSON · Download OpenAPI YAML

notifications (9)

• List the current user's in-app notifications
• Mark one notification read
• Mark every notification for the current user read
• Read personal anti-noise and channel preferences
• Update personal notification preferences
• Subscribe the current browser to Web Push
• Revoke the current browser's Web Push subscription
• Preview one delivery channel without sending
• Run notification detection and due digest dispatch

integrations (7)

• Read the WooCommerce connection status
• Enable or disable WooCommerce order synchronization
• Disconnect the WooCommerce store
• Connect or replace a WooCommerce store
• Test the saved WooCommerce connection
• Import recent WooCommerce orders, reconcile one order, or retry issues
• Receive a signed WooCommerce order webhook

webhooks (11)

• List outgoing webhook endpoints
• Create an outgoing webhook endpoint
• Retrieve one outgoing webhook endpoint
• Update an outgoing webhook endpoint
• Delete an outgoing webhook endpoint
• Enqueue a real signed test delivery
• Rotate a webhook signing secret
• List delivery attempts for one webhook endpoint
• Manually retry a failed delivery
• Process due outgoing webhook deliveries
• Receive an outgoing Inventory event

spatial rooms (13)

• List buildings and their active indoor-scan coverage
• Create a building or other multi-room structure
• Retrieve active rooms grouped by floor and AR coordinate space
• Update a structure's name or canonical map anchor
• List active 3D room scans
• Upload a normalized RoomPlan scan and its native assets
• Retrieve a web-viewer scene with positioned inventory
• Position one room inside its floor layout
• Download an authenticated native room-scan asset
• Attach or replace a photorealistic room derivative
• Download an authenticated RGB localization keyframe
• Remove an item's placement from this scan
• Create or replace an item's current indoor 3D placement

authentication (3)

• Sign in a native client with a local account
• Revoke the current bearer token
• Inspect the authenticated token's available scopes

organizations (7)

• List organizations available to the current identity
• Create an organization for the current browser user
• Select one of the current user's organizations
• Update an organization's settings
• List every organization in the deployment
• Create an organization as a deployment superadmin
• Update any organization as a deployment superadmin

access control (7)

• List roles, inventory access rules, and permission metadata
• Create an access role
• Update an access role
• Delete an access role
• Create a conditional inventory access rule
• Update a conditional inventory access rule
• Delete a conditional inventory access rule

custom fields (6)

• List custom-field definitions
• Create a custom-field definition
• Retrieve a custom-field definition
• Update a custom-field definition
• Archive a custom-field definition
• Search or resolve reference-field choices

label setups (5)

• List reusable label setups
• Create a label setup
• Retrieve a label setup
• Update a label setup using its current revision
• Delete a label setup

inventory structure (10)

• List configured inventory types
• Create an inventory type
• Update or restore an inventory type
• Archive an inventory type
• List configured relationship types
• Create a relationship type
• Update, archive, or restore a relationship type
• List relationships touching an inventory item
• Create or pin a manual relationship
• Remove a manual resource relationship

ai (15)

• Match one photographed object to existing inventory items
• Count matching physical items in one transient image
• Poll one signed Replicate count job
• List Replicate counting models enabled for this deployment
• List image-generation models enabled for this deployment
• Queue a durable translation backfill
• Queue stale fields for background translation
• Generate structured item fields from the first three images
• Add missing item details using saved content, images, and GPT web search
• Generate a square studio or transparent cover from an item image
• Find a reusable web image or generate a new AI image and append it to an item
• Estimate bin contents from 3–5 photos (experimental)
• Check local 3D counting availability
• Start an experimental 3D bin estimate
• Read a 3D estimate or download its GLB

content translations (8)

• List active content languages
• Add a content language
• Update a content language
• Archive a target content language
• Queue a durable translation backfill
• Inspect field-level translation freshness
• Queue stale fields for background translation
• Edit, approve, or unlock translated fields

contacts (9)

• List customers and suppliers
• Create a customer, supplier, or dual-role contact
• Get one contact
• Update a contact and its inventory assignments
• Archive a contact
• List a contact's comments
• Add a comment to a contact
• Edit an owned contact comment
• Delete an owned contact comment

resources (13)

• List inventory items
• Create an inventory item
• Apply shared fields and additional tags to multiple inventory items atomically
• Retrieve an inventory item
• Update an inventory item
• Delete an inventory item and its local media
• Retrieve a first-class inventory variant family
• Create a first-class variant or connect an existing inventory item
• Detach a first-class variant from its primary item
• Retrieve option groups and the current resource's selections
• Generate every non-default option combination
• Replace option-group definitions before variants are generated
• Resolve a scanned QR or barcode to an inventory item

data exchange (2)

• Import inventory items from UTF-8 CSV
• Export the complete inventory as CSV, Excel, or PDF

manufacturing (11)

• Retrieve option groups and the current resource's selections
• Generate every non-default option combination
• Replace option-group definitions before variants are generated
• Retrieve an item's effective bill of materials and current build capacity
• Reset a variant's bill of materials to its primary item
• Replace an item's effective bill of materials
• Preview an automatic finished-product configuration without creating records
• Prepare only the selected configuration for manual customization
• List assemblies whose effective bill of materials uses this item
• List completed assembly builds for an item
• Atomically consume components and create finished stock

stock (13)

• Retrieve stock health and replenishment forecasts
• Retrieve one item's stock policy, forecast, units, and ledger
• Retrieve stock balances by structured inventory location
• Update tracking mode and replenishment policy
• List the dated stock ledger
• Book a bulk stock change or structured location transfer
• Correct a manual bulk stock movement
• Delete a manual bulk stock movement
• List individually identified stock units
• Create one or more individually identified stock units
• Change a unit's code, status, location, or metadata with an audit entry
• Delete an unlinked serialized unit while retaining movement history
• Read stock planning inputs and history

scan workflows (17)

• Load targets, variants and conditional inputs for an action chain
• Prepare a native scan and return the server-extracted identifier
• Preview all actions without committing changes
• Confirm all actions in one transaction
• Load targets, variants and conditional inputs for an action chain
• Preview or confirm an enabled public action chain
• List configurable stock scan workflows
• Create a stock scan workflow
• Retrieve one stock scan workflow
• Update a workflow using its current revision
• Delete a stock scan workflow
• Replace a workflow's unlisted public action URL
• Generate a validated regex extractor from a sample code with AI
• Resolve and preview a scanned code without changing stock
• Apply a previously reviewed stock scan to its selected targets
• Load the form definition for an enabled public action URL
• Confirm and execute an unlisted public action

inventory cycles (5)

• List inventory cycles that are currently due
• Retrieve an item's inventory cycle and recent count history
• Create or replace an item's recurring count policy
• List an item's recent inventory counts
• Record an inventory count or serialized-unit review

internal requests (5)

• List visible internal requests
• Submit a multi-item inventory request
• List reservation calendar entries
• Read one visible internal request
• Transition an internal request

assignments (6)

• List checkout, assignment, and reservation records for an item
• Check out, assign, or reserve inventory
• Read the resource lending policy
• Enable or configure loans for an inventory item
• List loans and direct reservations across the workspace
• Check out, return, or cancel an active assignment

purchasing (5)

• List purchase orders and their open incoming quantities
• Create a draft or ordered purchase order
• Retrieve one purchase order
• Update or cancel a purchase order
• Receive all or part of an ordered line into physical stock

orders (10)

• List purchase, sales, or loan orders from the shared order model
• Create a purchase, sales, or multi-item loan order
• Retrieve one shared order with all lines
• Update common order fields or change lifecycle state
• List outbound parcels for a sales order
• Create an outbound parcel from fulfilled sales-order lines
• Update shipment details or advance its delivery status
• Issue or return a bulk-tracked sales or loan line
• List available and assigned serialized units for an order line
• Reserve, release, issue, or return concrete serialized units

media (3)

• Upload up to 12 media files, including Apple USDZ object models
• Reorder all media
• Remove one media file

insights (3)

• Retrieve aggregate dashboard statistics
• Find likely duplicate item pairs
• Merge one duplicate into another

label printing (12)

• Read the personal saved print list
• Save print preferences or replace the prepared list
• List enabled shared printers
• Provision a shared Office printer
• Disable a shared printer
• List your latest shared print jobs
• Queue a prepared PT-P710BT print job
• Cancel one of your waiting print jobs
• Claim the next job for a printer
• Acknowledge a printer claim
• Read the optional QZ signing certificate
• Sign an allowed QZ print request