Inventory Management
Check organization inventory, assign inventory to Users, and understand how assignment affects downstream workflows.
Inventory Management
Inventory Management APIs let your organization manage the pool of inventory that can be assigned to Users.
Inventory is a shared control layer. Assignment can determine which data submission workflows, lab ordering paths, and outputs a User can access. Use these endpoints before starting a workflow that depends on assigned inventory.
Inventory assignment uses service-level authorization. Downstream workflows may switch to customer-level authorization after inventory is assigned.
Assign available inventory from your organization to a User.
Use assigned inventory before workflow-specific steps such as lab ordering or upload workflows.
Avoid duplicate assignment and prevent unassignment after downstream use.
Where This Fits
Use Inventory Management after a linked InsideTracker customer record exists and before a workflow requires assigned inventory.
Inventory is not only part of Lab Connect. It can also affect User-uploaded blood result workflows and output availability when those workflows depend on the inventory assigned to the User.
Before You Begin
| Requirement | Why you need it |
|---|---|
| Service-level access token | Inventory APIs use company or service-level authorization. |
User extId | Used as customerExtId for User-specific inventory operations. |
| Inventory item SKU | Required as inventoryItemSku when assigning or unassigning a specific inventory item. |
| Intended downstream workflow | Required so your application assigns the inventory intended for the workflow or panel the User should access. |
| Usage or activation state | Required before unassigning; inventory that has already been used or activated should not be unassigned. |
Endpoint Overview
| Action | Method and path | Auth |
|---|---|---|
| Get organization inventory summary | GET /enterprise/inventory/sa/v1/summary | Service-level |
| Get a User's assigned inventory | GET /enterprise/inventory/sa/v1/customer/{customerExtId} | Service-level |
| Assign inventory to a User | POST /enterprise/inventory/sa/v1/assignment | Service-level |
| Unassign inventory from a User | DELETE /enterprise/inventory/sa/v1/assignment | Service-level |
Check Available Inventory
Use the inventory summary endpoint to identify what inventory types your organization has available before presenting a workflow option to a User.
GET /enterprise/inventory/sa/v1/summary
Authorization: Bearer {service_access_token}The response includes inventory summary rows with fields such as sku, title, available, used, and total.
Check User Inventory
Check a User's inventory before assigning new inventory. This helps avoid duplicate assignments and lets your application resume an in-progress workflow.
GET /enterprise/inventory/sa/v1/customer/{customerExtId}
Authorization: Bearer {service_access_token}Use the User's InsideTracker-linked extId as {customerExtId}.
The response includes assigned inventory rows with fields such as sku, title, and status.code.
Assign Inventory
Assign the selected inventory item to the User.
POST /enterprise/inventory/sa/v1/assignment
Content-Type: application/json
Authorization: Bearer {service_access_token}{
"customerExtId": "b2d905cd-e5ff-4843-817e-cc27a916c90c",
"inventoryItemSku": "ULTIMATE-PLAN-APOB-MARKER"
}After assignment, continue into the workflow that the inventory is intended to unlock. Some downstream workflows use customer-level authentication after assignment.
How Inventory Affects Workflows
| Workflow area | How inventory matters |
|---|---|
| Blood result upload | Assigned inventory can determine whether a User has access to a User-uploaded blood result workflow for the relevant test or product. |
| Lab Connect | Assigned inventory creates or exposes the test context used by Quest and Mobile Blood Draw ordering workflows. Lab Connect covers collection-method selection, activation, and status. |
| Health Intelligence outputs | Output availability can depend on the assigned inventory, resulting test context, result type, and biomarker coverage. For example, Inner Age availability is tied to qualifying result context and eligible biomarker coverage. |
Keep workflow-specific eligibility rules in the relevant workflow page. Inventory Management should establish assignment and available inventory state; Lab Connect, Blood Result Upload, and output topics should explain their own downstream requirements.
Unassign Inventory
Use unassignment only when the assigned inventory should be removed before the User has used or activated it.
DELETE /enterprise/inventory/sa/v1/assignment
Content-Type: application/json
Authorization: Bearer {service_access_token}{
"customerExtId": "b2d905cd-e5ff-4843-817e-cc27a916c90c",
"inventoryItemSku": "ULTIMATE-PLAN-APOB-MARKER"
}Do not unassign inventory after it has been used or activated in a downstream workflow.
Response Codes
The public API reference validates these response codes for the Inventory section:
| Status | Meaning |
|---|---|
200 | Request completed successfully. |
400 | Bad request. |
401 | The request is not authenticated. |
403 | The token does not have access to the operation. |
404 | No customer with the provided customerExtId exists. Validated for the customer inventory endpoint. |
Use the API reference for endpoint-specific response body examples while implementing.
Best Practices
Inventory checklist
- Store and use the User's
extIdfor inventory assignment. - Check organization inventory before showing workflow options.
- Check User inventory before creating a new assignment.
- Store the assigned inventory item SKU and any downstream test or result identifier returned by the API or follow-up workflow.
- Prevent duplicate assignments in your application.
- Treat unassignment as a pre-use or pre-activation operation only.
Related API Reference
GET /enterprise/inventory/sa/v1/summaryGET /enterprise/inventory/sa/v1/customer/{customerExtId}POST /enterprise/inventory/sa/v1/assignmentDELETE /enterprise/inventory/sa/v1/assignment
Updated 27 days ago