AlmondTill/G3N API

NewMarkdownPlanInput

input type

Create-input for a MarkdownPlan. The tenant is derived SERVER-SIDE; ⚠ the caption is REQUIRED at the boundary (the CustomerPriceGroup divergence class — a cadence has no natural default; omission refuses VALIDATION/INVALID); the OPEN bound gates the create kit-side. The all-future/base/splice/cap gates are the SCHEDULE transition's — a draft may be authored ahead of its own validity.

Fields

FieldTypeRequiredNotes
captionStringnoOptional: when omitted the per-type default applies — NONE — the divergence: a cadence has no natural default name, so an omitted caption refuses VALIDATION/INVALID at the boundary instead of defaulting; when supplied it must be non-blank.
productScopePromotionProductScopeInput PromotionProductScopeInput!yesThe scope — REQUIRED with ≥1 member.
organizationIdsID [ID!]noThe canned-pool selection — ABSENT = every org in the group.
logicalFacilityIdsID [ID!]noThe explicit LF restriction — ABSENT = all LFs of the selected orgs.
currencyString String!yesThe plan currency (ISO-4217) — every money-bearing move must carry it.
stepsMarkdownStepInput [MarkdownStepInput!]!yes1–8 ordered steps — startAt strictly increasing; endAt on the LAST step only.

Used by