AlmondTill/G3N API

On this page

deactivateOptionGroup

mutation · in the family Option group

What it does

Deactivate an option group — a dimension like Size or Colour that variants vary by — it stops being usable but keeps its history and can be reactivated.

Deactivate a OptionGroup by id; requires the unrestricted capability + the record's CURRENT revision. Deny-by-default + the referential_integrity / authority / occ guards. The optional reason rides the transition events.

Who may call it

Capability area: Catalog editing — Changing what you sell — the details of styles, products, variants and their identifiers.

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

OptionGroup OptionGroup! — An option group — the PICK-SOURCE for option dimensions (a size run, a brand color palette), typed from the canned registry (color/size drive the spine tier defaults; custom groups feed descriptive attributes that never explode variants). Holds ordered OptionValue children (their parent). NO org selection ever. Referenced BY Style schemes at the spine.

Example request

mutation ExampleDeactivateOptionGroup($id: ID!, $revision: ID!, $reason: String) {
  deactivateOptionGroup(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    optionGroupType
    code
    defaultSizeRunId
  }
}

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": {
    "deactivateOptionGroup": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "OP-EXMP-0000-000F",
      "type": "OptionGroup",
      "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",
      "optionGroupType": "color",
      "code": "BJ-001",
      "defaultSizeRunId": "01900000-0000-7000-8000-c20b3cc50000"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer