Skip to main content

UpdateProductInput

Autogenerated input type of UpdateProduct

input UpdateProductInput {
brandId: ID
bulletPoints: [String!]
categoryId: ID @deprecated
clientMutationId: String
colorId: ID @deprecated
compositionLines: [ProductUpdateCompositionLineInput!]
compositionType: CompositionTypeEnum
currencyCode: CurrencyCodeEnum @deprecated
customsInput: ProductCustomsInput
decompositionStrategy: ProductDecompositionStrategyEnum
defaultDropshipUnitCost: BigDecimal
defaultLandedCost: BigDecimal
defaultUnitCost: BigDecimal
description: String
height: Decimal
images: [ImageInput!] @deprecated
includeComponentsInAvailableToSell: Boolean
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​

UpdateProductInput.brandId ● ID scalar common​

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

UpdateProductInput.bulletPoints ● [String!] list scalar common​

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

UpdateProductInput.categoryId ● ID deprecated scalar common​

DEPRECATED

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

UpdateProductInput.clientMutationId ● String scalar common​

A unique identifier for the client performing the mutation.

UpdateProductInput.colorId ● ID deprecated scalar common​

DEPRECATED

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

UpdateProductInput.compositionLines ● [ProductUpdateCompositionLineInput!] list input products​

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

UpdateProductInput.compositionType ● CompositionTypeEnum enum products​

Indicates the grouping nature for this composed product

UpdateProductInput.currencyCode ● CurrencyCodeEnum deprecated enum common​

DEPRECATED

Currency is now derived from the company's operating currency. This argument is ignored.

UpdateProductInput.customsInput ● ProductCustomsInput input products​

UpdateProductInput.decompositionStrategy ● ProductDecompositionStrategyEnum enum products​

Whether this product is decomposed into its components on a fulfillment order. Overrides the fulfillment plan; INHERIT defers to it. Applies to composable products (alias, bundle, base item) and is inert on other types.

UpdateProductInput.defaultDropshipUnitCost ● BigDecimal scalar common​

The price you plan with for direct fulfillment. A supplier drop-ship quote overrides it.

UpdateProductInput.defaultLandedCost ● BigDecimal scalar common​

Cost of the goods delivered to you, inbound charges included. Used for gross margin.

UpdateProductInput.defaultUnitCost ● BigDecimal scalar common​

The price you plan with, for the goods themselves. A purchase order uses a supplier quote when one applies and this when none does.

UpdateProductInput.description ● String scalar common​

UpdateProductInput.height ● Decimal scalar common​

UpdateProductInput.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.

UpdateProductInput.includeComponentsInAvailableToSell ● Boolean scalar common​

Whether buildable component inventory contributes to available-to-sell. Omit to preserve the current value. Null is not accepted.

UpdateProductInput.innerPack ● Boolean scalar common​

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

UpdateProductInput.innerPackInput ● ProductInnerPackInput input products​

UpdateProductInput.length ● Decimal scalar common​

UpdateProductInput.masterCarton ● Boolean scalar common​

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

UpdateProductInput.masterCartonInput ● ProductMasterCartonInput input products​

UpdateProductInput.name ● String scalar common​

UpdateProductInput.packagingUrl ● Url scalar common​

UpdateProductInput.pallet ● Boolean scalar common​

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

UpdateProductInput.palletInput ● ProductPalletInput input products​

UpdateProductInput.parentId ● ID scalar common​

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

UpdateProductInput.partNumber ● String scalar common​

UpdateProductInput.price ● Decimal deprecated scalar common​

DEPRECATED

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

UpdateProductInput.priceMap ● BigDecimal scalar common​

UpdateProductInput.priceMsrp ● BigDecimal scalar common​

UpdateProductInput.productAttributes ● [ProductUpdateAttributeInput!] list input products​

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

UpdateProductInput.productEconomics ● ProductEconomicsInput input products​

UpdateProductInput.productId ● ID! non-null scalar common​

UpdateProductInput.productTags ● [ProductUpdateTagInput!] list input products​

UpdateProductInput.productType ● ProductTypeEnum enum products​

The type of product.

UpdateProductInput.purchasingInput ● ProductPurchasingInput deprecated input products​

DEPRECATED

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

UpdateProductInput.restockThreshold ● Int scalar common​

UpdateProductInput.ship ● Boolean scalar common​

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

UpdateProductInput.shippingInput ● ProductShippingInput input products​

UpdateProductInput.sizeId ● ID deprecated scalar common​

DEPRECATED

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

UpdateProductInput.sku ● String scalar common​

UpdateProductInput.sourcingMethod ● ProductSourcingMethodEnum enum products​

UpdateProductInput.specsUrl ● Url scalar common​

UpdateProductInput.status ● ProductStatusEnum deprecated enum products​

DEPRECATED

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

UpdateProductInput.styleId ● ID deprecated scalar common​

DEPRECATED

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

UpdateProductInput.uom ● ProductUomEnum enum products​

UpdateProductInput.upc ● String scalar common​

UpdateProductInput.updatedImages ● [ProductUpdateImageInput!] list input products​

UpdateProductInput.weight ● Decimal scalar common​

UpdateProductInput.width ● Decimal scalar common​

Member Of​

updateProduct mutation