Collection
The input fields required to create a collection.
Anchor to FieldsFields
- descriptionHtml (String)
- handle (String)
- id (ID)
- image (ImageInput)
- metafields ([MetafieldInput!])
- products ([ID!])
- redirectNewHandle (Boolean)
- ruleSet (CollectionRuleSetInput)
- seo (SEOInput)
- sortOrder (CollectionSortOrder)
- templateSuffix (String)
- title (String)
- publications ([CollectionPublicationInput!]): deprecated
- Anchor to descriptionHtmldescription•String
Html The description of the collection, in HTML format.
- Anchor to handlehandle•String
A unique human-friendly string for the collection. Automatically generated from the collection's title.
- •ID
Specifies the collection to update or create a new collection if absent. Required for updating a collection.
- Anchor to imageimage•Image
Input The image associated with the collection.
Show input fields
- Anchor to metafieldsmetafields•[Metafield
Input!] The metafields to associate with the collection.
Show input fields
- Anchor to productsproducts•[ID!]
Initial list of collection products. Only valid with
.- Anchor to redirectNewHandleredirect•Boolean
New Handle Default:false Indicates whether a redirect is required after a new handle has been provided. If true, then the old handle is redirected to the new one automatically.
- Anchor to ruleSetrule•Collection
Set Rule Set Input The rules used to assign products to the collection. This is the legacy smart-collection model; use
sourceswithconditionsinstead. Eachrule has an equivalentcondition.Show input fields
- •SEOInput
SEO information for the collection.
Show input fields
- Anchor to sortOrdersort•Collection
Order Sort Order The order in which the collection's products are sorted.
Show enum values
- Anchor to templateSuffixtemplate•String
Suffix The theme template used when viewing the collection in a store.
- Anchor to titletitle•String
The title of the collection. Required for creating a new collection.
- Anchor to publicationspublications•[Collection
Publication Input!] Deprecated Show input fields