List storage unit types

curl --request POST \
  --url 'https://clarus-api.com/graphql#ListStorageUnitTypes' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: StorageUnitTypeFilterType) { storage_unit_types { all(filter: $filter) { edges { node { id code name unit_name is_pickable has_check_digit dimensions { length width height weight unit_of_measure } } } } } }"
}
'

import requests

url = "https://clarus-api.com/graphql#ListStorageUnitTypes"

payload = { "query": "query($filter: StorageUnitTypeFilterType) { storage_unit_types { all(filter: $filter) { edges { node { id code name unit_name is_pickable has_check_digit dimensions { length width height weight unit_of_measure } } } } } }" }
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({
    query: 'query($filter: StorageUnitTypeFilterType) { storage_unit_types { all(filter: $filter) { edges { node { id code name unit_name is_pickable has_check_digit dimensions { length width height weight unit_of_measure } } } } } }'
  })
};

fetch('https://clarus-api.com/graphql#ListStorageUnitTypes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "storage_unit_types": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "12",
              "code": "STDPAL",
              "name": "Standard Pallet",
              "unit_name": "Pallet",
              "is_pickable": false,
              "has_check_digit": true,
              "dimensions": {
                "length": 1.2,
                "width": 1,
                "height": 1.5,
                "weight": 25,
                "unit_of_measure": "metre"
              }
            }
          }
        ]
      }
    }
  }
}

{
  "error": "<string>"
}

POST

graphql#ListStorageUnitTypes

List storage unit types

curl --request POST \
  --url 'https://clarus-api.com/graphql#ListStorageUnitTypes' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: StorageUnitTypeFilterType) { storage_unit_types { all(filter: $filter) { edges { node { id code name unit_name is_pickable has_check_digit dimensions { length width height weight unit_of_measure } } } } } }"
}
'

import requests

url = "https://clarus-api.com/graphql#ListStorageUnitTypes"

payload = { "query": "query($filter: StorageUnitTypeFilterType) { storage_unit_types { all(filter: $filter) { edges { node { id code name unit_name is_pickable has_check_digit dimensions { length width height weight unit_of_measure } } } } } }" }
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({
    query: 'query($filter: StorageUnitTypeFilterType) { storage_unit_types { all(filter: $filter) { edges { node { id code name unit_name is_pickable has_check_digit dimensions { length width height weight unit_of_measure } } } } } }'
  })
};

fetch('https://clarus-api.com/graphql#ListStorageUnitTypes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "storage_unit_types": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "12",
              "code": "STDPAL",
              "name": "Standard Pallet",
              "unit_name": "Pallet",
              "is_pickable": false,
              "has_check_digit": true,
              "dimensions": {
                "length": 1.2,
                "width": 1,
                "height": 1.5,
                "weight": 25,
                "unit_of_measure": "metre"
              }
            }
          }
        ]
      }
    }
  }
}

{
  "error": "<string>"
}

Query Structure

query($filter: StorageUnitTypeFilterType) {
  storage_unit_types {
    all(filter: $filter) {
      edges {
        node {
          id
          code
          name
          unit_name
          is_pickable
          has_check_digit
          dimensions {
            length
            width
            height
            weight
            unit_of_measure
          }
        }
      }
    }
  }
}

Filter Argument

All filters are passed inside the filter argument. Each filter field accepts an input object with operators (e.g. eq, ilike, from, to, between):

{
  "filter": {
    "code": {
      "ilike": "value"
    }
  }
}

Available Filters

Filter	Input Type	Operators	Description
`code`	StringInputType	`eq`, `ilike`, `like`, `in`, `between`	Code
`name`	StringInputType	`eq`, `ilike`, `like`, `in`, `between`	Name
`unit_name`	StringInputType	`eq`, `ilike`, `like`, `in`, `between`	Unit name
`is_pickable`	BooleanInputType	`eq`	Pickable flag
`has_check_digit`	BooleanInputType	`eq`	Check-digit flag
`leaves_warehouse`	BooleanInputType	`eq`	Leaves-warehouse flag

More fields and filters available via GraphQL introspection.

Authorizations

Authorization

string

header

required

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

FlowAuthorization Code

Authorization URL: https://clarus-api.com/oauth/authorize
Token URL: https://clarus-api.com/oauth/token

FlowClient Credentials

Token URL: https://clarus-api.com/oauth/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

query

string<textarea>

required

GraphQL query string

Example:

"query($filter: StorageUnitTypeFilterType) { storage_unit_types { all(filter: $filter) { edges { node { id code name unit_name is_pickable has_check_digit dimensions { length width height weight unit_of_measure } } } } } }"

variables

object

Query variables including the filter object

Show child attributes

Example:

{ "filter": { "code": { "ilike": "PAL" } } }

Response

Successful GraphQL response

data

object

Show child attributes

errors

object[]

​Query Structure

​Filter Argument

​Available Filters

Authorizations

Body

Response

Query Structure

Filter Argument

Available Filters