List product storage units

curl --request POST \
  --url 'https://clarus-api.com/graphql#ListProductStorageUnits' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: ProductStorageUnitFilterType) { product_storage_units { all(filter: $filter) { edges { node { id priority stock_configuration unit_of_measure per_layer number_of_layers total product { id code } storage_unit_type { id code } } } } } }"
}
'

import requests

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

payload = { "query": "query($filter: ProductStorageUnitFilterType) { product_storage_units { all(filter: $filter) { edges { node { id priority stock_configuration unit_of_measure per_layer number_of_layers total product { id code } storage_unit_type { id code } } } } } }" }
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: ProductStorageUnitFilterType) { product_storage_units { all(filter: $filter) { edges { node { id priority stock_configuration unit_of_measure per_layer number_of_layers total product { id code } storage_unit_type { id code } } } } } }'
  })
};

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

{
  "data": {
    "product_storage_units": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "9",
              "priority": 0,
              "stock_configuration": "case",
              "unit_of_measure": "centimetre",
              "per_layer": 10,
              "number_of_layers": 5,
              "total": 50,
              "product": {
                "id": "150",
                "code": "WIDGET-RED-500"
              },
              "storage_unit_type": {
                "id": "12",
                "code": "PAL"
              }
            }
          }
        ]
      }
    }
  }
}

{
  "error": "<string>"
}

POST

graphql#ListProductStorageUnits

List product storage units

curl --request POST \
  --url 'https://clarus-api.com/graphql#ListProductStorageUnits' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: ProductStorageUnitFilterType) { product_storage_units { all(filter: $filter) { edges { node { id priority stock_configuration unit_of_measure per_layer number_of_layers total product { id code } storage_unit_type { id code } } } } } }"
}
'

import requests

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

payload = { "query": "query($filter: ProductStorageUnitFilterType) { product_storage_units { all(filter: $filter) { edges { node { id priority stock_configuration unit_of_measure per_layer number_of_layers total product { id code } storage_unit_type { id code } } } } } }" }
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: ProductStorageUnitFilterType) { product_storage_units { all(filter: $filter) { edges { node { id priority stock_configuration unit_of_measure per_layer number_of_layers total product { id code } storage_unit_type { id code } } } } } }'
  })
};

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

{
  "data": {
    "product_storage_units": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "9",
              "priority": 0,
              "stock_configuration": "case",
              "unit_of_measure": "centimetre",
              "per_layer": 10,
              "number_of_layers": 5,
              "total": 50,
              "product": {
                "id": "150",
                "code": "WIDGET-RED-500"
              },
              "storage_unit_type": {
                "id": "12",
                "code": "PAL"
              }
            }
          }
        ]
      }
    }
  }
}

{
  "error": "<string>"
}

Query Structure

query($filter: ProductStorageUnitFilterType) {
  product_storage_units {
    all(filter: $filter) {
      edges {
        node {
          id
          priority
          stock_configuration
          unit_of_measure
          per_layer
          number_of_layers
          total
          product {
            id
            code
          }
          storage_unit_type {
            id
            code
          }
        }
      }
    }
  }
}

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": {
    "product_id": {
      "eq": "value"
    }
  }
}

Available Filters

Filter	Input Type	Operators	Description
`product_id`	IdInputType	`eq`, `in`, `gt`, `gteq`, `lt`, `lteq`, `filled`	Product ID
`product_code`	StringInputType	`eq`, `ilike`, `like`, `in`, `between`	Product code
`storage_unit_type_id`	IdInputType	`eq`, `in`, `gt`, `gteq`, `lt`, `lteq`, `filled`	Storage unit type ID
`storage_unit_type_code`	StringInputType	`eq`, `ilike`, `like`, `in`, `between`	Storage unit type code
`priority`	IntegerInputType	`eq`, `gt`, `gteq`, `lt`, `lteq`, `between`	Priority
`total`	DecimalInputType	`eq`, `gt`, `gteq`, `lt`, `lteq`, `between`	Total per full unit

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.

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: ProductStorageUnitFilterType) { product_storage_units { all(filter: $filter) { edges { node { id priority stock_configuration unit_of_measure per_layer number_of_layers total product { id code } storage_unit_type { id code } } } } } }"

variables

object

Query variables including the filter object

Show child attributes

Example:

{
  "filter": { "product_code": { "ilike": "WIDGET" } }
}

Response

Successful GraphQL response

data

object

Show child attributes

errors

object[]

⌘I

​Query Structure

​Filter Argument

​Available Filters

Authorizations

Body

Response

Query Structure

Filter Argument

Available Filters