Skip to main content

ProductVariantCreateInput

No description

input ProductVariantCreateInput {
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
stocks: [StockInput!]
externalSource: String
externalId: String
image: Upload
}
Show more ↓

Fields

ProductVariantCreateInput.product ● ID! non-null scalar

Product ID of which type is the variant.

ProductVariantCreateInput.attributes ● [AttributeValueInput!]! non-null input

List of attributes specific to this variant.

ProductVariantCreateInput.customFields ● [AttributeValueInput!] list input

List of custom fields.

ProductVariantCreateInput.costPrice ● PositiveDecimal scalar

Cost price of the variant.

ProductVariantCreateInput.price ● PositiveDecimal scalar

Price of the particular variant.

ProductVariantCreateInput.currency ● String scalar

Currency of the product variant

ProductVariantCreateInput.sku ● String scalar

Stock keeping unit.

ProductVariantCreateInput.overrideCurrency ● Boolean scalar

Whether to override the currency for this product variant

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

ProductVariantCreateInput.seller ● ID scalar

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

ProductVariantCreateInput.seo ● SeoInput input

Search engine optimization fields.

ProductVariantCreateInput.weight ● WeightScalar scalar

Weight of the Product Variant.

ProductVariantCreateInput.name ● String scalar

Name for the variant.

ProductVariantCreateInput.isPublished ● Boolean scalar

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

ProductVariantCreateInput.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)

ProductVariantCreateInput.allowBackorders ● Boolean scalar

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

ProductVariantCreateInput.isShippingRequired ● Boolean scalar

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

ProductVariantCreateInput.isDigital ● Boolean scalar

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

ProductVariantCreateInput.isPriceOverrideAllowed ● Boolean scalar

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

ProductVariantCreateInput.dimensions ● ProductDimensionsInput input

Product dimensions.

ProductVariantCreateInput.stocks ● [StockInput!] list input

Stocks of a product available for sale.

ProductVariantCreateInput.externalSource ● String scalar

The external source identifier of a foreign system (e.g. nautical.fulfillment.shopify) if a product variant originated from that system, used in combination with provided externalId. If submitting externalSource, you must also provide an externalId argument. If these two are provided, the productVariantCreate mutation will attempt to perform an upsert instead of a creation.

ProductVariantCreateInput.externalId ● String scalar

The external ID from a foreign system if a product variant originated from that system, used in combination with provided externalSource. If submitting externalId, you must also provide an externalSource argument. If these two are provided, the productVariantCreate mutation will attempt to perform an upsert instead of a creation.

ProductVariantCreateInput.image ● Upload scalar

Initial image to associate with the variant.

Member Of

productVariantCreate mutation

Was this page helpful?