List locations
curl --request POST \
--url 'https://clarus-api.com/graphql#ListLocations' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"query": "query($filter: LocationsFilterType) { locations { all(filter: $filter) { edges { node { id code description active is_pickface zone aisle row column slot walk_sequence warehouse { id code name } } } } } }"
}
'import requests
url = "https://clarus-api.com/graphql#ListLocations"
payload = { "query": "query($filter: LocationsFilterType) { locations { all(filter: $filter) { edges { node { id code description active is_pickface zone aisle row column slot walk_sequence warehouse { id code name } } } } } }" }
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: LocationsFilterType) { locations { all(filter: $filter) { edges { node { id code description active is_pickface zone aisle row column slot walk_sequence warehouse { id code name } } } } } }'
})
};
fetch('https://clarus-api.com/graphql#ListLocations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"locations": {
"all": {
"edges": [
{
"node": {
"id": "1",
"code": "A-01-01-01",
"description": "Aisle A, Row 1, Column 1, Slot 1",
"active": true,
"is_pickface": false,
"zone": "A",
"aisle": "01",
"row": "01",
"column": "01",
"slot": "01",
"walk_sequence": 1,
"warehouse": {
"id": "1",
"code": "WH1",
"name": "Main Warehouse"
}
}
}
]
}
}
}
}{
"error": "<string>"
}Locations
List locations
Retrieve warehouse locations using GraphQL. Supports filtering by code, type, zone, and warehouse.
POST
/
graphql#ListLocations
List locations
curl --request POST \
--url 'https://clarus-api.com/graphql#ListLocations' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"query": "query($filter: LocationsFilterType) { locations { all(filter: $filter) { edges { node { id code description active is_pickface zone aisle row column slot walk_sequence warehouse { id code name } } } } } }"
}
'import requests
url = "https://clarus-api.com/graphql#ListLocations"
payload = { "query": "query($filter: LocationsFilterType) { locations { all(filter: $filter) { edges { node { id code description active is_pickface zone aisle row column slot walk_sequence warehouse { id code name } } } } } }" }
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: LocationsFilterType) { locations { all(filter: $filter) { edges { node { id code description active is_pickface zone aisle row column slot walk_sequence warehouse { id code name } } } } } }'
})
};
fetch('https://clarus-api.com/graphql#ListLocations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"locations": {
"all": {
"edges": [
{
"node": {
"id": "1",
"code": "A-01-01-01",
"description": "Aisle A, Row 1, Column 1, Slot 1",
"active": true,
"is_pickface": false,
"zone": "A",
"aisle": "01",
"row": "01",
"column": "01",
"slot": "01",
"walk_sequence": 1,
"warehouse": {
"id": "1",
"code": "WH1",
"name": "Main Warehouse"
}
}
}
]
}
}
}
}{
"error": "<string>"
}Query Structure
query($filter: LocationsFilterType) {
locations {
all(filter: $filter) {
edges {
node {
id
code
description
active
is_pickface
zone
aisle
row
column
slot
walk_sequence
warehouse {
id
code
name
}
}
}
}
}
}
Filter Argument
All filters are passed inside thefilter argument. Each filter field accepts an input object with operators:
{
"filter": {
"code": {
"ilike": "A-01"
}
}
}
Available Filters
| Filter | Input Type | Operators | Description |
|---|---|---|---|
code | StringInputType | eq, ilike, like, in, between | Location code |
aisle | StringInputType | eq, ilike, like, in, between | Location aisle |
warehouse_code | StringInputType | eq, ilike, like, in, between | Filter by warehouse code |
zone | StringInputType | eq, ilike, like, in, between | Location zone |
storage_unit_type_id | IdInputType | eq, gt, gteq, lt, lteq, in, filled | Filter by storage unit type |
walk_sequence | IntegerInputType | eq, gt, gteq, lt, lteq, between | Pick walk sequence |
Filter Operators
| Input Type | Operators |
|---|---|
| StringInputType | eq (exact), ilike (case-insensitive partial), like (case-sensitive partial), in (array match), between (range) |
| IntegerInputType | eq, gt, gteq, lt, lteq, between |
| DatetimeInputType | eq, from, to, between |
| BooleanInputType | eq (required) |
| IdInputType | eq, gt, gteq, lt, lteq, in, filled |
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: LocationsFilterType) { locations { all(filter: $filter) { edges { node { id code description active is_pickface zone aisle row column slot walk_sequence warehouse { id code name } } } } } }"
Query variables including the filter object
Show child attributes
Show child attributes
Example:
{ "filter": { "code": { "ilike": "A-01" } } }