AlmondTill/G3N API

On this page

deactivateCustomUom

mutation · in the family Custom unit of measure

What it does

Deactivate a custom unit of measure your group defines (a bundle, a crate) — it stops being usable but keeps its history and can be reactivated.

Deactivate a CustomUom 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

CustomUom CustomUom! — A custom unit of measure — a group-defined unit that MUST declare its dimension class + its conversion factor to the class BASE unit (STRICT: convertible by construction, e.g. Bolt = 25 m). The canned UoM registry (cannedUoms — the locked classes + maintained conversions) is registry DATA, not constructs; pack relationships (1 case = 12 each) are NOT UoM conversions. Referenced UoMs cannot be doomed (the guard arms with the Variant stock UoM).

Example request

mutation ExampleDeactivateCustomUom($id: ID!, $revision: ID!, $reason: String) {
  deactivateCustomUom(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    dimensionClass
    factorToBase
    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": {
    "deactivateCustomUom": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "UM-EXMP-0000-000F",
      "type": "CustomUom",
      "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",
      "dimensionClass": "count",
      "factorToBase": 1.5,
      "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