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>"
}
}
}
'import requests
url = "https://clarus-api.com/api/storage_units"
payload = { "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>"
}
} }
headers = {
"Authorization": "Bearer <token>",
"X-Clarus-Subdomain": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Clarus-Subdomain': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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>'
}
}
})
};
fetch('https://clarus-api.com/api/storage_units', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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>"
}
}
}{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Storage Units
Create a storage unit
Create a new storage unit (pallet, cage, box, etc.) for grouping and tracking inventory as a single container.
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>"
}
}
}
'import requests
url = "https://clarus-api.com/api/storage_units"
payload = { "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>"
}
} }
headers = {
"Authorization": "Bearer <token>",
"X-Clarus-Subdomain": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Clarus-Subdomain': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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>'
}
}
})
};
fetch('https://clarus-api.com/api/storage_units', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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>"
}
}
}{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}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
| Field | Required | Description |
|---|---|---|
reference | No | Unique reference for the storage unit |
storage_unit_type_id | Yes | Type of container (pallet, cage, etc.) |
warehouse_id | Yes | Warehouse where unit is located |
location_id | No | Current location ID |
barcode | No | Scannable barcode for RF devices |
Authorizations
OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.
The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.
Body
application/json
Show child attributes
Show child attributes
Response
Storage unit created successfully
Show child attributes
Show child attributes
⌘I

