List reason codes

curl --request POST \
  --url 'https://clarus-api.com/graphql#ListReasonCodes' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: ReasonCodeFilterType) { reason_codes { all(filter: $filter) { edges { node { id code name description reason_type active generic } } } } }"
}
'

import requests

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

payload = { "query": "query($filter: ReasonCodeFilterType) { reason_codes { all(filter: $filter) { edges { node { id code name description reason_type active generic } } } } }" }
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: ReasonCodeFilterType) { reason_codes { all(filter: $filter) { edges { node { id code name description reason_type active generic } } } } }'
  })
};

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

{
  "data": {
    "reason_codes": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "1",
              "code": "ADJ-NEG-01",
              "name": "Damaged in transit",
              "description": "Negative stock adjustment",
              "reason_type": "negative_adjustment",
              "active": true,
              "generic": false
            }
          }
        ]
      }
    }
  }
}

{
  "error": "<string>"
}

POST

graphql#ListReasonCodes

List reason codes

curl --request POST \
  --url 'https://clarus-api.com/graphql#ListReasonCodes' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: ReasonCodeFilterType) { reason_codes { all(filter: $filter) { edges { node { id code name description reason_type active generic } } } } }"
}
'

import requests

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

payload = { "query": "query($filter: ReasonCodeFilterType) { reason_codes { all(filter: $filter) { edges { node { id code name description reason_type active generic } } } } }" }
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: ReasonCodeFilterType) { reason_codes { all(filter: $filter) { edges { node { id code name description reason_type active generic } } } } }'
  })
};

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

{
  "data": {
    "reason_codes": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "1",
              "code": "ADJ-NEG-01",
              "name": "Damaged in transit",
              "description": "Negative stock adjustment",
              "reason_type": "negative_adjustment",
              "active": true,
              "generic": false
            }
          }
        ]
      }
    }
  }
}

{
  "error": "<string>"
}

Query Structure

query($filter: ReasonCodeFilterType) {
  reason_codes {
    all(filter: $filter) {
      edges {
        node {
          id
          code
          name
          description
          reason_type
          active
          generic
        }
      }
    }
  }
}

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`	Reason code
`name`	StringInputType	`eq`, `ilike`, `like`, `in`, `between`	Reason name
`reason_type`	ReasonTypeInputType	`eq`, `in`	Reason type (enum input — e.g. `negative_adjustment`, `hold`, `transfer`)
`active`	BooleanInputType	`eq`	Active flag
`generic`	BooleanInputType	`eq`	Generic flag
`account_id`	IdInputType	`eq`, `in`, `gt`, `gteq`, `lt`, `lteq`, `filled`	Associated account ID

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: ReasonCodeFilterType) { reason_codes { all(filter: $filter) { edges { node { id code name description reason_type active generic } } } } }"

variables

object

Query variables including the filter object

Show child attributes

Example:

{
  "filter": {
    "reason_type": { "eq": "negative_adjustment" }
  }
}

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