ProductVariant

Object

allowBackorders

attributes

List of attributes assigned to this variant.

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.

costPrice

Cost price of the variant.

createdAt

currency

customFields

List of custom fields assigned to this product.

description

descriptionHtml

digitalContent

Digital content for the product variant.

documents

List of documents associated with the product variant.

externalId

externalSource

features

grossRevenue

id

The ID of the object

images

List of product variant images. When 'strict_product_image_handling' is enabled:- Display only the images owned by the product variant owner.

isDigital

isPriceOverrideAllowed

indicates whether we allow overriding the unit_price of variants in checkout and draft, quote, offer order lines

isPublished

Whether the product variant is published.

isShippingRequired

isVisible

Whether this variant is visible on the buyer side or not

margin

Gross margin percentage value.

metadata

List of public metadata items. Can be accessed without permissions.

name

nauticalStockNumber

netRevenue

overrideCurrency

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.

product

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)

quantityAvailable

Quantity of a product available for sale in one checkout.

quantityOrdered

Total quantity ordered.

requiresQuote

sales

List of sales associated with the product.

seller

seoDescription

seoTitle

size

Product variant size info.

sku

sortOrderInCollection

Variant sort order in the specific collection. Make sense only as a part of the parent 'collections' query.

status

stockEvents

List of stock events associated with the variant.

stocks

Stocks for the product variant.

subStatus

trackInventory

updatedAt

vouchers

List of vouchers associated with the product.

weight