Skip to main content
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"
      }
    }
  }
}
'
{
  "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
    }
  }
}

​
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" }
    }
  }
}
FieldRequiredDescription
codeYesUnique code (max 30)
nameYesName (max 50)
sequence_idYesBarcode sequence
unit_nameNo*Singular unit name (model-required)
dimensionsNoNested dimensions object (write-only; read via GraphQL)
Update returns 204 No Content. dimensions are stored separately and are not returned in REST responses — read them via the GraphQL list.

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

Created successfully

The response is of type object.