Products endpoint

The products endpoint allows you to search for catalog items.

Query structure

products(
search: String
filter: ProductFilterInput
pageSize: Int
currentPage: Int
sort: ProductSortInput
): Products

Each query attribute is defined below:

ProductFilterInput object

The ProductFilterInput object 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. The following example filter searches for products that has a sku that contains the string 24-MB with a price that’s less than 50.

filter: {
       sku: {like: "24-MB%"}
       price: {lt: "50"}
       }

See Searches and pagination in GraphQL for more information about the operators.

Magento processes the attribute values specified in a ProductFilterInput as simple data types (strings, integers, booleans). However, returned attributes can be a different, complex, data type. For example, in a response, price is an object that contains a monetary value and a currency code.

The following attributes can be used to create filters. See the Response section for information about each attribute.

category_ids
country_of_manufacture
created_at
custom_design
custom_design_from
custom_design_to
custom_layout
custom_layout_update
description
gift_message_available
has_options
image
image_label
manufacturer
max_price
meta_description
meta_keyword
meta_title
min_price
name
news_from_date
news_to_date
options_container
or
page_layout
price
required_options
short_description
sku
small_image
small_image_label
special_from_date
special_price
special_to_date
thumbnail
thumbnail_label
tier_price
updated_at
weight

Response

The system returns a Products object containing the following information:

items: [ProductInterface]
page_info: SearchResultPageInfo
total_count: Int
filters: [LayerFilter]

Each attribute is described below:

ProductInterface

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
  • BundleProduct
  • ConfigurableProduct
  • DownloadableProduct
  • GroupedProduct

The following table defines the ProductInterface attributes and objects.

ProductPrices object

The ProductPrices object 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.

Price object

The Price object defines the price of a product as well as any tax-related adjustments.

Money object

A Money object defines a monetary value, including a numeric value and a currency code.

PriceAdjustment array

The PricedAdjustment object 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.

ProductLinks object

ProductLinks contains information about linked products, including the link type and product type of each item.

MediaGalleryEntry object

MediaGalleryEntry defines characteristics about images and videos associated with a specific product.

ProductMediaGalleryEntriesContent object

ProductMediaGalleryEntriesContent contains an image in base64 format and basic information about the image.

ProductMediaGalleryEntriesVideoContent object

ProductMediaGalleryEntriesVideoContent contains a link to a video file and basic information about the video.

ProductTierPrices object

The ProductTierPrices object defines a tier price, which is a quantity discount offered to a specific customer group.

PhysicalProductInterface

PhysicalProductInterfacedefines the weight of all tangible products.

LayerFilter object

The LayerFilter object can be returned in a response to help create layered navigation on your app.

LayerFilterItemInterface

LayerFilterItemInterface contains an array of items that match the terms defined in the filter.

Sample query

You can review several general interest products queries at Searches and pagination in GraphQL.

The following query returns layered navigation for products that have a sku containing the string 24-WB.

{
    products (
        filter: {
            sku: {
                like:"24-WB%"
            }
        }
        pageSize: 20
        currentPage: 1
        sort: {
            name: DESC
        }
    )
    {
        items {
            sku
        }
        filters {
            name
            filter_items_count
            request_var
            filter_items {
                label
                value_string
                items_count
            }
        }
    }
}