Skip to main content

UpdateProductInput

Changes to a product. Omitted fields stay as they are.

input UpdateProductInput {
baseUOMId: ID
brandId: ID
categoryIds: [ID!]
description: String
id: ID!
imageUrls: [String!]
inventoryUOMId: ID
isTaxExempt: Boolean
name: String
primaryCategoryId: ID
purchaseTaxGroupId: String
purchaseUOMId: ID
salesUOMId: ID
status: ProductStatus
tags: [String!]
taxExemptReason: String
taxGroupId: String
taxRateId: String
variants: [CreateProductVariantInput!]
}

Fields​

UpdateProductInput.baseUOMId ● ID scalar​

The ID of the base unit of measure.

UpdateProductInput.brandId ● ID scalar​

The ID of the brand.

UpdateProductInput.categoryIds ● [ID!] list scalar​

The IDs of the categories the product is in.

UpdateProductInput.description ● String scalar​

What the product is.

UpdateProductInput.id ● ID! non-null scalar​

The ID of the product to change.

UpdateProductInput.imageUrls ● [String!] list scalar​

The URLs of the product images.

UpdateProductInput.inventoryUOMId ● ID scalar​

The ID of the unit of measure stock is kept in.

UpdateProductInput.isTaxExempt ● Boolean scalar​

True when the product is exempt from tax.

UpdateProductInput.name ● String scalar​

The name of the product.

UpdateProductInput.primaryCategoryId ● ID scalar​

The ID of the main category.

UpdateProductInput.purchaseTaxGroupId ● String scalar​

The tax group used when buying the product, on purchase orders and supplier bills. An empty string clears it.

UpdateProductInput.purchaseUOMId ● ID scalar​

The ID of the unit of measure used for purchases.

UpdateProductInput.salesUOMId ● ID scalar​

The ID of the unit of measure used for sales.

UpdateProductInput.status ● ProductStatus enum​

The status of the product.

UpdateProductInput.tags ● [String!] list scalar​

Tags on the product.

UpdateProductInput.taxExemptReason ● String scalar​

Why the product is exempt from tax.

UpdateProductInput.taxGroupId ● String scalar​

The ID of the tax group.

UpdateProductInput.taxRateId ● String scalar​

The IDs of the tax rates on the product, as one comma-separated string.

UpdateProductInput.variants ● [CreateProductVariantInput!] list input​

The variants of the product.

Member Of​

updateProduct mutation