Types > StorefrontProductVariant
Storefront APITypesStorefrontProductVariant
StorefrontProductVariant

Description

Topic: Product Variants

Fields

barcode: String!

The barcode, UPC or ISBN number for the product

Example: "1234_pink"


bundle_line_items: [StorefrontBundleLineItem!]!

Items in the bundle


country_of_origin: String!

Country of origin (ISO 3166-1 alpha-2)

Example: "US"


created_at: String!

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_price: Int!

Non-zero if customer group price is available for current customer

Example: 190


discountable: Boolean!

Whether discount can be applied to this variant or not

Example: false


expiration_days: Int!

Amount of days the product is available for download after purchase (digital product), 0 if not limited

Example: 5


favorite: StorefrontCustomerFavorite


fulfillment_service: FulfillmentService!

Service who is doing the fulfillment


grams: Int!

The weight of the product variant in grams

Example: 200


height: Int!

Height of the product (in millimeters) used which can be used when calculating shipping costs

Example: 200


hs_code: String!

Harmonized System (HS) Code

Example: "6404.19"


id: String!

A unique product variant identifier

Example: "va_EQzGqWoY"


inventory: StorefrontVariantInventory


inventory_policy: InventoryPolicy!

Specifies whether or not customers are allowed to place an order for a product variant when it's out of stock


is_default: Boolean!

Whether this variant is a default variant of a product

Example: false


length: Int!

Length of the product (in millimeters) used which can be used when calculating shipping costs

Example: 200


linked_media_files: [StorefrontMediaFile!]!

Linked media files for this variant. Media files of a closest variant (option-wise) will be provided if variant lacks own media files.

Translatable


map_price: Int!

The minimum advertised price of the product variant

Example: 190


max_downloads: Int!

Maximum number of downloads (digital product), 0 if not limited

Example: 10


media_files: [StorefrontMediaFile!]!

Media files for this variant

Translatable


options: [VariantOption!]!

List of options


position: Int!

The order of the product variant in the list of product variants

Example: 0


price: Int!

The price of the product variant

Example: 190


product: StorefrontProduct


retail_price: Int!

The retail cost of the product variant

Example: 190


sale_price: Int!

Special price for a product that can be active during a selected period of time

Example: 120


sale_price_eligible: Boolean!

Whether sale price is eligible or not according to server's idea of time

Example: false


sale_price_from: String

Lower date boundary when sale price is active

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)


sale_price_to: String

Upper date boundary when sale price is active

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)


sku: String!

A unique identifier for the product variant in the shop (stock keeping unit)

Example: "IPOD2008PINK"


tax_class: String

Tax class of this variant

Example: "default"


taxable: Boolean!

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


updated_at: String!

The date and time when the variant was last updated, RFC 3339 format

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)


width: Int!

Width of the product (in millimeters) used which can be used when calculating shipping costs

Example: 200


Used By

Queries

storefrontProductVariants

Types

StorefrontBundleLineItem, StorefrontCustomFieldObjects, StorefrontCustomerFavorite, StorefrontCustomerInventory, StorefrontOrderLineItem, StorefrontProduct, StorefrontProductVariantPage, StorefrontReturnLineItem, StorefrontShop, StorefrontSubscription, StorefrontVariantInventory

Preview (typescript)

Loading module