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 } } } } } }"
}
'

import requests

url = "https://clarus-api.com/graphql#ListGoodsInReceipts"

payload = { "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 } } } } } }" }
headers = {
    "Authorization": "Bearer <token>",
    "X-Clarus-Subdomain": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Clarus-Subdomain': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    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 } } } } } }'
  })
};

fetch('https://clarus-api.com/graphql#ListGoodsInReceipts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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"
              }
            }
          }
        ]
      }
    }
  }
}

{
  "error": "<string>"
}

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 } } } } } }"
}
'

import requests

url = "https://clarus-api.com/graphql#ListGoodsInReceipts"

payload = { "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 } } } } } }" }
headers = {
    "Authorization": "Bearer <token>",
    "X-Clarus-Subdomain": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Clarus-Subdomain': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    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 } } } } } }'
  })
};

fetch('https://clarus-api.com/graphql#ListGoodsInReceipts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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"
              }
            }
          }
        ]
      }
    }
  }
}

{
  "error": "<string>"
}

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

Filter	Input Type	Operators	Description
`reference`	StringInputType	`eq`, `ilike`, `like`, `in`, `between`	Receipt reference
`status`	StringInputType	`eq`, `ilike`, `like`, `in`, `between`	Receipt status (e.g. draft, receiving, completed)
`account_id`	IdInputType	`eq`, `gt`, `gteq`, `lt`, `lteq`, `in`, `filled`	Filter by account ID
`warehouse_id`	IdInputType	`eq`, `gt`, `gteq`, `lt`, `lteq`, `in`, `filled`	Filter by warehouse ID
`expected_date_of_receipt`	DatetimeInputType	`eq`, `from`, `to`, `between`	Expected receipt date

Filter Operators

Input Type	Operators
StringInputType	`eq` (exact), `ilike` (case-insensitive partial), `like` (case-sensitive partial), `in` (array match), `between` (range)
IntegerInputType	`eq`, `gt`, `gteq`, `lt`, `lteq`, `between`
DatetimeInputType	`eq`, `from`, `to`, `between`
BooleanInputType	`eq` (required)
IdInputType	`eq`, `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.

FlowAuthorization Code

Authorization URL: https://clarus-api.com/oauth/authorize
Token URL: https://clarus-api.com/oauth/token

FlowClient Credentials

Token URL: https://clarus-api.com/oauth/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

Show child attributes

Example:

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

Response

Successful GraphQL response

data

object

Query result data

Show child attributes

errors

object[]

GraphQL errors, if any

​Query Structure

​Filter Argument

​Available Filters

​Filter Operators

Authorizations

Body

Response

Query Structure

Filter Argument

Available Filters

Filter Operators