List putaway rules

curl --request POST \
  --url 'https://clarus-api.com/graphql#ListPutawayRules' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: PutawayRuleFilterType) { putaway_rules { all(filter: $filter) { edges { node { id rule direction position account { id code } } } } } }"
}
'

import requests

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

payload = { "query": "query($filter: PutawayRuleFilterType) { putaway_rules { all(filter: $filter) { edges { node { id rule direction position account { 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: PutawayRuleFilterType) { putaway_rules { all(filter: $filter) { edges { node { id rule direction position account { id code } } } } } }'
  })
};

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

{
  "data": {
    "putaway_rules": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "42",
              "rule": "walk_sequence",
              "direction": "asc",
              "position": 1,
              "account": {
                "id": "7",
                "code": "ACME"
              }
            }
          }
        ]
      }
    }
  }
}

{
  "error": "<string>"
}

POST

graphql#ListPutawayRules

List putaway rules

curl --request POST \
  --url 'https://clarus-api.com/graphql#ListPutawayRules' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: PutawayRuleFilterType) { putaway_rules { all(filter: $filter) { edges { node { id rule direction position account { id code } } } } } }"
}
'

import requests

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

payload = { "query": "query($filter: PutawayRuleFilterType) { putaway_rules { all(filter: $filter) { edges { node { id rule direction position account { 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: PutawayRuleFilterType) { putaway_rules { all(filter: $filter) { edges { node { id rule direction position account { id code } } } } } }'
  })
};

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

{
  "data": {
    "putaway_rules": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "42",
              "rule": "walk_sequence",
              "direction": "asc",
              "position": 1,
              "account": {
                "id": "7",
                "code": "ACME"
              }
            }
          }
        ]
      }
    }
  }
}

{
  "error": "<string>"
}

Query Structure

query($filter: PutawayRuleFilterType) {
  putaway_rules {
    all(filter: $filter) {
      edges {
        node {
          id
          rule
          direction
          position
          account {
            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": {
    "account_id": {
      "eq": "value"
    }
  }
}

Available Filters

Filter	Input Type	Operators	Description
`account_id`	IdInputType	`eq`, `in`, `gt`, `gteq`, `lt`, `lteq`, `filled`	Account ID
`account_code`	StringInputType	`eq`, `ilike`, `like`, `in`, `between`	Account code
`rule`	RuleInputType	`eq`, `in`	Rule (enum input — e.g. `code`, `walk_sequence`)
`direction`	DirectionInputType	`eq`, `in`	Sort direction (enum input — `asc`/`desc`)
`position`	IntegerInputType	`eq`, `gt`, `gteq`, `lt`, `lteq`, `between`	Position in the rule order

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: PutawayRuleFilterType) { putaway_rules { all(filter: $filter) { edges { node { id rule direction position account { id code } } } } } }"

variables

object

Query variables including the filter object

Show child attributes

Example:

{ "filter": { "account_id": { "eq": "7" } } }

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