Input fields that are required to complete a collection's creation.
Fields
redirectNewHandle ● Boolean
Represents whether a redirect is needed after providing a new handle. If true, the old handle will automatically redirect to the new handle.
The default value is false.
banner ● ImageInput
The banner related to the collection.
More
products ● [ID]
The initial list of products in the collection. Only applicable for collectionCreate and without smart collection rules.
id ● ID
Specify the collection to update, or create a new one if it does not exist. Required for updating the collection.
sortOrder ● CollectionSortOrder
The sorting of products in the collection.
More
descriptionHtml ● String
The collection description.
image ● ImageInput
The image related to the collection.
More
The rules for assigning products to collections.
More
handle ● String
A unique, user-friendly string for the collection, automatically generated based on the collection title.
title ● String!non-null
The collection title, required when creating a collection.
templateSuffix ● String
The template of the theme used for viewing the collection in the store.
Status and error codes
For detailed information about common codes, see Status and error codes.
Was this article helpful to you?