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 } } } } }"
}
'import requests
url = "https://clarus-api.com/graphql#ListCarriers"
payload = { "query": "query($filter: CarrierFilterType) { carriers { all(filter: $filter) { edges { node { id code name description active carrier_type carrier_externally_registered } } } } }" }
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: CarrierFilterType) { carriers { all(filter: $filter) { edges { node { id code name description active carrier_type carrier_externally_registered } } } } }'
})
};
fetch('https://clarus-api.com/graphql#ListCarriers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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
}
}
]
}
}
}
}{
"error": "<string>"
}Carriers
List carriers
Retrieve carriers using GraphQL. Supports filtering, sorting, and pagination via relay-style connections.
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 } } } } }"
}
'import requests
url = "https://clarus-api.com/graphql#ListCarriers"
payload = { "query": "query($filter: CarrierFilterType) { carriers { all(filter: $filter) { edges { node { id code name description active carrier_type carrier_externally_registered } } } } }" }
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: CarrierFilterType) { carriers { all(filter: $filter) { edges { node { id code name description active carrier_type carrier_externally_registered } } } } }'
})
};
fetch('https://clarus-api.com/graphql#ListCarriers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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
}
}
]
}
}
}
}{
"error": "<string>"
}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 thefilter 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 | Carrier code |
name | StringInputType | eq, ilike, like, in, between | Carrier name |
active | BooleanInputType | eq | Whether the carrier is active |
carrier_type | StringInputType | eq, ilike, like, in, between | Carrier type identifier |
carrier_externally_registered | BooleanInputType | eq | Whether the carrier is registered with an external system |
external_system_reference1 | StringInputType | eq, ilike, like, in, between | External system reference |
created_at | DatetimeInputType | eq, from, to, between | Creation timestamp |
Authorizations
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
The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.
Body
application/json
GraphQL query string
Example:
"query($filter: CarrierFilterType) { carriers { all(filter: $filter) { edges { node { id code name description active carrier_type carrier_externally_registered } } } } }"
Query variables including the filter object
Show child attributes
Show child attributes
Example:
{ "filter": { "code": { "ilike": "DHL" } } }