Skip to main content
POST
/
graphql#ListGoodsOuts
List goods out orders
curl --request POST \
  --url 'https://clarus-api.com/graphql#ListGoodsOuts' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: GoodsOutsFilterType) { goods_outs { all(filter: $filter) { edges { node { id reference priority expected_date_of_dispatch goods_out_status { code name } account { id code } warehouse { id code } carrier { id code } } } } } }"
}
'
{
  "data": {
    "goods_outs": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "1",
              "reference": "SO-001",
              "priority": 1,
              "expected_date_of_dispatch": "2026-03-11",
              "goods_out_status": {
                "code": "PENDING",
                "name": "Pending"
              },
              "account": {
                "id": "1",
                "code": "ACME"
              },
              "warehouse": {
                "id": "1",
                "code": "WH1"
              },
              "carrier": {
                "id": "5",
                "code": "DPD"
              }
            }
          }
        ]
      }
    }
  }
}

​
Query Structure

query($filter: GoodsOutsFilterType) {
  goods_outs {
    all(filter: $filter) {
      edges {
        node {
          id
          reference
          priority
          expected_date_of_dispatch
          goods_out_status {
            code
            name
          }
          account {
            id
            code
          }
          warehouse {
            id
            code
          }
          carrier {
            id
            code
          }
        }
      }
    }
  }
}

​
Filter Argument

All filters are passed inside the filter argument. Each filter field accepts an input object with operators: 
{
  "filter": {
    "goods_out_status_code": {
      "eq": "PENDING"
    }
  }
}

​
Available Filters

FilterInput TypeOperatorsDescription
referenceStringInputTypeeq, ilike, like, in, betweenOrder reference
goods_out_status_codeStringInputTypeeq, ilike, like, in, betweenStatus code (DRAFT, PENDING, PICK, ALLOCATED, COMPLETED)
account_idIdInputTypeeq, gt, gteq, lt, lteq, in, filledFilter by account ID
warehouse_idIdInputTypeeq, gt, gteq, lt, lteq, in, filledFilter by warehouse ID
carrier_idIdInputTypeeq, gt, gteq, lt, lteq, in, filledFilter by carrier ID
expected_date_of_dispatchDatetimeInputTypeeq, from, to, betweenExpected dispatch date

​
Filter Operators

Input TypeOperators
StringInputTypeeq (exact), ilike (case-insensitive partial), like (case-sensitive partial), in (array match), between (range)
IntegerInputTypeeq, gt, gteq, lt, lteq, between
DatetimeInputTypeeq, from, to, between
BooleanInputTypeeq (required)
IdInputTypeeq, gt, gteq, lt, lteq, in, filled
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: GoodsOutsFilterType) { goods_outs { all(filter: $filter) { edges { node { id reference priority expected_date_of_dispatch goods_out_status { code name } account { id code } warehouse { id code } carrier { id code } } } } } }"

​
variables
object

Query variables including the filter object

Example:
{
  "filter": {
    "goods_out_status_code": { "eq": "PENDING" }
  }
}

Response

Successful GraphQL response

​
data
object

Query result data

​
errors
object[]

GraphQL errors, if any