Skip to main content
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 } } } } } }"
}
'
{
  "data": {
    "putaway_rules": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "42",
              "rule": "walk_sequence",
              "direction": "asc",
              "position": 1,
              "account": {
                "id": "7",
                "code": "ACME"
              }
            }
          }
        ]
      }
    }
  }
}

​
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

FilterInput TypeOperatorsDescription
account_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledAccount ID
account_codeStringInputTypeeq, ilike, like, in, betweenAccount code
ruleRuleInputTypeeq, inRule (enum input — e.g. code, walk_sequence)
directionDirectionInputTypeeq, inSort direction (enum input — asc/desc)
positionIntegerInputTypeeq, gt, gteq, lt, lteq, betweenPosition 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.

​
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

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

Response

Successful GraphQL response

​
data
object
​
errors
object[]