AlmondTill/G3N API

On this page

doomSizeRun

mutation · in the family Size run

What it does

Permanently retire a size run — the ratio a buyer spreads a quantity over one option dimension (S-M-L-XL 1-2-2-1), kept once and reused by every style that names it.

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

SizeRun SizeRun! — A size run — a RATIO over ONE option dimension (S-M-L-XL 1-2-2-1; a colour run 2 black: 1 white is equally real — any OptionGroup type may carry a run) a buyer fills a matrix with: kept ONCE and reused on every Style that names it (Style.sizeRunId — its group must be in the scheme) or by the dimension itself (OptionGroup.defaultSizeRunId — the org default lives on the dimension); resolution = the style pick, then the group default, then none (the matrix axes carry the resolved id). optionGroupId is IMMUTABLE at birth (a different dimension is a DIFFERENT run: doom + create — the PurchasePack unitsPerPack stance). entries = 1..256 { optionValueId, share } rows — DISTINCT values OF THAT GROUP, every share an integer 0..10000, the shares summing to at least 1, stored in the CALLER order = the display order (a 0-share value rides the run but never receives a unit). sizeRunFill spreads a total over the ratio by the fill rule (largest remainder, ties to the earlier entry, the quantities summing to the total exactly). Doom is blocked while a non-doomed Style or OptionGroup names the run (CONFLICT/REFERENCED naming the holders); deactivate is free. Group-parented (parentId === rootId); sysId SZ-….

Example request

mutation ExampleDoomSizeRun($id: ID!, $revision: ID!, $reason: String) {
  doomSizeRun(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    optionGroupId
    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": {
    "doomSizeRun": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "SZ-EXMP-0000-000F",
      "type": "SizeRun",
      "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",
      "optionGroupId": "01900000-0000-7000-8000-14f0cf6a0000",
      "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