Skip to content
Saleor
Esc
↑↓navigate↵open⌘Jpreview

Schema: Saleor 3.23.43Download SDLUpgrade guides

On this page

CollectionInput Input Type

input CollectionInput {
  isPublished: Boolean
  name: String
  slug: String
  externalReference: String
  description: JSONString
  fullDescription: JSONString
  backgroundImage: Upload
  backgroundImageAlt: String
  seo: SeoInput
  publicationDate: Date @deprecated
  metadata: [MetadataInput!]
  privateMetadata: [MetadataInput!]
}

Fields

isPublished

isPublished · Boolean

Informs whether a collection is published.

name

name · String

Name of the collection.

slug

slug · String

Slug of the collection.

externalReference

externalReference · String

External ID of this collection.

Added in Saleor 3.23

description

description · JSONString

Description of the collection.

Rich text format. For reference see https://editorjs.io/

fullDescription

fullDescription · JSONString

Full description of the collection. Pass null to clear it. Omit to preserve the current value on update.

Rich text format. For reference see https://editorjs.io/

Added in Saleor 3.23

backgroundImage

backgroundImage · Upload

Background image file.

backgroundImageAlt

backgroundImageAlt · String

Alt text for an image.

seo

seo · SeoInput

Search engine optimization fields.

publicationDate

publicationDate · Date

Publication date. ISO 8601 standard.

metadata

metadata · [MetadataInput!]

Fields required to update the collection metadata. Can be read by any API client authorized to read the object it’s attached to.

Warning: never store sensitive information, including financial data such as credit card details.

privateMetadata

privateMetadata · [MetadataInput!]

Fields required to update the collection private metadata. Requires permissions to modify and to read the metadata of the object it’s attached to.

Warning: never store sensitive information, including financial data such as credit card details.

Used by


Schema: Saleor 3.23.43. Download SDL.

Last updated on April 13, 2026

Was this page helpful?