AlmondTill/G3N API

ProductRelation

object type

A product relation — a TYPED, DIRECTED, RANKED suggestion edge between two Products (alternative | replacement | accessory | upsell | cross-sell — canned, AT-extensible). Parent = the SOURCE Product (relations die with their source); the TARGET is gate-protected from doom while suggested. Directed by design — symmetric intent = create both directions. Relation identity (source x target x relationType) is unique (a live duplicate is CONFLICT/IDENTITY_TAKEN naming the holder; a doomed one is taken over). Variant-level matching is DERIVED at read time — a later read-side slice.

Fields

FieldTypeNotes
idID ID!The record’s id — a UUID the platform assigned when the record was created; every reference to this record uses it.
sysIdString String!The group-scoped human-facing system id (PR-…).
typeString String!The kind of record — always ProductRelation here.
captionString String!The record’s display name — what people see it called.
statusString String!The FSM state: active | inactive | doomed.
parentIdID ID!The parent SOURCE Product; for a ProductRelation parentId!== rootId.
rootIdID ID!The org-group family root.
createdAtString String!When the record was created, as a UTC timestamp.
updatedAtString String!When the record last changed, as a UTC timestamp.
revisionNumInt Int!How many times this record has been edited; the first save is 0.
revisionID ID!The OCC revision token — supply it on every mutation of this record; rotates on every write.
refCaptionsRefCaption [RefCaption!]!The server-composed captions of this record's declared references (the referenced-caption rule) — one row per referenced id; see RefCaption.
targetProductIdID ID!The suggested TARGET Product — set at creation, IMMUTABLE thereafter.
relationTypeString String!The canned relation type — set at creation, IMMUTABLE thereafter.
ordinalInt Int!The suggestion rank. Mutable — reordering is an ordinary edit.

Used by