grn

Requires permission purchase:grn:read.

Returns one goods receipt by ID. 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 Grn($id: ID!) {
  grn(id: $id) {
    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 Grn($id: ID!) {\n  grn(id: $id) {\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}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "grn": {
      "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"
      }
    }
  }
}

grn(
  id: ID!
): GRN!

Arguments

grn.id ● ID! non-null scalar

The ID of the goods receipt note.

Type

GRN object

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