Search docs
Sign InDescription
Topic: Product Variants
Fields
attachment: File
File attachment for digital good product variants
Expandable
Permission bit: "files.read"
The barcode, UPC or ISBN number for the product
Example: "1234_pink"
bundle_line_items: [BundleLineItem!]!
Items in the bundle
The cost price of the product variant
Example: 150
country_of_origin: InfoCountry
Country of origin (ISO 3166-1 alpha-2)
Expandable
The date and time when the variant was created, RFC 3339 format
Example: "2014-09-04T12:23:34Z"
Timestamp (RFC 3339)
currency_prices: [CurrencyPrice!]!
List of prices specific to currencies
custom_fields: [CustomField!]!
customer_group_prices: [CustomerGroupPrice!]!
List of prices specific to customer groups
Whether discount can be applied to this variant or not
Example: false
Amount of days the product is available for download after purchase (digital product), 0 if not limited
Example: 5
fulfillment_service: FulfillmentService!
Service who is doing the fulfillment
Example: "manual"
The weight of the product variant in grams
Example: 200
Height of the product (in millimeters) used which can be used when calculating shipping costs
Example: 200
Harmonized System (HS) Code
Example: "6404.19"
A unique product variant identifier
Example: "va_EQzGqWoY"
inventory: VariantInventory
Inventory associated with this product variant
Expandable
Permission bit: "variant_inventory.read"
Variant inventory count
Example: 0
inventory_management: InventoryManagement!
Specifies whether or not system tracks the number of items in stock for this product variant
Example: "manual"
inventory_policy: InventoryPolicy!
Specifies whether or not customers are allowed to place an order for a product variant when it's out of stock
Example: "deny"
inventory_summary: InventorySummary
Inventory summary if variant has inventory entries, null otherwise
Whether this variant is a default variant of a product
Example: false
Length of the product (in millimeters) used which can be used when calculating shipping costs
Example: 200
linked_media_files: [MediaFile!]!
Linked media files for this variant. Media files of a closest variant (option-wise) will be provided if variant lacks own media files.
Translatable
The minimum advertised price of the product variant
Example: 190
Maximum number of downloads (digital product), 0 if not limited
Example: 10
media_files: [MediaFile!]!
Media files for this variant
Translatable
Moving average cost calculated from purchase orders
Example: 156
options: [VariantOption!]!
List of options
The order of the product variant in the list of product variants
Example: 0
The price of the product variant
Example: 190
product: Product
Product this variant belongs to
Expandable
Permission bit: "products.read"
The retail cost of the product variant
Example: 190
Special price for a product that can be active during a selected period of time
Example: 120
Whether sale price is eligible or not according to server's idea of time
Example: false
Lower date boundary when sale price is active
Example: "2014-09-04T12:23:34Z"
Timestamp (RFC 3339)
Upper date boundary when sale price is active
Example: "2014-09-04T12:23:34Z"
Timestamp (RFC 3339)
A unique identifier for the product variant in the shop (stock keeping unit)
Example: "IPOD2008PINK"
suppliers: [VariantSupplier!]!
List of suppliers for this variant
Tax class of this variant
Example: "default"
Specifies whether or not a tax is charged when the product variant is sold
Example: true
tiered_pricing: TieredPricing
type: VariantType!
Type of the variant
Example: "physical"
The date and time when the variant was last updated, RFC 3339 format
Example: "2014-09-04T12:23:34Z"
Timestamp (RFC 3339)
Width of the product (in millimeters) used which can be used when calculating shipping costs
Example: 200
Used By
Mutations
productVariantsCreate, productVariantsModify
Queries
Types
BundleLineItem, BuyLinkLineItem, CustomFieldObjects, CustomerFavorite, CustomerInventory, OrderLineItem, Product, ProductVariantPage, ProductVariantSearchResult, Promotion, PromotionCondition, PurchaseOrderLineItem, ReturnLineItem, ReturnPolicyCondition, ShopSettings, Subscription, TransferLineItem, VariantInventory
Preview (typescript)
Loading module