Information submitted through the support site is private but is not hosted within your secure CDD Vault. Please do not include sensitive intellectual property in your support requests.

Inventory_Locations [GET]

Return a list of Sample Inventory Locations for the given Vault.

GET /api/v1/vaults/$VAULT_ID/inventory_locations

JSON Parameters (all optional):

async Boolean
If true, do an asynchronous export (see Async Export)
Use for large data sets. This is recommended any time you want to download more than page_size results. Note: any page_size parameter used in an API GET call that also uses the async=true parameter will be ignored. The GET call will return all valid data for the given GET call.
offset The index of the first object actually returned. Defaults to 0.
page_size The maximum number of objects to return in this call. Default is 50, maximum is 1000. If the response exceeds the page_size, we strongly recommend using the async option instead of downloading multiple chunks. Note: any page_size parameter used in an API GET call that also uses the async=true parameter will be ignored. The GET call will return all valid data for the given GET call.


Example:

curl -H "X-CDD-Token: $TOKEN" https://app.collaborativedrug.com/api/v1/vaults/489978881/inventory_locations


Returns:

[
{
"id": 1209,
"class": "inventory location",
"created_at": "2023-10-30T18:25:41.771Z",
"modified_at": "2023-10-30T18:25:41.771Z",
"filled_position_count": 0,
"num_columns": 0,
"num_rows": 0,
"position_limit": 0,
"value": "Gotham"
},
{
"id": 1210,
"class": "inventory location",
"created_at": "2023-10-30T18:25:41.774Z",
"modified_at": "2023-10-30T18:25:41.774Z",
"filled_position_count": 0,
"num_columns": 0,
"num_rows": 0,
"parent_id": 1209,
"position_limit": 0,
"value": "Blackgate"
},
{
"id": 1211,
"class": "inventory location",
"created_at": "2023-10-30T18:25:41.777Z",
"modified_at": "2023-10-30T18:25:41.777Z",
"filled_position_count": 0,
"num_columns": 0,
"num_rows": 0,
"parent_id": 1210,
"position_limit": 0,
"value": "Freezer 1"
},
{
"id": 1212,
"class": "inventory location",
"created_at": "2023-10-30T18:25:41.779Z",
"modified_at": "2023-10-30T18:25:41.779Z",
"filled_position_count": 0,
"num_columns": 8,
"num_rows": 8,
"parent_id": 1211,
"position_limit": 64,
"value": "Box 1"
}, .
.
.