Skip to main content
POST
/
api
/
storage_units
Create a storage unit
curl --request POST \
  --url https://clarus-api.com/api/storage_units \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "storage_units",
    "attributes": {
      "storage_unit_type_id": 123,
      "reference": "<string>",
      "location_id": 123,
      "string1": "<string>",
      "string2": "<string>",
      "string3": "<string>",
      "string4": "<string>",
      "string5": "<string>"
    }
  }
}
'
{
  "data": {
    "id": 123,
    "type": "storage_units",
    "attributes": {
      "storage_unit_type_id": 123,
      "reference": "<string>",
      "location_id": 123,
      "string1": "<string>",
      "string2": "<string>",
      "string3": "<string>",
      "string4": "<string>",
      "string5": "<string>"
    }
  }
}

​
Request Structure

{
  "data": {
    "type": "storage_units",
    "attributes": {
      "reference": "PLT-2024-001",
      "storage_unit_type_id": 1,
      "warehouse_id": 1,
      "location_id": 456,
      "barcode": "PLT2024001"
    }
  }
}

​
Key Fields

FieldRequiredDescription
referenceNoUnique reference for the storage unit
storage_unit_type_idYesType of container (pallet, cage, etc.)
warehouse_idYesWarehouse where unit is located
location_idNoCurrent location ID
barcodeNoScannable barcode for RF devices

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

​
X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Body

application/json
​
data
object
required

Response

Storage unit created successfully

​
data
object