grns

Requires permission purchase:grn:list.

Lists goods receipts with optional filters and skip / take paging. Needs the goods receipt (GRN) feature on your plan.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query Grns {
  grns {
    id
    grnNumber
    vehicleNumber
    driverName
    status
    createdAt
    inspector {
      id
      firstName
      lastName
      email
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query Grns {\n  grns {\n    id\n    grnNumber\n    vehicleNumber\n    driverName\n    status\n    createdAt\n    inspector {\n      id\n      firstName\n      lastName\n      email\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "grns": [
      {
        "id": "id",
        "grnNumber": "string",
        "vehicleNumber": "string",
        "driverName": "string",
        "status": "string",
        "createdAt": "2025-01-15T00:00:00Z",
        "inspector": {
          "id": "id",
          "firstName": "string",
          "lastName": "string",
          "email": "string"
        }
      }
    ]
  }
}

grns(
  filter: GRNFilterInput
  skip: Int
  take: Int
): [GRN!]!

Arguments

grns.filter ● GRNFilterInput input

Filter criteria for GRN records. Omit to match all.

grns.skip ● Int scalar

Number of records to skip. Send with take to page through results.

grns.take ● Int scalar

Number of records to return.

Type

GRN object

A goods receipt note: goods received from a vendor into a warehouse, usually against a purchase order.