Home > @infiniteobjects/shopify-data-manager > AdminTypes > CollectionInput
The input fields required to create a collection.
Signature:
export interface CollectionInput
| Property | Modifiers | Type | Description |
|---|---|---|---|
| descriptionHtml? | InputMaybe<Scalars[‘String’][‘input’]> | (Optional) The description of the collection, in HTML format. | |
| handle? | InputMaybe<Scalars[‘String’][‘input’]> | (Optional) A unique human-friendly string for the collection. Automatically generated from the collection’s title. | |
| id? | InputMaybe<Scalars[‘ID’][‘input’]> | (Optional) Specifies the collection to update or create a new collection if absent. Required for updating a collection. | |
| image? | InputMaybe<ImageInput> | (Optional) The image associated with the collection. | |
| metafields? | InputMaybe<Array<MetafieldInput>> | (Optional) The metafields to associate with the collection. | |
| products? | InputMaybe<Array<Scalars[‘ID’][‘input’]>> | (Optional) Initial list of collection products. Only valid with collectionCreate and without rules. |
|
| redirectNewHandle? | InputMaybe<Scalars[‘Boolean’][‘input’]> | (Optional) 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. | |
| ruleSet? | InputMaybe<CollectionRuleSetInput> | (Optional) The rules used to assign products to the collection. | |
| seo? | InputMaybe<SeoInput> | (Optional) SEO information for the collection. | |
| sortOrder? | InputMaybe<CollectionSortOrder | `${CollectionSortOrder}`> | (Optional) The order in which the collection’s products are sorted. | |
| templateSuffix? | InputMaybe<Scalars[‘String’][‘input’]> | (Optional) The theme template used when viewing the collection in a store. | |
| title? | InputMaybe<Scalars[‘String’][‘input’]> | (Optional) The title of the collection. Required for creating a new collection. |