Skip to main content
POST
/
graphql#ListLoads
List loads
curl --request POST \
  --url 'https://clarus-api.com/graphql#ListLoads' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: LoadFilterType) { loads { all(filter: $filter) { edges { node { id reference status expected_storage_unit_quantity number_of_storage_units_loaded load_by carrier { id code name } warehouse { id code name } } } } } }"
}
'
{
  "data": {
    "loads": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "1",
              "reference": "LD-001",
              "status": "open",
              "expected_storage_unit_quantity": 10,
              "number_of_storage_units_loaded": 3,
              "load_by": "2026-03-11T16:00:00Z",
              "carrier": {
                "id": "1",
                "code": "DPD",
                "name": "DPD"
              },
              "warehouse": {
                "id": "1",
                "code": "WH1",
                "name": "Main Warehouse"
              }
            }
          }
        ]
      }
    }
  }
}

​
Query Structure

query($filter: LoadFilterType) {
  loads {
    all(filter: $filter) {
      edges {
        node {
          id
          reference
          status
          expected_storage_unit_quantity
          number_of_storage_units_loaded
          load_by
          carrier {
            id
            code
            name
          }
          warehouse {
            id
            code
            name
          }
        }
      }
    }
  }
}

​
Filter Argument

All filters are passed inside the filter argument. Each filter field accepts an input object with operators: 
{
  "filter": {
    "status": {
      "eq": "open"
    }
  }
}

​
Available Filters

FilterInput TypeOperatorsDescription
referenceStringInputTypeeq, ilike, like, in, betweenLoad reference
statusStringInputTypeeq, ilike, like, in, betweenLoad status (open, closed, dispatched, cancelled)
carrier_idIdInputTypeeq, gt, gteq, lt, lteq, in, filledFilter by carrier ID
warehouse_idIdInputTypeeq, gt, gteq, lt, lteq, in, filledFilter by warehouse ID
load_byDatetimeInputTypeeq, from, to, betweenLoad by date

​
Filter Operators

Input TypeOperators
StringInputTypeeq (exact), ilike (case-insensitive partial), like (case-sensitive partial), in (array match), between (range)
IntegerInputTypeeq, gt, gteq, lt, lteq, between
DatetimeInputTypeeq, from, to, between
BooleanInputTypeeq (required)
IdInputTypeeq, gt, gteq, lt, lteq, in, filled
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: LoadFilterType) { loads { all(filter: $filter) { edges { node { id reference status expected_storage_unit_quantity number_of_storage_units_loaded load_by carrier { id code name } warehouse { id code name } } } } } }"

​
variables
object

Query variables including the filter object

Example:
{ "filter": { "status": { "eq": "open" } } }

Response

Successful GraphQL response

​
data
object

Query result data

​
errors
object[]

GraphQL errors, if any