Skip to main content
POST
/
graphql#ListPackages
List packages
curl --request POST \
  --url 'https://clarus-api.com/graphql#ListPackages' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: PackageFilterType) { packages { all(filter: $filter) { edges { node { id tracking_number shipment { id reference } storage_unit_type { id code } } } } } }"
}
'
{
  "data": {
    "packages": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "4821",
              "tracking_number": "1Z999AA10123456784",
              "shipment": {
                "id": "1530",
                "reference": "SHP-2026-001530"
              },
              "storage_unit_type": {
                "id": "12",
                "code": "EUROPALLET"
              }
            }
          }
        ]
      }
    }
  }
}

​
Query Structure

query($filter: PackageFilterType) {
  packages {
    all(filter: $filter) {
      edges {
        node {
          id
          tracking_number
          shipment {
            id
            reference
          }
          storage_unit_type {
            id
            code
          }
        }
      }
    }
  }
}

​
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": {
    "shipment_id": {
      "eq": "value"
    }
  }
}

​
Available Filters

FilterInput TypeOperatorsDescription
shipment_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledShipment ID
shipment_referenceStringInputTypeeq, ilike, like, in, betweenShipment reference
storage_unit_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledStorage unit ID
storage_unit_type_codeStringInputTypeeq, ilike, like, in, betweenStorage unit type code
tracking_numberStringInputTypeeq, ilike, like, in, betweenCarrier tracking number
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: PackageFilterType) { packages { all(filter: $filter) { edges { node { id tracking_number shipment { id reference } storage_unit_type { id code } } } } } }"

​
variables
object

Query variables including the filter object

Example:
{
  "filter": { "tracking_number": { "ilike": "1Z" } }
}

Response

Successful GraphQL response

​
data
object
​
errors
object[]