Create a storage unit type
curl --request POST \
--url https://clarus-api.com/api/storage_unit_types \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"data": {
"type": "storage_unit_types",
"attributes": {
"code": "STDPAL",
"name": "Standard Pallet",
"unit_name": "Pallet",
"sequence_id": 7,
"has_check_digit": true,
"is_pickable": false,
"leaves_warehouse": true,
"dimensions": {
"length": 1.2,
"width": 1,
"height": 1.5,
"weight": 25,
"unit_of_measure": "metre",
"weight_unit_of_measure": "kilogram"
}
}
}
}
'import requests
url = "https://clarus-api.com/api/storage_unit_types"
payload = { "data": {
"type": "storage_unit_types",
"attributes": {
"code": "STDPAL",
"name": "Standard Pallet",
"unit_name": "Pallet",
"sequence_id": 7,
"has_check_digit": True,
"is_pickable": False,
"leaves_warehouse": True,
"dimensions": {
"length": 1.2,
"width": 1,
"height": 1.5,
"weight": 25,
"unit_of_measure": "metre",
"weight_unit_of_measure": "kilogram"
}
}
} }
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_unit_types',
attributes: {
code: 'STDPAL',
name: 'Standard Pallet',
unit_name: 'Pallet',
sequence_id: 7,
has_check_digit: true,
is_pickable: false,
leaves_warehouse: true,
dimensions: {
length: 1.2,
width: 1,
height: 1.5,
weight: 25,
unit_of_measure: 'metre',
weight_unit_of_measure: 'kilogram'
}
}
}
})
};
fetch('https://clarus-api.com/api/storage_unit_types', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": "1",
"type": "storage_unit_types",
"attributes": {
"code": "STDPAL",
"name": "Standard Pallet",
"unit_name": "Pallet",
"max_chars": null,
"is_pickable": false,
"has_check_digit": true
}
}
}{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Storage Unit Types
Create a storage unit type
Create a storage unit type.
POST
/
api
/
storage_unit_types
Create a storage unit type
curl --request POST \
--url https://clarus-api.com/api/storage_unit_types \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"data": {
"type": "storage_unit_types",
"attributes": {
"code": "STDPAL",
"name": "Standard Pallet",
"unit_name": "Pallet",
"sequence_id": 7,
"has_check_digit": true,
"is_pickable": false,
"leaves_warehouse": true,
"dimensions": {
"length": 1.2,
"width": 1,
"height": 1.5,
"weight": 25,
"unit_of_measure": "metre",
"weight_unit_of_measure": "kilogram"
}
}
}
}
'import requests
url = "https://clarus-api.com/api/storage_unit_types"
payload = { "data": {
"type": "storage_unit_types",
"attributes": {
"code": "STDPAL",
"name": "Standard Pallet",
"unit_name": "Pallet",
"sequence_id": 7,
"has_check_digit": True,
"is_pickable": False,
"leaves_warehouse": True,
"dimensions": {
"length": 1.2,
"width": 1,
"height": 1.5,
"weight": 25,
"unit_of_measure": "metre",
"weight_unit_of_measure": "kilogram"
}
}
} }
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_unit_types',
attributes: {
code: 'STDPAL',
name: 'Standard Pallet',
unit_name: 'Pallet',
sequence_id: 7,
has_check_digit: true,
is_pickable: false,
leaves_warehouse: true,
dimensions: {
length: 1.2,
width: 1,
height: 1.5,
weight: 25,
unit_of_measure: 'metre',
weight_unit_of_measure: 'kilogram'
}
}
}
})
};
fetch('https://clarus-api.com/api/storage_unit_types', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": "1",
"type": "storage_unit_types",
"attributes": {
"code": "STDPAL",
"name": "Standard Pallet",
"unit_name": "Pallet",
"max_chars": null,
"is_pickable": false,
"has_check_digit": true
}
}
}{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Request Structure
{
"data": {
"type": "storage_unit_types",
"attributes": {
"code": "STDPAL",
"name": "Standard Pallet",
"unit_name": "Pallet",
"sequence_id": 7,
"dimensions": { "length": 1.2, "width": 1.0, "height": 1.5, "weight": 25.0, "unit_of_measure": "metre" }
}
}
}
| Field | Required | Description |
|---|---|---|
code | Yes | Unique code (max 30) |
name | Yes | Name (max 50) |
sequence_id | Yes | Barcode sequence |
unit_name | No* | Singular unit name (model-required) |
dimensions | No | Nested dimensions object (write-only; read via GraphQL) |
dimensions are stored separately and are not returned in REST responses — read them via the GraphQL list.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
Created successfully
The response is of type object.
⌘I

