Magidoc

ProductVariant
Object

Represents a version of a product such as different size or color.

Fields

#

allowBackorders

attributes

Non-null

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

Non-null

currency

customFields

Non-null

List of custom fields assigned to this product.

description

Non-null

descriptionHtml

Non-null

descriptionJson

Non-null

digitalContent

Digital content for the product variant.

documents

List of documents associated with the product variant.

externalId

externalSource

features

grossRevenue

id

ID !
Non-null

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.

isAvailable

Whether the variant is in stock and visible or not.

isDigital

Non-null

isPriceOverrideAllowed

Non-null

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

isPublished

Non-null

Whether the product variant is published.

isShippingRequired

Non-null

isVisible

Non-null

Whether this variant is visible on the buyer side or not

margin

Gross margin percentage value.

metadata

Non-null

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

name

Non-null

nauticalStockNumber

Non-null

netRevenue

overrideCurrency

Non-null

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

Non-null

List of private metadata items.Requires proper staff permissions to access.

product

Non-null

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)

quantity

Non-null

Quantity of a product available for sale.

quantityAllocated

Quantity allocated for orders.

quantityAvailable

Non-null

Quantity of a product available for sale in one checkout.

quantityOrdered

Total quantity ordered.

requiresQuote

Non-null

seller

seoDescription

seoTitle

size

Product variant size info.

sortOrderInCollection

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

status

Non-null

stockEvents

List of stock events associated with the variant.

stockQuantity

Non-null

Quantity of a product available for sale.

stocks

[ Stock !]

Stocks for the product variant.

subStatus

Non-null

trackInventory

Non-null

updatedAt

Non-null

weight

Interfaces

#

Also implements Node , ObjectWithMetadata .

Usages

#

References

#

  • Field productVariant from Query