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

    Module types/magento2

    Interfaces

    Magento2Money

    Money object returned by the Magento 2 GraphQL API. Used wherever a price value is exposed (regular, final, tier prices, etc.).

    Magento2Discount

    Discount applied to a tiered or final price in a Magento 2 GraphQL response.

    Magento2PriceTier

    Bulk-pricing tier on a Magento 2 product. Returned in the price_tiers field for products that offer quantity-based discounts.

    Magento2PriceBound

    Set of regular/final prices for a single bound (minimum or maximum) of a Magento 2 product's price range.

    Magento2PriceRange

    Price range for a Magento 2 product. The minimum and maximum bounds bracket the variant prices for products with multiple variants (Configurable, Grouped). For products with a single price both bounds are identical.

    Magento2Image

    Image returned for a Magento 2 product. Used for image, small_image, thumbnail, and entries in media_gallery.

    Magento2Category

    Category assigned to a Magento 2 product.

    Magento2ComplexText

    Container for HTML-formatted text fields returned by the Magento 2 API (e.g. description, short_description).

    Magento2GroupedItem

    Reference to a sub-product owned by a GroupedProduct. Each grouped item is itself a sellable simple product with its own SKU, name, and price.

    Magento2ConfigurableVariant

    Variant of a ConfigurableProduct. Each variant pairs a set of attribute selections (e.g. size = 100g) with the underlying simple product that gets added to cart when those selections are chosen.

    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.

    Magento2PageInfo

    Pagination metadata returned alongside the Magento 2 product list.

    Magento2SearchResponse

    Top-level shape of a successful Magento 2 GraphQL products query response. The optional errors array carries partial-success errors (e.g. permission denied for individual fields) alongside valid data.