AlmondTill/G3N API

NewCollectionInput

input type

Create-input for a Collection. The tenant (org group) is derived SERVER-SIDE from the principal — NEVER supplied here; collectionType is REQUIRED + immutable; a STATIC create refuses predicate/excludedProductIds/sortMode (the NAMED cross-type gate); a DYNAMIC create REQUIRES a predicate (≥1 axis) and stamps sortMode newest when omitted; every predicate/exclusion ref is tenant-scoped server-side and must be ACTIVE.

Fields

FieldTypeRequiredNotes
captionStringnoOptional: when omitted the per-type default applies — the merchant code when given, else 'Collection'; when supplied it must be non-blank.
collectionTypeCollectionType CollectionType!yesThe canned collection kind — immutable after birth.
predicateCollectionPredicateInputnoThe predicate — REQUIRED on dynamic (≥1 axis), REFUSED on static (the NAMED gate).
excludedProductIdsID [ID!]noManual exclusions (at most 256, unique) — dynamic only; each tenant-scoped + active.
sortModeStringnoThe canned sort mode (newest | price-asc | price-desc | manual-pins-first) — dynamic only; defaulted newest.
codeStringnoNo further notes.

Used by