Product interfaces and attributes

Any type that implements ProductInterface contains all the base attributes necessary for the frontend of the product model. The items that are returned in a ProductInterface array can also contain attributes from resources external to the CatalogGraphQl module:

• Custom and extension attributes defined in any attribute set
• The attribute is defined in the PhysicalProductInterface or CustomizableOptionInterface
• Product types that define their own implementation of ProductInterface including:
  • SimpleProduct
  • BundleProduct
  • ConfigurableProduct
  • DownloadableProduct
  • GiftCardProduct
  • GroupedProduct
  • VirtualProduct

Deprecated interfaces

The following interfaces are available only if you have installed the PWA Metapackage for Magento Open Source Extensions. This metapackage has been deprecated.

• AttributeMetadataInterface
• AttributeOptionsInterface, SelectableInputTypeInterface, UiInputTypeInterface

Sample query

The custom_attributesV2 attribute is defined in ProductInterface. In this example, the attribute's filters object determines which custom attributes will be used to narrow the results when using products query. It contains at least one attribute and the value that is being searched for. The following example searches for custom attributes of a product where is_comparable is true.

Copy
{
    products(filter: {sku: {eq: "24-MB02"}})
    {
        items
        {
            custom_attributesV2(filters: {is_comparable: true})                                 {
                items {
                    code
                }
                errors {
                    type
                    message
                }
            }
        }
    }
}
Copied to your clipboard
{
    products(filter: {sku: {eq: "24-MB02"}})
    {
        items
        {
            custom_attributesV2(filters: {is_comparable: true})                                 {
                items {
                    code
                }
                errors {
                    type
                    message
                }
            }
        }
    }
}

Last updated 11/28/2023

Was this helpful?

Yes

No