Skip to main content

UpdateProductInput

Input for updateProduct. Only provided fields change.

input UpdateProductInput {
  id: ID!
  name: String
  description: String
  images: [String!]
  slug: String
  shippable: Boolean
  unitLabel: String
  descriptor: String
  defaultPriceId: ID
  active: Boolean
  metadata: [KeyValueInput!]
}

Fields​

UpdateProductInput.id ● ID! non-null scalar​

ID of the product to update.

UpdateProductInput.name ● String scalar​

Product name, up to 100 characters.

UpdateProductInput.description ● String scalar​

Product description, up to 1000 characters.

UpdateProductInput.images ● [String!] list scalar​

Image URLs of the product (https only), up to 8.

UpdateProductInput.slug ● String scalar​

Short name of the product, unique in the account. A slug another product holds is refused. null clears it.

UpdateProductInput.shippable ● Boolean scalar​

Whether the product is shipped to the buyer.

UpdateProductInput.unitLabel ● String scalar​

Name of one unit of the product, up to 12 characters.

UpdateProductInput.descriptor ● String scalar​

Statement descriptor, up to 25 characters.

UpdateProductInput.defaultPriceId ● ID scalar​

ID of the default price. Must be an active price of this product. null clears it.

UpdateProductInput.active ● Boolean scalar​

Whether the product is active. false archives it.

UpdateProductInput.metadata ● [KeyValueInput!] list input​

Key/value metadata. Replaces the stored metadata as a whole.

Member Of​

updateProduct mutation