Retrieving Container Data

After syncing your SKU list, the next step is retrieving your organization’s CloudBox containers. Containers represent the physical CloudBox units in your facility and return current inventory values, tracking information, and audit details.

The container export endpoint allows you to pull real-time inventory data into your internal systems, dashboards, or reporting tools.

API Endpoint

GET /api/export/containers

Required Headers

Every request must include the following:

Header Key
Description
org-api-key
Your Organization API key
user-api-key
Your User API Key

Requests missing either header will return 401 Unauthorized

Example Request

bash

curl -X GET "https://app.cloudboxapp.com/api/export/skus" \

-H "org-api-key: YOUR_ORG_API_KEY" \  
-H "user-api-key: YOUR_USER_API_KEY" \  
-H "Accept: application/json"

Response Schema

Column Name
Data Type
Description
id
string
Unique randomly generated number
created_at
string (ISO 8601)
Time container was created
hardwareId
string
Serial of container sticker
serialId
string
Serial of container sticker
name
string
Name of container
currentWeight
number
Current weight in container
unitWeight
number
Unit weight of SKU assigned to the container
lastActive
string (ISO 8601)
Description of SKUTime container was last updated
lastUpdated
string (ISO 8601)
Last time container data was updated
lastBaseName
string
Room container was last updated in
lastBaseLocation
string
Placement container was last updated
organizationId
string
ID of organization who owns the container
containerWeight
number
Weight of empty container
unitModeEnabled
boolean
True if unit mode is enabled
lastBaseId
string
ID of the last base the container was on
tracking_id
string (nullable)
External tracking ID (e.g., Metrc, BioTrack, WMS SKU Serial Number)
active
boolean
Whether container is currently active
units
number
Number of units in container
isOverThreshold
boolean
Whether weight exceeds threshold
isUnitWeightDeviated
boolean
Whether unit weight has deviated from expected
expiration_date
string (YYYY-MM-DD)
Expiration date of contents
isOverThreshold
boolean
Whether weight exceeds threshold
isPossibleTheft
boolean
Flag indicating possible theft detected
is_third_party
boolean
Whether container is from third party
containerStatus
string (nullable)
Current status of container
skuId
string
ID of SKU assigned to container
SKU
object
Information of SKU assigned to the container

Example Request

json

[
 {    
    "id": "container_001",
    "created_at": "2025-01-05T09:30:00Z",
    "hardwareId": "HW-392847",
    "serialId": "SR-584920",
    "name": "Flower Jar A",    
    "currentWeight": 128.45,    
     "unitWeight": 3.5,    
     "lastActive": "2025-01-11T13:59:00Z",    
     "lastUpdated": "2025-01-11T14:22:00Z",    
     "lastBaseName": "Vault Room",    
     "lastBaseLocation": "Shelf 3 - Slot B",    
     "organizationId": "org_456",    
     "containerWeight": 42.3,    
     "unitModeEnabled": true,    
     "lastBaseId": "base_102",    
     "tracking_id": "METRC-ABC123456",    
     "active": true,    "units": 24,    
     "isOverThreshold": false,    
     "isUnitWeightDeviated": false,    
     "expiration_date": "2025-12-31",    
     "isPossibleTheft": false,    
     "is_third_party": false,    
     "containerStatus": "active",    
     "skuId": "sku_123",    
     "SKU": {
       "id": "sku_123",      
       "name": "Lemon Haze 3.5g",      
       "category": "Flower",      
       "unitWeight": 3.5,      
       "trackingId": "ABC123",      
       "unitModeEnabled": true,      
       "expirationDate": "2025-12-31",      
       "description":
       "Premium indoor flower",      
       "organizationId": "org_456",      
       "createdAt": "2025-01-01T10:00:00Z",      
       "updatedAt": "2025-01-10T15:30:00Z",      
       "uploadedSKU": false,      
       "promptUser": false
 }
]

Errors

CloudBox uses standard HTTP status codes to indicate API success or failure:

  • 200–299 – Request succeeded
  • 400 – Bad request (missing parameters, invalid values)
  • 401 – Unauthorized (missing or invalid API keys)
  • 404 – Resource not found
  • 429 – Too many requests (rate limited)