Storage Solution

A storage solution is a physical cryogenic unit, such as a liquid nitrogen tank or dewar, that holds containers organized across multiple levels (canister, cane, rack, box). B2B integrations can list all storage solutions available within a facility and inspect the current inventory of any solution, including which sample containers are stored at each position.

List storage solutions

curl "https://your-api-host/api/v1/external/storage?facilityId=1" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Example Response:

capacity and occupied are counts of sample container slots.

[
  {
    "id": 78,
    "name": "Tank A",
    "type": "DEWAR",
    "facility": { "id": 1, "name": "Main Facility" },
    "capacity": 100,
    "occupied": 42,
    "createdAt": "2024-01-01T00:00:00Z"
  },
  {
    "id": 79,
    "name": "Tank B",
    "type": "DEWAR",
    "facility": { "id": 1, "name": "Main Facility" },
    "capacity": 100,
    "occupied": 18,
    "createdAt": "2024-01-01T00:00:00Z"
  }
]

Get storage inventory

Returns all containers currently stored in the solution. The location object within each container omits the storage field because the storage solution is already the context of this endpoint.

curl https://your-api-host/api/v1/external/storage/78/inventory \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Example Response:

{
  "id": 78,
  "name": "Tank A",
  "inventory": [
    {
      "id": 456,
      "name": "VL-001",
      "description": "Vial 1 - Tissue sample",
      "subject": { "id": 123, "code": "SUBJ-2024-001" },
      "location": {
        "canister": "C1",
        "cane": "CN1"
      },
      "storedAt": "2024-01-15T10:30:00Z"
    },
    {
      "id": 457,
      "name": "VL-002",
      "description": "Vial 2 - Tissue sample",
      "subject": { "id": 123, "code": "SUBJ-2024-001" },
      "location": {
        "canister": "C1",
        "cane": "CN1"
      },
      "storedAt": "2024-01-15T10:31:00Z"
    },
    {
      "id": 458,
      "name": "VL-010",
      "description": "Vial 10 - Tissue sample",
      "subject": { "id": 789, "code": "SUBJ-2024-007" },
      "location": {
        "canister": "C1",
        "cane": "CN2"
      },
      "storedAt": "2024-03-05T14:00:00Z"
    }
  ]
}