Skip to main content

CollectionUpdateInput

ID Fields are required, but all other fields are optional, only included fields will be updated.

input CollectionUpdateInput {
  collectionId: ID!
  collectionType: String
  contentItemIds: [ID!]
  description: String
  primaryImageUrl: String
  publishedAt: Date
  rules: CollectionRulesInput
  secondaryImageUrl: String
  seoDescription: String
  seoTitle: String
  slug: String
  status: DemandEntityStatus
  storefrontIds: [ID]
  subtitle: String
  tags: [String]
  tertiaryImageUrl: String
  title: String
}

Fields

`CollectionUpdateInput.collectionId` ● `ID!` non-null scalar

`CollectionUpdateInput.collectionType` ● `String` scalar

Any string to declare a category of this collection, can be used to filter collections, limit 128 characters.

`CollectionUpdateInput.contentItemIds` ● `[ID!]` list scalar

The ContentItemIds of the Content Items that are associated with this collection.

`CollectionUpdateInput.description` ● `String` scalar

A short description of the collection, limit 1000 characters.

`CollectionUpdateInput.primaryImageUrl` ● `String` scalar

A primary image url for this collection, can be generated from a Collection ContentItem.

`CollectionUpdateInput.publishedAt` ● `Date` scalar

ISO format date when the collection was published. Note that ensuing updates with status set to PUBLISHED will republish and re-set this date.

`CollectionUpdateInput.rules` ● `CollectionRulesInput` input

A map of rules to determine whether a Product should be part of this Collection.

`CollectionUpdateInput.secondaryImageUrl` ● `String` scalar

A secondary image url for this collection, often a logo or related item.

`CollectionUpdateInput.seoDescription` ● `String` scalar

Description specific for SEO purposes, limit 170 characters.

`CollectionUpdateInput.seoTitle` ● `String` scalar

Title specific for SEO purposes, limit 256 characters.

`CollectionUpdateInput.slug` ● `String` scalar

Slug for the URL for this collection. Limit 128 characters.

`CollectionUpdateInput.status` ● `DemandEntityStatus` enum

The status of the collection, can be DRAFT or PUBLISHED.

`CollectionUpdateInput.storefrontIds` ● `[ID]` list scalar

Which storefronts should have access to this collection?

`CollectionUpdateInput.subtitle` ● `String` scalar

The subtitle of the collection, limit 256 characters.

`CollectionUpdateInput.tags` ● `[String]` list scalar

`CollectionUpdateInput.tertiaryImageUrl` ● `String` scalar

A tertiary image url for this collection, not often used.

`CollectionUpdateInput.title` ● `String` scalar

The title of the collection, limit 256 characters.

Member of

updateCollection mutation

Fields
Member of