# doomVariant

mutation · in the family [Variant](/reference/variant/)

## What it does

Permanently retire a variant — the exact sellable thing (the barcode level).

Doom (terminal) a Variant by id; requires the unrestricted capability + the record's CURRENT revision. Deny-by-default + the referential_integrity / authority / occ guards; a doomed Variant is immutable + never deleted. The optional reason rides the transition events.

## Careful

Doom is forever — a doomed record never comes back into use (its history remains readable). Anything still referencing it live will block the doom.

## Who may call it

Capability area: **Catalog structure** — Creating and retiring catalog families and whole items.

- Owner
- Manager
- An API key whose scope allows `api:doomVariant`

## Arguments

| Name | Type | Required | Notes |
| --- | --- | --- | --- |
| `id` | [ID](/types/#scalars) `ID!` | yes | The id of the record. |
| `revision` | [ID](/types/#scalars) `ID!` | yes | The revision id you read on the record; the change is refused if an edit landed in the meantime. |
| `reason` | [String](/types/#scalars) | no | No further notes. |

## Returns

[Variant](/types/Variant/) `Variant!` — A variant — the spine LEAF, the SELLABLE CELL: one complete coordinate of its Style option space (every scheme dimension exactly once) and the SKU bearer (IdentifierEntry lands; inventory). Parent = its Product (NOT the family root). The coordinate is IMMUTABLE at birth — a cell IS its coordinate; re-coordinate = recreate. Cell DISJOINTNESS is the ratified: a per-(style × cell) uniqueness marker minted in the create transaction — a live duplicate is CONFLICT/IDENTITY_TAKEN naming the holding variant AND its product; a doomed holder is taken over. The stock-UoM pair (stockUomKind, stockUomRef) defaults (canned, each) and is IMMUTABLE.

## Example request

```graphql
mutation ExampleDoomVariant($id: ID!, $revision: ID!, $reason: String) {
  doomVariant(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    stockUomKind
    stockUomRef
    code
  }
}
```

Variables:

```json
{
  "id": "01900000-0000-7000-8000-37386ae00000",
  "revision": "01900000-0000-7000-8000-b7960e180000",
  "reason": "Correcting a miscount."
}
```

Send it with the envelope naming the version: `"extensions": {"at": {"version": {"name":"genesis","number":0}}}`.

## Example response

```json
{
  "data": {
    "doomVariant": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "VR-EXMP-0000-000F",
      "type": "Variant",
      "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",
      "stockUomKind": "canned",
      "stockUomRef": "<stock uom ref>",
      "code": "BJ-001"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "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/))
- `CONFLICT/*` — The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. ([CONFLICT](/errors/CONFLICT/))
- `VALIDATION/VERSION_REQUIRED` — The request did not say which app version it came from. ([VALIDATION](/errors/VALIDATION/))