A read-only representation of a product variant with enhanced query capabilities.
Product variants represent different options of a product, such as size, color, or material combinations. This read-only variant provides direct access to variant data without requiring nested product queries, making it ideal for inventory management, variant comparison, and e-commerce catalog displays.
The variant includes both variant-specific information (like SKU, price, and option choices), as well as contextual product information (like product name, visibility, categories) for convenience.
Variant ID.
Whether the variant is visible to site visitors.
Default: true
Stock keeping unit (SKU) for inventory tracking and identification.
The SKU is typically used for inventory management, order fulfillment, and product identification across different systems.
Barcode for the variant, typically used for point-of-sale systems and inventory management.
Common barcode formats include UPC, EAN, and Code 128. The barcode helps with quick product identification and checkout processes.
Product option choices that define this variant.
Each option choice represents a specific selection for a product option (like "Size: Large" or "Color: Red"). An empty list indicates this is the default variant of a product with no managed options.
Pricing information for the variant.
Revenue and cost details for business analytics.
Includes cost, profit, and profit margin calculations.
Returned only when you pass "MERCHANT_DATA" to the fields parameter.
Media associated with the variant.
Typically includes images, videos, or other media files specific to this variant.
Subscription pricing information when the variant is part of subscription plans.
Shows calculated prices after applying subscription discounts to the variant's price.
Returned only when you pass "SUBSCRIPTION_PRICES_INFO" to the fields parameter.
Current inventory and availability status.
Product information for context and convenience.
Includes essential product details like name, visibility, and categories to avoid requiring separate product API calls when working with variants.
Physical properties such as weight and dimensions.
Required when the product type is PHYSICAL.
Digital properties such as downloadable files.
Required when the product type is DIGITAL.