ProductVariant Object
Represents a version of a product such as different size or color.
Fields
#
allowBackorders
availableImages
List the product images available for assignment to a variant.When the 'strict_product_image_handling' is enabled:- Only display images owned by the product variant owner.
currency
externalId
externalSource
features
grossRevenue
images
List of product variant images. When 'strict_product_image_handling' is enabled:- Display only the images owned by the product variant owner.
isPriceOverrideAllowed
indicates whether we allow overriding the unit_price of variants in checkout and draft, quote, offer order lines
metadata
List of public metadata items. Can be accessed without permissions.
netRevenue
price
Base price of a product variant. This field is restricted for admins. Use the pricing field to get the public price for customers.
pricing
Lists the storefront variant's pricing, the current price and discounts, only meant for displaying.
privateMetadata
List of private metadata items.Requires proper staff permissions to access.
publishedAt
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)
seller
seoDescription
seoTitle
sku
sortOrderInCollection
Variant sort order in the specific collection. Make sense only as a part of the parent 'collections' query.
weight
Interfaces
#
Also implements Node , ObjectWithMetadata .
Usages
#
References
#
- Field productVariant from Query
- Field variant from WishlistItem
- Field variant from CheckoutLine