AlmondTill/G3N API

On this page

doomProduct

mutation · in the family Product

What it does

Permanently retire a product — the sellable middle of a family.

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

Product Product! — Parent = its Style (NOT the family root — the spine containment). The declared SEGMENT constrains any subset of the scheme dimensions (omitted dims unconstrained; empty = the WHOLE style); declared sibling overlap is ALLOWED — disjointness is enforced at the CELL. Money amounts are strict decimal STRINGS (no float ever, no arithmetic); rrp is REQUIRED with at least one entry and floor-gated under live selections.

Example request

mutation ExampleDoomProduct($id: ID!, $revision: ID!, $reason: String) {
  doomProduct(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    tagIds
    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": {
    "doomProduct": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "PD-EXMP-0000-000F",
      "type": "Product",
      "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",
      "tagIds": [
        "01900000-0000-7000-8000-decd62770000"
      ],
      "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