Skip to main content
POST
/
graphql#ListGoodsInReceipts
List goods in receipts
curl --request POST \
  --url 'https://clarus-api.com/graphql#ListGoodsInReceipts' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: InboundGoodFilterType) { goods_in_receipts { all(filter: $filter) { edges { node { id reference status receipt_type expected_date_of_receipt actual_date_of_receipt notes account { id code name } warehouse { id code name } } } } } }"
}
'
{
  "data": {
    "goods_in_receipts": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "1",
              "reference": "GIR-001",
              "status": "receiving",
              "receipt_type": "standard",
              "expected_date_of_receipt": "2026-03-10",
              "actual_date_of_receipt": null,
              "notes": null,
              "account": {
                "id": "1",
                "code": "ACME",
                "name": "Acme Corporation"
              },
              "warehouse": {
                "id": "1",
                "code": "WH1",
                "name": "Main Warehouse"
              }
            }
          }
        ]
      }
    }
  }
}

​
Query Structure

query($filter: InboundGoodFilterType) {
  goods_in_receipts {
    all(filter: $filter) {
      edges {
        node {
          id
          reference
          status
          receipt_type
          expected_date_of_receipt
          actual_date_of_receipt
          notes
          account {
            id
            code
            name
          }
          warehouse {
            id
            code
            name
          }
        }
      }
    }
  }
}

​
Filter Argument

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

​
Available Filters

FilterInput TypeOperatorsDescription
referenceStringInputTypeeq, ilike, like, in, betweenReceipt reference
statusStringInputTypeeq, ilike, like, in, betweenReceipt status (e.g. draft, receiving, completed)
account_idIdInputTypeeq, gt, gteq, lt, lteq, in, filledFilter by account ID
warehouse_idIdInputTypeeq, gt, gteq, lt, lteq, in, filledFilter by warehouse ID
expected_date_of_receiptDatetimeInputTypeeq, from, to, betweenExpected receipt 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: InboundGoodFilterType) { goods_in_receipts { all(filter: $filter) { edges { node { id reference status receipt_type expected_date_of_receipt actual_date_of_receipt notes account { id code name } warehouse { id code name } } } } } }"

​
variables
object

Query variables including the filter object

Example:
{
  "filter": { "status": { "eq": "receiving" } }
}

Response

Successful GraphQL response

​
data
object

Query result data

​
errors
object[]

GraphQL errors, if any