Docs
Dashboard

ProductUpdateInput

Input

The input type for updating an existing product.

#

Fields


categories
[ID!]

The ids of the categories the product belongs to, if you add a product to a sub-category, it will automatically be added to all ancestor categories.

collections
[ID!]

The product’s collections.

description
String

An optional new description.

id
ID!

The primary key of the product.

metadata
[KeyValuePairOfStringAndStringInput!]

Optional key/value metadata for the product.

metafields
[MetafieldInput!]

The metafield values to add or update on the product. Existing metafields not included in the list are preserved. When explicitly specified as null, all assigned product metafields are removed.

name
String

The new name of the product.

slug
String

The new URL-friendly identifier for the product.

status
ProductStatus

The new status of the product.

Possible enum values
  • ACTIVE

    The product is available through published catalog experiences.

  • DRAFT

    The product is retained as a draft and is not published.

tags
[String!]

An optional list of tags.

vendor
String

An optional new vendor name.