CollectionInput

Show definition
input CollectionInput {
  descriptionHtml: String
  handle: String

  # Specifies the collection to update or create a new collection if absent.
  id: ID
  image: ImageInput

  # Initial list of collection products. Only valid with `productCreate` and without rules.
  products: [ID!]

  # Initial list of collection publications. Only valid with `productCreate`. This
  # argument is deprecated: Use PublishablePublish instead.
  publications: [CollectionPublicationInput!]
  ruleSet: CollectionRuleSetInput
  sortOrder: CollectionSortOrder

  # Required for creating a new collection.
  title: String
  seo: SEOInput

  # 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.
  redirectNewHandle: Boolean = false
}

Input Fields

descriptionHtml   (String)

handle   (String)

id   (ID)

Specifies the collection to update or create a new collection if absent.

image   (ImageInput)

products   ([ID!])

Initial list of collection products. Only valid with productCreate and without rules.

publications   ([CollectionPublicationInput!])

Initial list of collection publications. Only valid with productCreate. This argument is deprecated: Use PublishablePublish instead.

redirectNewHandle   (Boolean)

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   (CollectionRuleSetInput)

seo   (SEOInput)

sortOrder   (CollectionSortOrder)

title   (String)

Required for creating a new collection.