CatalogGraphQl
vendor/magento/module-catalog-graph-ql/etc/schema.graphqls
Queries
categories
Return a list of categories that match the specified filter.
Catalog · returns CategoryResult
category
DeprecatedSearch for categories that match the criteria specified in the `search` and `filter` attributes.
Catalog · returns CategoryTree
categoryList
DeprecatedReturn an array of categories based on the specified filters.
Catalog · returns [CategoryTree]
products
Search for products that match the criteria specified in the `search` and `filter` attributes.
Catalog · returns Products
Types
Object types, input types, enums, interfaces, and unions declared (or extended) in this module.
Aggregation
Contains information for each filterable option (such as price, category `UID`, and custom attributes).
AggregationOption
An implementation of `AggregationOptionInterface`.
AggregationOptionInterface
Defines aggregation option fields.
AggregationsCategoryFilterInput
Filter category aggregations in layered navigation.
AggregationsFilterInput
An input object that specifies the filters used in product aggregations.
AttributeEntityTypeEnum
List of all entity types. Populated by the modules introducing EAV entities.
Breadcrumb
Contains details about an individual category that comprises a breadcrumb.
CatalogAttributeApplyToEnum
CatalogAttributeMetadata
Catalog attribute metadata.
CategoryFilterInput
Defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.
CategoryInterface
Contains the full set of attributes that can be returned in a category search.
CategoryProducts
Contains details about the products assigned to a category.
CategoryResult
Contains a collection of `CategoryTree` objects and pagination information.
CategoryTree
Contains the hierarchy of categories.
CustomizableAreaOption
Contains information about a text area that is defined as part of a customizable option.
CustomizableAreaValue
Defines the price and sku of a product whose page contains a customized text area.
CustomizableCheckboxOption
Contains information about a set of checkbox values that are defined as part of a customizable option.
CustomizableCheckboxValue
Defines the price and sku of a product whose page contains a customized set of checkbox values.
CustomizableDateOption
Contains information about a date picker that is defined as part of a customizable option.
CustomizableDateTypeEnum
Defines the customizable date type.
CustomizableDateValue
Defines the price and sku of a product whose page contains a customized date picker.
CustomizableDropDownOption
Contains information about a drop down menu that is defined as part of a customizable option.
CustomizableDropDownValue
Defines the price and sku of a product whose page contains a customized drop down menu.
CustomizableFieldOption
Contains information about a text field that is defined as part of a customizable option.
CustomizableFieldValue
Defines the price and sku of a product whose page contains a customized text field.
CustomizableFileOption
Contains information about a file picker that is defined as part of a customizable option.
CustomizableFileValue
Defines the price and sku of a product whose page contains a customized file picker.
CustomizableMultipleOption
Contains information about a multiselect that is defined as part of a customizable option.
CustomizableMultipleValue
Defines the price and sku of a product whose page contains a customized multiselect.
CustomizableOptionInterface
Contains basic information about a customizable option. It can be implemented by several types of configurable options.
CustomizableProductInterface
Contains information about customizable product options.
CustomizableRadioOption
Contains information about a set of radio buttons that are defined as part of a customizable option.
CustomizableRadioValue
Defines the price and sku of a product whose page contains a customized set of radio buttons.
LayerFilter
Contains information for rendering layered navigation.
LayerFilterItem
LayerFilterItemInterface
MediaGalleryEntry
Defines characteristics about images and videos associated with a specific product.
MediaGalleryInterface
Contains basic information about a product image or video.
PhysicalProductInterface
Contains attributes specific to tangible products.
Price
Deprecated. Use `ProductPrice` instead. Defines the price of a product as well as any tax-related adjustments.
PriceAdjustment
Deprecated. Taxes will be included or excluded in the price. Defines the amount of money to apply as an adjustment, the type of adjustment to apply, and whether the item is included or excluded from the adjustment.
PriceAdjustmentCodesEnum
`PriceAdjustment.code` is deprecated.
PriceAdjustmentDescriptionEnum
`PriceAdjustmentDescriptionEnum` is deprecated. States whether a price adjustment is included or excluded.
PriceRange
Contains the price range for a product. If the product has a single price, the minimum and maximum price will be the same.
PriceTypeEnum
Defines the price type.
ProductAttributeFilterInput
Defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.
ProductAttributeSortInput
Specifies the attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order. It's possible to sort products using searchable attributes with enabled 'Use in Filter Options' option
ProductCustomAttributes
Product custom attributes
ProductDiscount
Contains the discount applied to a product price.
ProductFilterInput
ProductFilterInput is deprecated, use @ProductAttributeFilterInput instead. ProductFilterInput defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.
ProductImage
Contains product image information, including the image URL and label.
ProductInterface
Contains fields that are common to all types of products.
ProductLinks
An implementation of `ProductLinksInterface`.
ProductLinksInterface
Contains information about linked products, including the link type and product type of each item.
ProductMediaGalleryEntriesContent
Contains an image in base64 format and basic information about the image.
ProductMediaGalleryEntriesVideoContent
Contains a link to a video file and basic information about the video.
ProductPrice
Represents a product price.
ProductPrices
Deprecated. Use `PriceRange` instead. Contains the regular price of an item, as well as its minimum and maximum prices. Only composite products, which include bundle, configurable, and grouped products, can contain a minimum and maximum price.
ProductSortInput
Deprecated. Use `ProductAttributeSortInput` instead. Specifies the attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order.
ProductVideo
Contains information about a product video.
Products
Contains the results of a `products` query.
SearchSuggestion
A string that contains search suggestion
SimpleProduct
Defines a simple product, which is tangible and is usually sold in single units or in fixed quantities.
SimpleWishlistItem
Contains a simple product wish list item.
SortField
Defines a possible sort field.
SortFields
Contains a default value for sort fields and all available sort fields.
StoreConfig
Contains information about a store's configuration.
VirtualProduct
Defines a virtual product, which is a non-tangible product that does not require shipping and is not kept in inventory.
VirtualWishlistItem
Contains a virtual product wish list item.
Every Magento dev tool, in one hosted workspace.
Free to sign up. Nothing to install. Drafts, audits, and projects saved across every tool.