product

Requires at least one of the permissions inventory:stock_adjustment:create, inventory:stock_transfer:create, payments:invoice:create, products:product:read, purchase:debit_note:create, purchase:grn:create, purchase:purchase_order:create, purchase:purchase_order:update, sales:quote:create, sales:quote:update, sales:sales_invoice:create, sales:sales_order:create or sales:sales_order:update.

Returns one product with its variants. Fails if the product does not exist. Needs the products read permission, or permission to create or edit a document or stock form that picks products.

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 Product($id: String!) {
  product(id: $id) {
    id
    name
    status
    createdAt
    basePrice
    baseUOMId
    baseUOM {
      id
      code
      colorCode
      name
      pluralName
      createdAt
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query Product($id: String!) {\n  product(id: $id) {\n    id\n    name\n    status\n    createdAt\n    basePrice\n    baseUOMId\n    baseUOM {\n      id\n      code\n      colorCode\n      name\n      pluralName\n      createdAt\n    }\n  }\n}",
  "variables": {
    "id": "string"
  }
}
EOF

Variables:

{
  "id": "string"
}

Response:

{
  "data": {
    "product": {
      "id": "id",
      "name": "string",
      "status": "ACTIVE",
      "createdAt": "2025-01-15T00:00:00Z",
      "basePrice": 0,
      "baseUOMId": "id",
      "baseUOM": {
        "id": "id",
        "code": "string",
        "colorCode": "string",
        "name": "string",
        "pluralName": "string",
        "createdAt": "2025-01-15T00:00:00Z"
      }
    }
  }
}

product(
  id: String!
): Product!

Arguments

product.id ● String! non-null scalar

The ID of the product.

Type

Product object

A product: the master record with its variants, categories, units of measure and stock.