Skip to main content

ProductUpdateInput

Input type for updating product details

input ProductUpdateInput {
brandId: ID
bulletPoints: [String!]
categoryId: ID @deprecated
colorId: ID @deprecated
compositionLines: [ProductUpdateCompositionLineInput!]
compositionType: CompositionTypeEnum
currencyCode: CurrencyCodeEnum
customsInput: ProductCustomsInput
description: String
height: Decimal
images: [ImageInput!] @deprecated
innerPack: Boolean
innerPackInput: ProductInnerPackInput
length: Decimal
masterCarton: Boolean
masterCartonInput: ProductMasterCartonInput
name: String
packagingUrl: Url
pallet: Boolean
palletInput: ProductPalletInput
parentId: ID
partNumber: String
price: Decimal @deprecated
priceMap: BigDecimal
priceMsrp: BigDecimal
productAttributes: [ProductUpdateAttributeInput!]
productEconomics: ProductEconomicsInput
productId: ID!
productTags: [ProductUpdateTagInput!]
productType: ProductTypeEnum
purchasingInput: ProductPurchasingInput @deprecated
restockThreshold: Int
ship: Boolean
shippingInput: ProductShippingInput
sizeId: ID @deprecated
sku: String
sourcingMethod: ProductSourcingMethodEnum
specsUrl: Url
status: ProductStatusEnum @deprecated
styleId: ID @deprecated
uom: ProductUomEnum
upc: String
updatedImages: [ProductUpdateImageInput!]
weight: Decimal
width: Decimal
}

Fields

ProductUpdateInput.brandId ● ID scalar common

The ID of the brand to which this product belongs. If not provided, the current brand will be used.

ProductUpdateInput.bulletPoints ● [String!] list scalar common

The bullet points for this product. Bullet points are used to describe the product on the website.

ProductUpdateInput.categoryId ● ID deprecated scalar common

DEPRECATED

Use productAttributes instead. This argument will be removed in the future.

ProductUpdateInput.colorId ● ID deprecated scalar common

DEPRECATED

Use productAttributes instead. This argument will be removed in the future.

ProductUpdateInput.compositionLines ● [ProductUpdateCompositionLineInput!] list input products

Composition lines to manage inline. Supports create, update, and delete operations.

ProductUpdateInput.compositionType ● CompositionTypeEnum enum products

Indicates the grouping nature for this composed product

ProductUpdateInput.currencyCode ● CurrencyCodeEnum enum common

ProductUpdateInput.customsInput ● ProductCustomsInput input products

ProductUpdateInput.description ● String scalar common

ProductUpdateInput.height ● Decimal scalar common

ProductUpdateInput.images ● [ImageInput!] deprecated list input products

DEPRECATED

Will be removed in the future. Use the argument updatedImages instead.`

Replaces all product images with the provided ones. The argument is ignored if updatedImages is provided.

ProductUpdateInput.innerPack ● Boolean scalar common

Whether this product has an inner pack. If true, the inner pack data must be provided.

ProductUpdateInput.innerPackInput ● ProductInnerPackInput input products

ProductUpdateInput.length ● Decimal scalar common

ProductUpdateInput.masterCarton ● Boolean scalar common

Whether this product has a master carton. If true, the master carton data must be provided.

ProductUpdateInput.masterCartonInput ● ProductMasterCartonInput input products

ProductUpdateInput.name ● String scalar common

ProductUpdateInput.packagingUrl ● Url scalar common

ProductUpdateInput.pallet ● Boolean scalar common

Whether this product has a pallet. If true, the pallet data must be provided.

ProductUpdateInput.palletInput ● ProductPalletInput input products

ProductUpdateInput.parentId ● ID scalar common

The ID of the parent product. If provided, this product will be a variant of the parent product.

ProductUpdateInput.partNumber ● String scalar common

ProductUpdateInput.price ● Decimal deprecated scalar common

DEPRECATED

Will be removed in the future. Use the argument priceMsrp instead.

ProductUpdateInput.priceMap ● BigDecimal scalar common

ProductUpdateInput.priceMsrp ● BigDecimal scalar common

ProductUpdateInput.productAttributes ● [ProductUpdateAttributeInput!] list input products

Product attributes to update. Use ID or attributeHandle to reference the attribute to update.

ProductUpdateInput.productEconomics ● ProductEconomicsInput input products

ProductUpdateInput.productId ● ID! non-null scalar common

ProductUpdateInput.productTags ● [ProductUpdateTagInput!] list input products

ProductUpdateInput.productType ● ProductTypeEnum enum products

The type of product.

ProductUpdateInput.purchasingInput ● ProductPurchasingInput deprecated input products

DEPRECATED

Will be removed in the future. Use the productEconomics argument instead.

ProductUpdateInput.restockThreshold ● Int scalar common

ProductUpdateInput.ship ● Boolean scalar common

Whether this product is shippable. If false, the product will not be available for purchase.

ProductUpdateInput.shippingInput ● ProductShippingInput input products

ProductUpdateInput.sizeId ● ID deprecated scalar common

DEPRECATED

Use productAttributes instead. This argument will be removed in the future.

ProductUpdateInput.sku ● String scalar common

ProductUpdateInput.sourcingMethod ● ProductSourcingMethodEnum enum products

ProductUpdateInput.specsUrl ● Url scalar common

ProductUpdateInput.status ● ProductStatusEnum deprecated enum products

DEPRECATED

This argument will be removed in the future. Use archive/unarchive mutations to change product status.

ProductUpdateInput.styleId ● ID deprecated scalar common

DEPRECATED

Use productAttributes instead. This argument will be removed in the future.

ProductUpdateInput.uom ● ProductUomEnum enum products

ProductUpdateInput.upc ● String scalar common

ProductUpdateInput.updatedImages ● [ProductUpdateImageInput!] list input products

ProductUpdateInput.weight ● Decimal scalar common

ProductUpdateInput.width ● Decimal scalar common

Member Of

BulkUpdateProductsInput input