ChemPal Documentation - v0.0.13-beta.5
    Preparing search index...

    Interface Magento2ProductItem

    A single product item in the Magento 2 GraphQL products.items array. The __typename field discriminates between the concrete product types (Simple, Grouped, Configurable, Bundle), with items/variants populated for the relevant types.

    const item: Magento2ProductItem = {
      __typename: "GroupedProduct",
      uid: "MTAxMzkwMA==",
      sku: "S770339",
      name: "Sodiumthiophosphatedodecahydrate",
      url_key: "sodiumthiophosphatedodecahydrate-aladdin-scientific-s770339",
      url_suffix: ".html",
      stock_status: "IN_STOCK",
      quantity: null,
      price_range: {
        minimum_price: { regular_price: { value: 9.9, currency: "USD" }, final_price: { value: 9.9, currency: "USD" } },
        maximum_price: { regular_price: { value: 229.9, currency: "USD" }, final_price: { value: 229.9, currency: "USD" } }
      },
      items: []
    };
    interface Magento2ProductItem {
        __typename: string;
        uid: string;
        sku: string;
        name: string;
        url_key: string;
        url_suffix?: null | string;
        stock_status: string;
        quantity?: null | number;
        only_x_left_in_stock?: null | number;
        price_range: Magento2PriceRange;
        price_tiers?: Magento2PriceTier[];
        short_description?: null | Magento2ComplexText;
        description?: null | Magento2ComplexText;
        image?: null | Magento2Image;
        categories?: null | Magento2Category[];
        items?: Magento2GroupedItem[];
        variants?: Magento2ConfigurableVariant[];
    }
    Index

    Properties

    __typename uid sku name url_key url_suffix? stock_status quantity? only_x_left_in_stock? price_range price_tiers? short_description? description? image? categories? items? variants?

    Properties

    __typename

    __typename: string

    GraphQL type name discriminator

    uid: string

    Magento UID of the product

    sku: string

    Parent SKU of the product

    name: string

    Display name of the product

    url_key: string

    URL slug used to build the product page URL

    url_suffix?: null | string

    Optional URL suffix (e.g. ".html") that completes the product URL

    stock_status: string

    Stock status string (e.g. "IN_STOCK", "OUT_OF_STOCK")

    quantity?: null | number

    Stock count, if exposed by the storefront

    only_x_left_in_stock?: null | number

    Low-stock indicator from the storefront

    price_range: Magento2PriceRange

    Price range across the product's variants

    price_tiers?: Magento2PriceTier[]

    Quantity-based pricing tiers, if any

    short_description?: null | Magento2ComplexText

    Short HTML description (may be empty)

    description?: null | Magento2ComplexText

    Full HTML description (may be empty)

    image?: null | Magento2Image

    Primary product image

    categories?: null | Magento2Category[]

    Categories the product is assigned to

    items?: Magento2GroupedItem[]

    Sub-products for GroupedProduct items

    variants?: Magento2ConfigurableVariant[]

    Variants for ConfigurableProduct items

    Settings

    Member Visibility

    On This Page

    Properties