AlmondTill/G3N API

NewPromotionInput

input type

Create-input for a Promotion. The tenant (org group) is derived SERVER-SIDE from the principal — NEVER supplied here; free_gift/free_shipping effects refuse by the NAMED deferral gate BEFORE the generic parse; every scope/conditions/effect ref is tenant-scoped server-side and must be ACTIVE; startAt stamps NOW when omitted; priority/exclusive/couponGated default 100/false/false.

Fields

FieldTypeRequiredNotes
captionStringnoOptional: when omitted the per-type default applies — the merchant code when given, else 'Promotion'; when supplied it must be non-blank.
effectPromotionEffectInput PromotionEffectInput!yesNo further notes.
scopePromotionScopeInputnoNo further notes.
productScopePromotionProductScopeInputnoNo further notes.
cartConditionsPromotionCartConditionsInputnoNo further notes.
startAtStringnoThe window start (UTC ISO-8601) — omitted ⇒ stamped NOW; a FUTURE instant is the advance-scheduling arm.
endAtStringnoThe window end (half-open) — omitted ⇒ evergreen; must lie strictly after the (stamped) start.
priorityIntnoResolution ordinal 0..1000000 — omitted ⇒ 100.
exclusiveBooleannoOmitted ⇒ false; TRUE refuses a combinableGroup (incoherent).
combinableGroupStringnoNo further notes.
maxDiscountPerLineMinorIntnoNo further notes.
maxDiscountPerOrderMinorIntnoNo further notes.
totalRedemptionsCapIntnoNo further notes.
couponGatedBooleannoOmitted ⇒ false; TRUE = fires ONLY through an attached trigger Coupon.
codeStringnoNo further notes.

Used by