Product variant, such as a large-size red jacket.
Fields
image ● Image
The image of the variant.
More
product ● String
The unique identifier for the product corresponding to the variant.
inventoryQuantity ● Int
The total inventory quantity at all storage locations.
displayName ● Stringdeprecated
The title of the variant, assembled from option values of the variant.
weight ● String
The weight of the variant. The value is rounded up to two decimal places.
updatedAt ● Datedeprecated
The date and time when the product variant was last updated. Format: ISO 8601.
inventoryTracker ● Stringdeprecated
Indicates whether the inventory tracking is enabled.
  • true: Inventory tracking is enabled.
  • false: Inventory tracking is not enabled.
title ● String
The title of the variant, assembled from the option values of the variant.
createdAt ● Datedeprecated
The creation date and time of the product variant. Format: ISO 8601.
price ● Money
The selling price of the variant. The value is rounded to two decimal places.
More
selectedOptions ● [SelectedOption]
The options of the product variant.
More
weightUnit ● String
The unit of weight for the variant. Valid values are:
  • g: Gram
  • kg: Kilogram
  • lb: Pound
  • oz: Ounce
  • zh_kg: Kilogram
sku ● String
The product SKU.
compareAtPrice ● Money
The original price of the variant. The value is rounded to two decimal places.
More
barcode ● String
The barcode of the variant.
availableForSale ● Boolean
Indicates whether the product variant is available for sale.
  • true: Available for sale.
  • false: Not available for sale.
inventoryPolicy ● ProductVariantInventoryPolicydeprecated
Indicates whether the variant is allowed to be oversold.
More
taxable ● Boolean
Indicates whether the variant is subject to tax.
  • true: Tax is required.
  • false: Tax is not required.
requiresShipping ● Boolean
Indicates whether the variant is required to be shipped.
  • true: Shipping is required.
  • false: Shipping is not required.
metafield ● Metafield
A metafield associated with the product variant.
More
metafields ● [Metafield]
Metafields associated with the product variant.
More
parentProduct ● Product
The parent product object of the product variant.
More
storeAvailability ● StoreAvailabilityConnection
Inventory status of the product variant.
More
requiresSellingPlan ● Boolean
Whether the product variant can only be purchased with a selling plan.
  • true: Can only be purchased with a selling plan.
  • false: Can be purchased not through a selling plan.
sellingPlanAllocations ● SellingPlanAllocationConnection
Selling plan allocations available for the variant.
More
Was this article helpful to you?