Skip to main content

ProductVariantInput

No description

input ProductVariantInput {
product: ID
attributes: [AttributeValueInput!]
customFields: [AttributeValueInput!]
costPrice: PositiveDecimal
price: PositiveDecimal
currency: String
sku: String
overrideCurrency: Boolean
trackInventory: Boolean
seller: ID
seo: SeoInput
weight: WeightScalar
name: String
isPublished: Boolean
publishedAt: DateTime
allowBackorders: Boolean
isShippingRequired: Boolean
isDigital: Boolean
isPriceOverrideAllowed: Boolean
dimensions: ProductDimensionsInput
}
Show more ↓

Fields

ProductVariantInput.product ● ID scalar

Product ID of which type is the variant.

ProductVariantInput.attributes ● [AttributeValueInput!] list input

List of attributes specific to this variant.

ProductVariantInput.customFields ● [AttributeValueInput!] list input

List of custom fields.

ProductVariantInput.costPrice ● PositiveDecimal scalar

Cost price of the variant.

ProductVariantInput.price ● PositiveDecimal scalar

Price of the particular variant.

ProductVariantInput.currency ● String scalar

Currency of the product variant

ProductVariantInput.sku ● String scalar

Stock keeping unit.

ProductVariantInput.overrideCurrency ● Boolean scalar

Whether to override the currency for this product variant

ProductVariantInput.trackInventory ● Boolean scalar

Determines whether to track changes to this variant's inventory. If set to 'false', the product's stock quantity won't reduce when a customer purchases this item. However, even when 'false', you must assign a stock quantity to a warehouse to allow checkouts. Usually, this involves allocating a placeholder stock amount that matches the maximum quantity purchased at once.

ProductVariantInput.seller ● ID scalar

Seller that owns the variant. (Only usable with MANAGE_MARKETPLACE permission).

ProductVariantInput.seo ● SeoInput input

Search engine optimization fields.

ProductVariantInput.weight ● WeightScalar scalar

Weight of the Product Variant.

ProductVariantInput.name ● String scalar

Name for the variant.

ProductVariantInput.isPublished ● Boolean scalar

Informs whether a collection is published. All variants are published by default

ProductVariantInput.publishedAt ● DateTime scalar

The datetime when this variant will become available. This field may contain a past, future date or can be empty (so it is always published if isPublished is true)

ProductVariantInput.allowBackorders ● Boolean scalar

Whether to allow backorders for this product variant, if backorders are permitted at the marketplace level

ProductVariantInput.isShippingRequired ● Boolean scalar

Set whether this variant requires shipping by default, will be overridden by product type attached to product if available

ProductVariantInput.isDigital ● Boolean scalar

Set whether this variant is digital by default, will be overridden by product type attached to product if available

ProductVariantInput.isPriceOverrideAllowed ● Boolean scalar

Set whether this variant allows price overrides by default, will be overridden by product type attached to product if available

ProductVariantInput.dimensions ● ProductDimensionsInput input

Product dimensions.

Member Of

productVariantUpdate mutation

Was this page helpful?