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

Schema: Saleor 3.23.43Download SDLUpgrade guides

On this page

CategoryInput Input Type

input CategoryInput {
  description: JSONString
  name: String
  slug: String
  externalReference: String
  seo: SeoInput
  fullDescription: JSONString
  backgroundImage: Upload
  backgroundImageAlt: String
  metadata: [MetadataInput!]
  privateMetadata: [MetadataInput!]
}

Fields

description

description · JSONString

Category description.

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

name

name · String

Category name.

slug

slug · String

Category slug.

externalReference

externalReference · String

External ID of this category.

Added in Saleor 3.23

seo

seo · SeoInput

Search engine optimization fields.

fullDescription

fullDescription · JSONString

Full description of the category. 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 a product media.

metadata

metadata · [MetadataInput!]

Fields required to update the category 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 category 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?