Products > Brands > brandsModify
Commerce APIProductsBrandsbrandsModify
brandsModify
POST:brands.json

Description

Modify one or multiple brands.

Permission bit: "brands.modify"

Topic: Brands

Arguments

data: [BrandModify!]!

Main argument for mutations.


ids: [String!]!

List of brand ids. See also: Unique Identifiers

Example: ["br_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 brand is featured

Example: false


handle: String

An URL-friendly unique string for the brand 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 brand

Translatable

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


published: Boolean

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

Example: false


published_at: String

The date and time when the brand was published or null

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

Timestamp (RFC 3339)


raw_content: String

Raw content of the brand

Translatable

Example: "{}"

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


sort_order: BrandSortOrder

The default order in which products on the brand page are listed


title: String

The name of the brand

Translatable

Example: "IPods"

Valid when: title is not empty

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


website: String

Brand home page

Example: "http://abibas.com"

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


Result

[Brand!]

Preview (typescript)

Loading module