Skip to main content
POST
/
graphql#ListGoodsOutLines
List goods out lines
curl --request POST \
  --url 'https://clarus-api.com/graphql#ListGoodsOutLines' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: GoodsOutLineFilterType) { goods_out_lines { all(filter: $filter) { edges { node { id order_quantity allocated_quantity pick_quantity dispatch_quantity short_status product { id code } goods_out { id reference } carrier { id } } } } } }"
}
'
{
  "data": {
    "goods_out_lines": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "60781",
              "order_quantity": 100,
              "allocated_quantity": 100,
              "pick_quantity": 100,
              "dispatch_quantity": 0,
              "short_status": "",
              "product": {
                "id": "1024",
                "code": "WIDGET-RED-500"
              },
              "goods_out": {
                "id": "3301",
                "reference": "SO-2026-008812"
              },
              "carrier": {
                "id": "5"
              }
            }
          }
        ]
      }
    }
  }
}

​
Query Structure

query($filter: GoodsOutLineFilterType) {
  goods_out_lines {
    all(filter: $filter) {
      edges {
        node {
          id
          order_quantity
          allocated_quantity
          pick_quantity
          dispatch_quantity
          short_status
          product { id code }
          goods_out { id reference }
          carrier { id }
        }
      }
    }
  }
}

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

​
Available Filters

FilterInput TypeOperatorsDescription
goods_out_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledParent goods out (sales order) ID
product_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledProduct ID
account_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledStock account ID (stock owner)
warehouse_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledWarehouse ID
goods_out_status_codeStatusCodeInputTypeeq, inGoods out status code (enum input — e.g. PICK, ALLOCATED, COMPLETED)
carrier_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledCarrier ID
order_quantityDecimalInputTypeeq, gt, gteq, lt, lteq, betweenOrdered quantity
pick_quantityDecimalInputTypeeq, gt, gteq, lt, lteq, betweenPicked quantity
created_atDatetimeInputTypeeq, from, to, betweenCreation timestamp
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: GoodsOutLineFilterType) { goods_out_lines { all(filter: $filter) { edges { node { id order_quantity allocated_quantity pick_quantity dispatch_quantity short_status product { id code } goods_out { id reference } carrier { id } } } } } }"

​
variables
object

Query variables including the filter object

Example:
{
  "filter": { "goods_out_id": { "eq": "3301" } }
}

Response

Successful GraphQL response

​
data
object

Query result data

​
errors
object[]

GraphQL errors, if any