INPUT_OBJECT

ProductFilterInput

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.

link GraphQL Schema definition

  • input ProductFilterInput {
  • # The id - an unique product identifier
  • id: FilterTypeInput
  • # The product name. Customers use this name to identify the product.
  • name: FilterTypeInput
  • # A number or code assigned to a product to identify the product, options, price,
  • # and manufacturer.
  • sku: FilterTypeInput
  • # Detailed information about the product. The value can include simple HTML tags.
  • description: FilterTypeInput
  • # A short description of the product. Its use depends on the theme.
  • short_description: FilterTypeInput
  • # The price of an item.
  • price: FilterTypeInput
  • # The discounted price of the product. Do not include the currency code.
  • special_price: FilterTypeInput
  • # The beginning date that a product has a special price.
  • special_from_date: FilterTypeInput
  • # The end date that a product has a special price.
  • special_to_date: FilterTypeInput
  • # The weight of the item, in units defined by the store.
  • weight: FilterTypeInput
  • # The category this product belongs to
  • category: CategoryBindingFilterInput
  • # A number representing the product's manufacturer.
  • manufacturer: FilterTypeInput
  • # A string that is displayed in the title bar and tab of the browser and in search
  • # results lists.
  • meta_title: FilterTypeInput
  • # A comma-separated list of keywords that are visible only to search engines.
  • meta_keyword: FilterTypeInput
  • # A brief overview of the product for search results listings, maximum 255
  • # characters.
  • meta_description: FilterTypeInput
  • # The relative path to the main image on the product page.
  • image: FilterTypeInput
  • # The relative path to the small image, which is used on catalog pages.
  • small_image: FilterTypeInput
  • # The relative path to the product's thumbnail image.
  • thumbnail: FilterTypeInput
  • # The price when tier pricing is in effect and the items purchased threshold has
  • # been reached.
  • tier_price: FilterTypeInput
  • # The beginning date for new product listings, and determines if the product is
  • # featured as a new product.
  • news_from_date: FilterTypeInput
  • # The end date for new product listings.
  • news_to_date: FilterTypeInput
  • # XML code that is applied as a layout update to the product page.
  • custom_layout_update: FilterTypeInput
  • # The numeric minimal price of the product. Do not include the currency code.
  • min_price: FilterTypeInput
  • # The numeric maximal price of the product. Do not include the currency code.
  • max_price: FilterTypeInput
  • # Category ID the product belongs to.
  • category_ids: FilterTypeInput
  • # If the product has multiple options, determines where they appear on the product
  • # page.
  • options_container: FilterTypeInput
  • # Indicates whether the product has required options.
  • required_options: FilterTypeInput
  • # Indicates whether additional attributes have been created for the product.
  • has_options: FilterTypeInput
  • # The label assigned to a product image.
  • image_label: FilterTypeInput
  • # The label assigned to a product's small image.
  • small_image_label: FilterTypeInput
  • # The label assigned to a product's thumbnail image.
  • thumbnail_label: FilterTypeInput
  • # Timestamp indicating when the product was created.
  • created_at: FilterTypeInput
  • # Timestamp indicating when the product was updated.
  • updated_at: FilterTypeInput
  • # The product's country of origin.
  • country_of_manufacture: FilterTypeInput
  • # The name of a custom layout.
  • custom_layout: FilterTypeInput
  • # Indicates whether a gift message is available.
  • gift_message_available: FilterTypeInput
  • # The product visibility. Customers use this visibility to identify the product.
  • visibility: FilterTypeInput
  • # The product type - simple, configurable, virtual, downloadable, grouped
  • type_id: FilterTypeInput
  • # Is product in stock
  • is_in_stock: FilterTypeInput
  • # Product stock information
  • stock: StockFilterInput
  • # Product status information
  • status: FilterTypeInput
  • # The product size. Customers use this size to identify the product.
  • size: FilterTypeInput
  • # The product sizes for all configurable_children variants. Customers use this
  • # size to identify the product.
  • size_options: FilterTypeInput
  • # The product color. Customers use this color to identify the product.
  • color: FilterTypeInput
  • # The product colors for all configurable_children variants. Customers use this
  • # color to identify the product.
  • color_options: FilterTypeInput
  • # The keyword required to perform a logical OR comparison.
  • or: ProductFilterInput
  • }