# productRelation

query · in the family [Product relation](/reference/product-relation/)

## What it does

Look up one record — a product relationship — “goes with”, “replaces”, “upsell” links between products.

A ProductRelation by id, within the caller's OWN org-group family; requires authentication. A cross-tenant id reads as null (not-found) AND trips the rootId tripwire server-side.

## What happens

Reads only — changes nothing.

## Who may call it

Capability area: **Reading your records** — Looking up and listing the records of your organization.

- Owner
- System Administrator
- Manager
- Associate Manager
- Warehouse Associate
- Sales Associate
- An API key whose scope allows `api:productRelation`

## Arguments

| Name | Type | Required | Notes |
| --- | --- | --- | --- |
| `id` | [ID](/types/#scalars) `ID!` | yes | The id of the record. |

## Returns

[ProductRelation](/types/ProductRelation/) — A product relation — a TYPED, DIRECTED, RANKED suggestion edge between two Products (alternative | replacement | accessory | upsell | cross-sell — canned, AT-extensible). Parent = the SOURCE Product (relations die with their source); the TARGET is gate-protected from doom while suggested. Directed by design — symmetric intent = create both directions. Relation identity (source x target x relationType) is unique (a live duplicate is CONFLICT/IDENTITY_TAKEN naming the holder; a doomed one is taken over). Variant-level matching is DERIVED at read time — a later read-side slice.

## Example request

```graphql
query ExampleProductRelation($id: ID!) {
  productRelation(id: $id) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    targetProductId
    relationType
    ordinal
  }
}
```

Variables:

```json
{
  "id": "01900000-0000-7000-8000-37386ae00000"
}
```

## Example response

```json
{
  "data": {
    "productRelation": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "PR-EXMP-0000-000F",
      "type": "ProductRelation",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "targetProductId": "01900000-0000-7000-8000-5fc8acba0000",
      "relationType": "<relation type>",
      "ordinal": 1
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}
```

## Errors this call can answer

- `VALIDATION/INVALID` — Something in the request is not valid. ([VALIDATION](/errors/VALIDATION/))
- `AUTHN/REQUIRED` — Sign in to do this. ([AUTHN](/errors/AUTHN/))
- `AUTHZ/FORBIDDEN` — Your role does not allow this action. ([AUTHZ](/errors/AUTHZ/))
- `RATE_LIMIT/THROTTLED` — Too many requests in a short time. ([RATE_LIMIT](/errors/RATE_LIMIT/))
- `NOT_FOUND/*` — That record could not be found. ([NOT_FOUND](/errors/NOT_FOUND/))