Interface ShopifyVariantNode

Represents a product variant node from the Shopify GraphQL Storefront API.

Example

const variant: ShopifyVariantNode = {
  id: "gid://shopify/ProductVariant/36127200805031",
  title: "Default Title",
  sku: "CHEM-001-500G",
  availableForSale: true,
  weight: 3.0,
  weightUnit: "OUNCES",
  price: { amount: "29.99", currencyCode: "USD" },
  compareAtPrice: null,
  selectedOptions: [{ name: "Title", value: "Default Title" }],
};

interface ShopifyVariantNode {
    id: string;
    title: string;
    sku: null | string;
    availableForSale: boolean;
    weight: number;
    weightUnit: "POUNDS" | "OUNCES" | "GRAMS" | "KILOGRAMS";
    price: ShopifyMoney;
    compareAtPrice: null | ShopifyMoney;
    selectedOptions: { name: string; value: string }[];
    currentlyNotInStock: boolean;
}

Index

Properties

id title sku availableForSale weight weightUnit price compareAtPrice selectedOptions currentlyNotInStock

Properties

id

id: string

Globally unique variant id, e.g. "gid://shopify/ProductVariant/36127200805031"

title

title: string

Display title of the variant (e.g. "Default Title", "500g Bottle")

sku

sku: null | string

Stock Keeping Unit identifier

availableForSale

availableForSale: boolean

Whether the variant is currently available for purchase

weight

weight: number

Numeric weight value

weightUnit

weightUnit: "POUNDS" | "OUNCES" | "GRAMS" | "KILOGRAMS"

Unit of weight measurement

price

price: ShopifyMoney

Selling price

compareAtPrice

compareAtPrice: null | ShopifyMoney

Compare-at (list) price, or null when not on sale

selectedOptions

selectedOptions: { name: string; value: string }[]

The option values selected for this variant

currentlyNotInStock

currentlyNotInStock: boolean

Whether the variant is currently in stock