Description

Modify one category.

At the moment modification is limited to single category at a time due to implementation complexity. E.g. it's possible to re-parent categories, doing a transactional re-parenting of multiple categories is complicated and error prone.

Permission bit: "categories.modify"

Topic: Categories

Arguments

data: [CategoryModify!]!

Main argument for mutations.

ids: [String!]!

List of category ids. See also: Unique Identifiers

Example: ["ca_EQzGqWoY"]

shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"

Data Argument Fields

custom_fields: [CustomFieldCreate!]

featured: Boolean

States whether or not the category is featured

Example: false

handle: String

An URL-friendly unique string for the category automatically generated from its title

Example: "ipods"

Valid when: handle is not empty

Valid when: handle's length doesn't exceed 250 characters

image_file_ids: [String!]

meta_description: String

Meta description for SEO purposes

Translatable

Valid when: meta_description's length doesn't exceed 160 characters

meta_title: String

SEO-friendly title of the category

Translatable

Valid when: meta_title's length doesn't exceed 60 characters

parent_id: String

Parent category ID, specify it to create a nested category

Example: "ca_EQzGqWoY"

Valid when: parent_id matches regexp pattern: ^ca_

published: Boolean

Whether server thinks category is published or not (depends on server time)

Example: false

published_at: String

The date and time when the category was published or null

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)

raw_content: String

Raw content of the category

Translatable

Example: "{}"

Valid when: raw_content's length doesn't exceed 100000 characters

sort_order: CategorySortOrder

The default order in which products in the category appear

title: String

The name of the category

Translatable

Example: "IPods"

Valid when: title is not empty

Valid when: title's length doesn't exceed 250 characters

Result

[Category!]

Preview (typescript)

Loading module