Skip to main content
POST
/
graphql#ListCrossdocks
List crossdocks
curl --request POST \
  --url 'https://clarus-api.com/graphql#ListCrossdocks' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: CrossdockFilterType) { crossdocks { all(filter: $filter) { edges { node { id reference status inbound_method crossdock_type expected_date_of_receipt account { id code } warehouse { id code } } } } } }"
}
'
{
  "data": {
    "crossdocks": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "501",
              "reference": "XD-2026-0042",
              "status": "pending",
              "inbound_method": "delivery",
              "crossdock_type": "external",
              "expected_date_of_receipt": "2026-06-20T09:00:00Z",
              "account": {
                "id": "7",
                "code": "ACME"
              },
              "warehouse": {
                "id": "2",
                "code": "MAIN"
              }
            }
          }
        ]
      }
    }
  }
}

​
Query Structure

query($filter: CrossdockFilterType) {
  crossdocks {
    all(filter: $filter) {
      edges {
        node {
          id
          reference
          status
          inbound_method
          crossdock_type
          expected_date_of_receipt
          account {
            id
            code
          }
          warehouse {
            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": {
    "reference": {
      "ilike": "value"
    }
  }
}

​
Available Filters

FilterInput TypeOperatorsDescription
referenceStringInputTypeeq, ilike, like, in, betweenCrossdock reference
account_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledAccount ID
warehouse_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledWarehouse ID
supplier_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledSupplier ID
carrier_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledCarrier ID
expected_date_of_receiptDatetimeInputTypeeq, from, to, betweenExpected receipt date
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: CrossdockFilterType) { crossdocks { all(filter: $filter) { edges { node { id reference status inbound_method crossdock_type expected_date_of_receipt account { id code } warehouse { id code } } } } } }"

​
variables
object

Query variables including the filter object

Example:
{
  "filter": { "reference": { "ilike": "XD" } }
}

Response

Successful GraphQL response

​
data
object
​
errors
object[]