AlmondTill/G3N API

On this page

doomOptionValue

mutation · in the family Option value

What it does

Permanently retire one value inside an option group (like “Large” or “Red”).

Doom (terminal) a OptionValue by id; requires the unrestricted capability + the record's CURRENT revision. Deny-by-default + the referential_integrity / authority / occ guards; a doomed OptionValue 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.

Arguments

NameTypeRequiredNotes
idID ID!yesThe id of the record.
revisionID ID!yesThe revision id you read on the record; the change is refused if an edit landed in the meantime.
reasonStringnoNo further notes.

Returns

OptionValue OptionValue! — An option value — one member of an OptionGroup pick-source (a size cell, a color name), ORDERED via ordinal (lower = earlier in the pick list; ties break by id). Parent = its OptionGroup (NOT the family root — the first non-group-parented catalog construct, the Zone shape). Consumed by the spine (scheme tiers pick values into Product/Variant cells).

Example request

mutation ExampleDoomOptionValue($id: ID!, $revision: ID!, $reason: String) {
  doomOptionValue(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    ordinal
    code
  }
}

Variables:

{
  "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

{
  "data": {
    "doomOptionValue": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "OV-EXMP-0000-000F",
      "type": "OptionValue",
      "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",
      "ordinal": 1,
      "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