Skip to main content
POST
/
graphql#ListCarriers
List carriers
curl --request POST \
  --url 'https://clarus-api.com/graphql#ListCarriers' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: CarrierFilterType) { carriers { all(filter: $filter) { edges { node { id code name description active carrier_type carrier_externally_registered } } } } }"
}
'
{
  "data": {
    "carriers": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "5",
              "code": "DHL",
              "name": "DHL Express",
              "description": "DHL international courier",
              "active": true,
              "carrier_type": "custom",
              "carrier_externally_registered": false
            }
          }
        ]
      }
    }
  }
}

​
Query Structure

query($filter: CarrierFilterType) {
  carriers {
    all(filter: $filter) {
      edges {
        node {
          id
          code
          name
          description
          active
          carrier_type
          carrier_externally_registered
        }
      }
    }
  }
}

​
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

FilterInput TypeOperatorsDescription
codeStringInputTypeeq, ilike, like, in, betweenCarrier code
nameStringInputTypeeq, ilike, like, in, betweenCarrier name
activeBooleanInputTypeeqWhether the carrier is active
carrier_typeStringInputTypeeq, ilike, like, in, betweenCarrier type identifier
carrier_externally_registeredBooleanInputTypeeqWhether the carrier is registered with an external system
external_system_reference1StringInputTypeeq, ilike, like, in, betweenExternal system reference
created_atDatetimeInputTypeeq, from, to, betweenCreation timestamp
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: CarrierFilterType) { carriers { all(filter: $filter) { edges { node { id code name description active carrier_type carrier_externally_registered } } } } }"

​
variables
object

Query variables including the filter object

Example:
{ "filter": { "code": { "ilike": "DHL" } } }

Response

Successful GraphQL response

​
data
object

Query result data

​
errors
object[]

GraphQL errors, if any