[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] How do I use the VTEX search graphql app? Provide documentation and configuration details.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/updates/release-notes)

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/basic-components)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/store-components)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/advanced-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.b2b-suite)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/functional-apps)

[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtexarg.abtester)

[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.abandoned-cart-service)

[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.badges)

[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.broadcaster)

[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.catalog-images)

[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.checkout-ui-custom)

[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.checkout-ui-settings)

[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.messages)

[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.product-context)

[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtexbr.pickup-selector)

[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.rewriter)

[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.responsive-values)

[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql)

[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.session-client)

[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.store-icons)

[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.store-sitemap)

[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.telemarketing)

[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/assembly-options-app)

[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/affiliates-program-app)

---

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/layout-apps)

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.my-account)

---

[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/vtex-io-deprecated-apps)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/updates/release-notes)

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/basic-components)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/store-components)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/advanced-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.b2b-suite)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/functional-apps)

[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtexarg.abtester)

[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.abandoned-cart-service)

[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.badges)

[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.broadcaster)

[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.catalog-images)

[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.checkout-ui-custom)

[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.checkout-ui-settings)

[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.messages)

[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.product-context)

[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtexbr.pickup-selector)

[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.rewriter)

[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.responsive-values)

[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql)

[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.session-client)

[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.store-icons)

[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.store-sitemap)

[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.telemarketing)

[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/assembly-options-app)

[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/affiliates-program-app)

---

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/layout-apps)

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.my-account)

---

[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/vtex-io-deprecated-apps)

---

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/vtex-io-apps)

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/guides/functional-apps)

Search GraphQL

Official extension

Version: 0.69.4

Latest version: 0.69.4

This app exports a GraphQL schema for search results on VTEX Stores.

The default implementation for this schema is on [vtex.search-resolver](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/search-resolver) app.

### Usage

To use it in your app, declare it on your `manifest.json` file, as demonstrated below:

`1

"dependencies": {

2

 "vtex.search-graphql": "0.x"

3

}

`

You may then use it in your front end component queries, for example, write file `productQuery.gql`:

`1

query ProductQuery($slug: String) {

2

 product(identifier: { field: slug, value: $slug}) @context(provider: "vtex.search-graphql") {

3

 productName

4

 }

5

}

`

To resolve this query, you need to have an app that implements the schema declared in this app, such as: [vtex.search-resolver](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/search-resolver).

**Table of Contents**
* [Query](#query)
* [Objects](#objects)
   * [AssemblyOption](#assemblyoption)
   * [Attachment](#attachment)
   * [Banners](#banners)
   * [Benefit](#benefit)
   * [BenefitItem](#benefititem)
   * [Brand](#brand)
   * [BrandFacet](#brandfacet)
   * [CategoriesTreeFacet](#categoriestreefacet)
   * [Category](#category)
   * [ClusterHighlight](#clusterhighlight)
   * [CompositionItem](#compositionitem)
   * [CompositionType](#compositiontype)
   * [Correction](#correction)
   * [DeliverySlaPerTypes](#deliveryslapertypes)
   * [DeliverySlaSamples](#deliveryslasamples)
   * [DepartmentFacet](#departmentfacet)
   * [Discount](#discount)
   * [DomainValues](#domainvalues)
   * [Facet](#facet)
   * [FacetValue](#facetvalue)
   * [Facets](#facets)
   * [FilterFacet](#filterfacet)
   * [FilterFacets](#filterfacets)
   * [Gift](#gift)
   * [GiftImage](#giftimage)
   * [Image](#image)
   * [InputValue](#inputvalue)
   * [Installment](#installment)
   * [ItemMetadata](#itemmetadata)
   * [ItemMetadataUnit](#itemmetadataunit)
   * [ItemPriceTable](#itempricetable)
   * [Items](#items)
   * [KitItem](#kititem)
   * [Offer](#offer)
   * [OnlyProduct](#onlyproduct)
   * [PageType](#pagetype)
   * [PriceRange](#pricerange)
   * [PriceRangesFacet](#pricerangesfacet)
   * [PriceTableItem](#pricetableitem)
   * [Product](#product)
   * [ProductClusters](#productclusters)
   * [ProductPriceRange](#productpricerange)
   * [ProductSearch](#productsearch)
   * [ProductSuggestions](#productsuggestions)
   * [Property](#property)
   * [PropertyGroup](#propertygroup)
   * [QueryArgs](#queryargs)
   * [Range](#range)
   * [Recommendation](#recommendation)
   * [Reference](#reference)
   * [Region](#region)
   * [SKU](#sku)
   * [SKUSpecificationField](#skuspecificationfield)
   * [SKUSpecificationValue](#skuspecificationvalue)
   * [SearchBanner](#searchbanner)
   * [SearchBreadcrumb](#searchbreadcrumb)
   * [SearchCorrection](#searchcorrection)
   * [SearchMetadata](#searchmetadata)
   * [SearchSuggestion](#searchsuggestion)
   * [SearchSuggestionAttribute](#searchsuggestionattribute)
   * [SearchSuggestions](#searchsuggestions)
   * [SearchURLStats](#searchurlstats)
   * [SelectedFacet](#selectedfacet)
   * [SelectedProperty](#selectedproperty)
   * [Seller](#seller)
   * [SkuSpecification](#skuspecification)
   * [SpecificationGroup](#specificationgroup)
   * [SpecificationGroupProperty](#specificationgroupproperty)
   * [Suggestions](#suggestions)
   * [Teaser](#teaser)
   * [TeaserCondition](#teasercondition)
   * [TeaserEffects](#teasereffects)
   * [TeaserValue](#teaservalue)
   * [Video](#video)
   * [productSpecification](#productspecification)
* [Inputs](#inputs)
   * [AssemblyOptionInput](#assemblyoptioninput)
   * [Options](#options)
   * [ProductUniqueIdentifier](#productuniqueidentifier)
   * [SelectedFacetInput](#selectedfacetinput)
         * [General filters](#general-filters)
* [Enums](#enums)
   * [CategoryTreeBehavior](#categorytreebehavior)
   * [CrossSelingInputEnum](#crossselinginputenum)
   * [FilterType](#filtertype)
   * [InputValueType](#inputvaluetype)
   * [InstallmentsCriteria](#installmentscriteria)
   * [ItemsFilter](#itemsfilter)
   * [Operator](#operator)
   * [PageEntityIdentifier](#pageentityidentifier)
   * [ProductUniqueIdentifierField](#productuniqueidentifierfield)
   * [SORT](#sort)
   * [SimulationBehavior](#simulationbehavior)
* [Scalars](#scalars)
   * [Boolean](#boolean)
   * [Float](#float)
   * [ID](#id)
   * [Int](#int)
   * [String](#string)
   * [StringOrBoolean](#stringorboolean)

## Query

| Field                             | Argument                                                       | Type                                                                                | Description |
| --------------------------------- | -------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| **product**                       | [Product](#product)                                            | Returns a specified product.                                                                                |             |
| slug                              | [String](#string)                                              | Product slug.                                                                                |             |
| identifier                        | [ProductUniqueIdentifier](#productuniqueidentifier)            | Product identifier.                                                                                |             |
| regionId                          | [String](#string)                                              | Seller ID encoded with base64 according to this format: SW#{sellerId}.                                                                                |             |
| salesChannel                      | [Int](#int)                                                    | Trade Policy.                                                                                |             |
| **banners**                       | [Banners](#banners)                                            | Lists the banners registered for a given query. Check the [configuring banners documentation](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/4ViKEivLJtJsvpaW0aqIQ5) for a full explanation of the banner feature.                                                                                |             |
| fullText                          | [String](#string)                                              | Search term. It can contain any character.                                                                                |             |
| selectedFacets                    | \[[SelectedFacetInput](#selectedfacetinput)\]                  | List of the selected facets. The order in which the terms appear is not relevant to the search. You can also repeat the same facetKey several times for different values.                                                                                |             |
| **correction**                    | [Correction](#correction)                                      | Tries to correct a misspelled term from the search.                                                                                |             |
| fullText                          | [String](#string)                                              | Search term. It can contain any character.                                                                                |             |
| **searchSuggestions**             | [SearchSuggestions](#searchsuggestions)                        | Lists suggested terms similar to the search term.                                                                                |             |
| fullText                          | [String](#string)!                                             | Search term. It can contain any character.                                                                                |             |
| **productSearch**                 | [ProductSearch](#productsearch)                                | Lists the products for a given query.                                                                                |             |
| query                             | [String](#string)                                              | **Deprecated**. Use fullText instead.                                                                                |             |
| fullText                          | [String](#string)                                              | Search term. It can contain any character.                                                                                |             |
| map                               | [String](#string)                                              | **Deprecated**. Use selectedFacets instead.                                                                                |             |
| selectedFacets                    | \[[SelectedFacetInput](#selectedfacetinput)\]                  | List of the selected facets. The order in which the terms appear is not relevant to the search. You can also repeat the same facetKey several times for different values.                                                                                |             |
| category                          | [String](#string)                                              | **Deprecated**. Use selectedFacets instead.                                                                                |             |
| specificationFilters              | \[[String](#string)\]                                          | **Deprecated**. Use selectedFacets instead.                                                                                |             |
| priceRange                        | [String](#string)                                              | Filter by price range. e.g.: {a} TO {b} - {a} is the minimum price "from" and {b} is the highest price "to"                                                                                |             |
| collection                        | [String](#string)                                              | **Deprecated**. Use selectedFacets instead.                                                                                |             |
| salesChannel                      | [String](#string)                                              | Filter by availability at a specific sales channel. e.g.: salesChannel:4 if want filter by available products for the sales channel 4.                                                                                |             |
| orderBy                           | [String](#string)                                              | Sort by a criteria: OrderByPriceDESC/OrderByPriceASC: Price, in descending (DESC) or ascending (ASC) order.OrderByTopSaleDESC: Amount of orders in the past 90 days, in descending order.OrderByReviewRateDESC: Review rates, in descending (DESC) order.OrderByNameASC/OrderByNameDESC: Name, in descending (DESC) or ascending (ASC) alphabetical order.OrderByReleaseDateDESC: Release date, in descending (DESC) order. OrderByBestDiscountDESC: Discount percentage in descending (DESC) order.OrderByScoreDESC: Score, in descending (DESC) order. If you want to sort textually by a specification, use the format {specification key}:{asc\|desc}. For example: material:asc or material:desc. This always sorts values textually (not numerically) and it works only on [vtex.search-resolver@1.x](mailto:vtex.search-resolver@1.x).  |             |
| from                              | [Int](#int)                                                    | Pagination item start. Default value: 0.                                                                                |             |
| to                                | [Int](#int)                                                    | Pagination item end. Default value: 9.                                                                                |             |
| hideUnavailableItems              | [Boolean](#boolean)                                            | If true, uses isAvailablePerSalesChannel\_ parameter on query with segment's sales channel. Will override any given salesChannel argument.                                                                                |             |
| simulationBehavior                | [SimulationBehavior](#simulationbehavior)                      | If you want faster searches and do not care about most up to date prices and promotions, use skip value.                                                                                |             |
| productOriginVtex                 | [Boolean](#boolean)                                            | Each search engine has its own database, but this database might not have all the product information like clusterHighlights or productClusters. As an alternative, the search engine may use the VTEX API to complete this information by setting this field to true.                                                                                |             |
| operator                          | [Operator](#operator)                                          | Indicates how the search engine will deal with the fullText if there is more than one word. Set the value as and if the returned products must have all the words in its metadata. Otherwise, set the value as or.                                                                                |             |
| fuzzy                             | [String](#string)                                              | Indicates how the search engine will correct misspelled words by using fuzzy logic. It can be a number representing the max number of misspelled letters, or the string auto suggesting that the search engine should set this value by itself.                                                                                |             |
| searchState                       | [String](#string)                                              | As fuzzy and operator, it controls the search state, but it is for general purposes. This field allows the search engines to apply features that are not handled by the other fields. The possible values in this field are defined by each search engine.                                                                                |             |
| options                           | [Options](#options)                                            | Search options that customize the search result.                                                                                |             |
| **searchMetadata**                | [SearchMetadata](#searchmetadata)                              |                                                                                |             |
| query                             | [String](#string)                                              | Terms that are used in search, for example eletronics/samsung.                                                                                |             |
| fullText                          | [String](#string)                                              | Text inputted by the user as the search term.                                                                                |             |
| map                               | [String](#string)                                              | Defines term types: Brand, Category, Department. For example: c,b.                                                                                |             |
| selectedFacets                    | \[[SelectedFacetInput](#selectedfacetinput)\]                  | List of the selected facets. The order in which the terms appear is not relevant to the search. You can also repeat the same facetKey several times for different values.                                                                                |             |
| **products**                      | \[[Product](#product)\]                                        | Returns products list filtered and ordered.                                                                                |             |
| query                             | [String](#string)                                              | Terms that are used in search, for example eletronics/samsung.                                                                                |             |
| map                               | [String](#string)                                              | Defines term types: Brand, Category, Department. For example: c,b.                                                                                |             |
| category                          | [String](#string)                                              | Filter by category. For example, {a}/{b}, where {a} and {b} are categoryIds.                                                                                |             |
| specificationFilters              | \[[String](#string)\]                                          | Array of product specification. For example, specificationFilter\_{a}:{b} where {a} is the specificationId, and {b} is the specification value.                                                                                |             |
| priceRange                        | [String](#string)                                              | Filter by price range. For example, {a} TO {b}, where {a} is the minimum price "from" and {b} is the highest price "to".                                                                                |             |
| collection                        | [String](#string)                                              | Filter by collection, also known as productClusterId.                                                                                |             |
| salesChannel                      | [String](#string)                                              | Filter by availability at a specific sales channel, also known as trade policy. For example, salesChannel:4 if you want to filter by available products for the sales channel whose ID is 4.                                                                                |             |
| orderBy                           | [String](#string)                                              | Sort by a criteria: OrderByPriceDESC/OrderByPriceASC: Price, in descending (DESC) or ascending (ASC) order.OrderByTopSaleDESC: Amount of orders in the past 90 days, in descending order.OrderByReviewRateDESC: Review rates, in descending (DESC) order.OrderByNameASC/OrderByNameDESC: Name, in descending (DESC) or ascending (ASC) alphabetical order.OrderByReleaseDateDESC: Release date, in descending (DESC) order. OrderByBestDiscountDESC: Discount percentage in descending (DESC) order.OrderByScoreDESC: Score, in descending (DESC) order.                                                                                |             |
| from                              | [Int](#int)                                                    | Pagination item start. Default value: 0.                                                                                |             |
| to                                | [Int](#int)                                                    | Pagination item end. Default value: 9.                                                                                |             |
| hideUnavailableItems              | [Boolean](#boolean)                                            | If true, uses isAvailablePerSalesChannel\_ parameter on query with segment's sales channel. Will override any given salesChannel argument.                                                                                |             |
| simulationBehavior                | [SimulationBehavior](#simulationbehavior)                      | If you want faster searches and do not care about most up to date prices and promotions, use skip value.                                                                                |             |
| **productRecommendations**        | \[[Product](#product)\]                                        |                                                                                |             |
| identifier                        | [ProductUniqueIdentifier](#productuniqueidentifier)            |                                                                                |             |
| type                              | [CrossSelingInputEnum](#crossselinginputenum)                  |                                                                                |             |
| groupBy                           | [CrossSelingGroupByEnum](#crossselinggroupbyenum)              |                                                                                |             |
| **productsByIdentifier**          | \[[Product](#product)\]                                        |                                                                                |             |
| field                             | [ProductUniqueIdentifierField](#productuniqueidentifierfield)! |                                                                                |             |
| values                            | \[[ID](#id)!\]                                                 |                                                                                |             |
| salesChannel                      | [String](#string)                                              | Filter by availability at a specific sales channel.                                                                                |             |
| **facets**                        | [Facets](#facets)                                              | Returns facets category.                                                                                |             |
| query                             | [String](#string)                                              | **Deprecated**. Use fullText instead.                                                                                |             |
| fullText                          | [String](#string)                                              | Search term. It can contain any character.                                                                                |             |
| map                               | [String](#string)                                              | **Deprecated**. Use selectedFacets instead.                                                                                |             |
| selectedFacets                    | \[[SelectedFacetInput](#selectedfacetinput)\]                  | List of the selected facets. The order in which the terms appear is not relevant to the search. You can also repeat the same facetKey several times for different values.                                                                                |             |
| hideUnavailableItems              | [Boolean](#boolean)                                            | If true, uses isAvailablePerSalesChannel\_ parameter on query with segment's sales channel.                                                                                |             |
| removeHiddenFacets                | [Boolean](#boolean)                                            | If true, remove hidden facets from the result.                                                                                |             |
| behavior                          | [String](#string)                                              | If Static, ignores SpecificationFilters received on the map and query when returning the facets available, which means the facets never change.                                                                                |             |
| operator                          | [Operator](#operator)                                          | Indicates how the search engine will deal with the fullText if there is more than one word. Set the value as and if the returned products must have all the words in its metadata. Otherwise, set the value as or.                                                                                |             |
| fuzzy                             | [String](#string)                                              | Indicates how the search engine will correct misspelled words by using fuzzy logic. It can be a number representing the max number of misspelled letters, or the string auto suggesting that the search engine should set this value by itself.                                                                                |             |
| searchState                       | [String](#string)                                              | As fuzzy and operator, it controls the search state, but it is for general purposes. This field allows the search engines to apply features that are not handled by the other fields. The possible values in this field are defined by each search engine.                                                                                |             |
| from                              | [Int](#int)                                                    | Pagination item start. Default value: 0.                                                                                |             |
| to                                | [Int](#int)                                                    | Pagination item end. Default value: 9.                                                                                |             |
| categoryTreeBehavior              | [CategoryTreeBehavior](#categorytreebehavior)                  | Determines the behavior of the category tree.                                                                                |             |
| initialAttributes                 | [String](#string)                                              | Initial attributes (based on the initialMap parameter).                                                                                |             |
| **autocomplete**                  | [Suggestions](#suggestions)                                    | Get autocomplete suggestions in search.                                                                                |             |
| maxRows                           | [Int](#int)                                                    | Number of items that are returned.                                                                                |             |
| searchTerm                        | [String](#string)                                              | Terms that are used in search, for example iphone.                                                                                |             |
| **topSearches**                   | [SearchSuggestions](#searchsuggestions)                        | Lists the 10 most searched terms.                                                                                |             |
| **autocompleteSearchSuggestions** | [SearchSuggestions](#searchsuggestions)                        | Lists the suggested terms and attributes similar to the search term.                                                                                |             |
| fullText                          | [String](#string)!                                             | Search term. It can contain any character.                                                                                |             |
| **productSuggestions**            | [ProductSuggestions](#productsuggestions)                      | Get product suggestions.                                                                                |             |
| fullText                          | [String](#string)!                                             | Text inputted by the user as the search term.                                                                                |             |
| facetKey                          | [String](#string)                                              | Selected facet key.                                                                                |             |
| facetValue                        | [String](#string)                                              | Selected facet value.                                                                                |             |
| productOriginVtex                 | [Boolean](#boolean)                                            | Each search engine has its own database, but this database might not have all the product information like clusterHighlights or productClusters. As an alternative, the search engine may use the VTEX API to complete this information by setting this field to true.                                                                                |             |
| simulationBehavior                | [SimulationBehavior](#simulationbehavior)                      | If you want faster searches and do not care about most up to date prices and promotions, use skip value.                                                                                |             |
| hideUnavailableItems              | [Boolean](#boolean)                                            | If true, uses isAvailablePerSalesChannel\_ parameter on query with segment's sales channel.                                                                                |             |
| regionId                          | [String](#string)                                              | Seller ID encoded with base64 according to this format: SW#{sellerId}.                                                                                |             |
| salesChannel                      | [Int](#int)                                                    | Sales Channel related to the region ID.                                                                                |             |
| orderBy                           | [String](#string)                                              | Sort by a criteria: OrderByPriceDESC/OrderByPriceASC: Price, in descending (DESC) or ascending (ASC) order.OrderByTopSaleDESC: Amount of orders in the past 90 days, in descending order.OrderByReviewRateDESC: Review rates, in descending (DESC) order.OrderByNameASC/OrderByNameDESC: Name, in descending (DESC) or ascending (ASC) alphabetical order.OrderByReleaseDateDESC: Release date, in descending (DESC) order. OrderByBestDiscountDESC: Discount percentage in descending (DESC) order.OrderByScoreDESC: Score, in descending (DESC) order.  If you want to sort textually by a specification, use the format {specification key}:{asc\|desc}. For example: material:asc or material:desc. This always sorts values textually (not numerically) and it works only on [vtex.search-resolver@1.x](mailto:vtex.search-resolver@1.x). |             |
| **searchURLsCount**               | \[[SearchURLStats](#searchurlstats)\]                          | Get search URLs access stats count.                                                                                |             |
| limit                             | [Int](#int)                                                    | Number of items that are returned.                                                                                |             |
| sort                              | [SORT](#sort)                                                  | Sorting strategy, where asc means ascending, and desc means descending.                                                                                |             |

## Objects

### AssemblyOption

| Field       | Argument                            | Type | Description |
| ----------- | ----------------------------------- | ---- | ----------- |
| id          | [ID](#id)                           |      |             |
| name        | [String](#string)                   |      |             |
| required    | [Boolean](#boolean)                 |      |             |
| composition | [CompositionType](#compositiontype) |      |             |
| inputValues | [InputValue](#inputvalue)\[\]       |      |             |

### Attachment

| Field        | Argument                          | Type | Description |
| ------------ | --------------------------------- | ---- | ----------- |
| id           | [ID](#id)                         |      |             |
| name         | [String](#string)                 |      |             |
| required     | [Boolean](#boolean)               |      |             |
| domainValues | [DomainValues](#domainvalues)\[\] |      |             |

### Banners

| Field   | Argument                          | Type             | Description |
| ------- | --------------------------------- | ---------------- | ----------- |
| banners | [SearchBanner](#searchbanner)\[\] | List of banners. |             |

### Benefit

| Field          | Argument                        | Type                                                  | Description |
| -------------- | ------------------------------- | ----------------------------------------------------- | ----------- |
| **featured**   | [Boolean](#boolean)             | Indicates if the benefit is featured or not.          |             |
| **id**         | [String](#string)               | ID of the product to which the benefit is associated. |             |
| **name**       | [String](#string)               | Name of the benefit.                                  |             |
| **items**      | \[[BenefitItem](#benefititem)\] | Items of the benefit.                                 |             |
| **teaserType** | [String](#string)               | Type of benefit.                                      |             |

### BenefitItem

| Field              | Argument              | Type                                                                              | Description |
| ------------------ | --------------------- | --------------------------------------------------------------------------------- | ----------- |
| **benefitProduct** | [Product](#product)   | Product itself.                                                                   |             |
| **benefitSKUIds**  | \[[String](#string)\] | IDs of the SKUs that are taking part in the benefit.                              |             |
| **discount**       | [Float](#float)       | Discount applied to the benefit product.                                          |             |
| **minQuantity**    | [Int](#int)           | Minimum quantity of the benefit product that is required to validate the benefit. |             |

### Brand

| Field                  | Argument            | Type                              | Description |
| ---------------------- | ------------------- | --------------------------------- | ----------- |
| **cacheId**            | [ID](#id)           | Slug is used as cacheId.          |             |
| **id**                 | [Int](#int)         | Brand ID.                         |             |
| **imageUrl**           | [String](#string)   | Brand logo.                       |             |
| **slug**               | [String](#string)   | Text link.                        |             |
| **name**               | [String](#string)   | Name of the brand.                |             |
| **titleTag**           | [String](#string)   | Title used by HTML title tag.     |             |
| **metaTagDescription** | [String](#string)   | Description used by HTML tag.     |             |
| **active**             | [Boolean](#boolean) | Indicates if the brand is active. |             |

### BrandFacet

| Field           | Argument             | Type | Description |
| --------------- | -------------------- | ---- | ----------- |
| **id**          | [ID](#id)!           |      |             |
| **quantity**    | [Int](#int)!         |      |             |
| **name**        | [String](#string)!   |      |             |
| **link**        | [String](#string)!   |      |             |
| **linkEncoded** | [String](#string)!   |      |             |
| **map**         | [String](#string)    |      |             |
| **value**       | [String](#string)!   |      |             |
| **selected**    | [Boolean](#boolean)! |      |             |

### CategoriesTreeFacet

| Field           | Argument                                        | Type                                                                                | Description |
| --------------- | ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ----------- |
| **id**          | [ID](#id)!                                      |                                                                                |             |
| **quantity**    | [Int](#int)!                                    |                                                                                |             |
| **name**        | [String](#string)                               |                                                                                |             |
| **link**        | [String](#string)!                              |                                                                                |             |
| **linkEncoded** | [String](#string)!                              |                                                                                |             |
| **href**        | [String](#string)!                              | Contains slugified links according to the store structure, such as /:department/d, /:category/:subcategory, etc. |             |
| **map**         | [String](#string)                               |                                                                                |             |
| **value**       | [String](#string)!                              |                                                                                |             |
| **children**    | \[[CategoriesTreeFacet](#categoriestreefacet)\] |                                                                                |             |
| **selected**    | [Boolean](#boolean)!                            |                                                                                |             |

### Category

| Field                  | Argument                  | Type                                               | Description |
| ---------------------- | ------------------------- | -------------------------------------------------- | ----------- |
| **cacheId**            | [ID](#id)                 | Category ID is used as cacheId.                    |             |
| **href**               | [String](#string)         | URI of category.                                   |             |
| **slug**               | [String](#string)         | Category text link.                                |             |
| **id**                 | [Int](#int)               | Category ID.                                       |             |
| **name**               | [String](#string)         | Category name.                                     |             |
| **titleTag**           | [String](#string)         | Title used by HTML title tag.                      |             |
| **hasChildren**        | [Boolean](#boolean)       | Description used by HTML tag.                      |             |
| **metaTagDescription** | [String](#string)         | Indicates if the category has children categories. |             |
| **children**           | \[[Category](#category)\] | Category children.                                 |             |

### ClusterHighlight

| Field    | Argument          | Type | Description |
| -------- | ----------------- | ---- | ----------- |
| **id**   | [ID](#id)         |      |             |
| **name** | [String](#string) |      |             |

### CompositionItem

| Field               | Argument          | Type | Description |
| ------------------- | ----------------- | ---- | ----------- |
| **id**              | [ID](#id)         |      |             |
| **minQuantity**     | [Int](#int)       |      |             |
| **maxQuantity**     | [Int](#int)       |      |             |
| **initialQuantity** | [Int](#int)       |      |             |
| **priceTable**      | [String](#string) |      |             |
| **seller**          | [String](#string) |      |             |

### CompositionType

| Field           | Argument                                | Type | Description |
| --------------- | --------------------------------------- | ---- | ----------- |
| **minQuantity** | [Int](#int)                             |      |             |
| **maxQuantity** | [Int](#int)                             |      |             |
| **items**       | \[[CompositionItem](#compositionitem)\] |      |             |

### Correction

| Field          | Argument                              | Type | Description |
| -------------- | ------------------------------------- | ---- | ----------- |
| **correction** | [SearchCorrection](#searchcorrection) |      |             |

### DeliverySlaPerTypes

| Field                           | Argument          | Type | Description |
| ------------------------------- | ----------------- | ---- | ----------- |
| **TypeName**                    | [String](#string) |      |             |
| **Price**                       | [Float](#float)   |      |             |
| **EstimatedTimeSpanToDelivery** | [String](#string) |      |             |

### DeliverySlaSamples

| Field                   | Argument                                        | Type | Description |
| ----------------------- | ----------------------------------------------- | ---- | ----------- |
| **DeliverySlaPerTypes** | \[[DeliverySlaPerTypes](#deliveryslapertypes)\] |      |             |
| **Region**              | [Region](#region)                               |      |             |

### DepartmentFacet

| Field           | Argument             | Type | Description |
| --------------- | -------------------- | ---- | ----------- |
| **id**          | [ID](#id)!           |      |             |
| **quantity**    | [Int](#int)!         |      |             |
| **name**        | [String](#string)    |      |             |
| **link**        | [String](#string)!   |      |             |
| **linkEncoded** | [String](#string)!   |      |             |
| **map**         | [String](#string)    |      |             |
| **value**       | [String](#string)!   |      |             |
| **selected**    | [Boolean](#boolean)! |      |             |

### Discount

Discount object

| Field    | Argument          | Type          | Description |
| -------- | ----------------- | ------------- | ----------- |
| **name** | [String](#string) | Discount name |             |

### DomainValues

| Field            | Argument          | Type | Description |
| ---------------- | ----------------- | ---- | ----------- |
| **FieldName**    | [String](#string) |      |             |
| **MaxCaracters** | [String](#string) |      |             |
| **DomainValues** | [String](#string) |      |             |

### Facet

| Field        | Argument                      | Type | Description |
| ------------ | ----------------------------- | ---- | ----------- |
| **name**     | [String](#string)             |      |             |
| **values**   | \[[FacetValue](#facetvalue)\] |      |             |
| from         | [Int](#int)                   |      |             |
| to           | [Int](#int)                   |      |             |
| **type**     | [FilterType](#filtertype)     |      |             |
| **hidden**   | [Boolean](#boolean)           |      |             |
| **quantity** | [Int](#int)                   |      |             |

### FacetValue

| Field           | Argument                      | Type | Description |
| --------------- | ----------------------------- | ---- | ----------- |
| **id**          | [ID](#id)                     |      |             |
| **quantity**    | [Int](#int)!                  |      |             |
| **name**        | [String](#string)             |      |             |
| **key**         | [String](#string)             |      |             |
| **value**       | [String](#string)             |      |             |
| **selected**    | [Boolean](#boolean)           |      |             |
| **children**    | \[[FacetValue](#facetvalue)\] |      |             |
| **range**       | [Range](#range)               |      |             |
| **link**        | [String](#string)             |      |             |
| **linkEncoded** | [String](#string)             |      |             |
| **href**        | [String](#string)             |      |             |

### Facets

| Field                    | Argument                                        | Type                                                                                | Description |
| ------------------------ | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| **departments** ⚠       | \[[DepartmentFacet](#departmentfacet)\]         | ⚠ **DEPRECATED**Use facets instead.                                                                                |             |
| **brands** ⚠            | \[[BrandFacet](#brandfacet)\]                   | ⚠ **DEPRECATED**Use facets instead.                                                                                |             |
| **specificationFilters** | \[[FilterFacets](#filterfacets)\]               |                                                                                |             |
| **categoriesTrees** ⚠   | \[[CategoriesTreeFacet](#categoriestreefacet)\] | ⚠ **DEPRECATED**Use facets instead.                                                                                |             |
| **priceRanges**          | \[[PriceRangesFacet](#pricerangesfacet)\]       | Price range for the given query.                                                                                |             |
| **recordsFiltered** ⚠   | [Int](#int)                                     | ⚠ **DEPRECATED**Use recordsFiltered from productSearch instead.                                                                                |             |
| **queryArgs**            | [QueryArgs](#queryargs)                         | Information about the searched query.                                                                                |             |
| **facets**               | \[[Facet](#facet)\]                             | List of facets.                                                                                |             |
| **sampling**             | [Boolean](#boolean)                             | Indicates whether there was sampling in the aggregation of facets or not. In search results that have many products, only the first 30000 will be aggregated to avoid performance issues. |             |
| **breadcrumb**           | \[[SearchBreadcrumb](#searchbreadcrumb)\]       | Generated breadcrumb for the given query.                                                                                |             |

### FilterFacet

| Field           | Argument             | Type | Description |
| --------------- | -------------------- | ---- | ----------- |
| **quantity**    | [Int](#int)!         |      |             |
| **name**        | [String](#string)    |      |             |
| **link**        | [String](#string)!   |      |             |
| **linkEncoded** | [String](#string)!   |      |             |
| **map**         | [String](#string)    |      |             |
| **value**       | [String](#string)!   |      |             |
| **selected**    | [Boolean](#boolean)! |      |             |

### FilterFacets

| Field      | Argument                        | Type | Description |
| ---------- | ------------------------------- | ---- | ----------- |
| **name**   | [String](#string)               |      |             |
| **facets** | \[[FilterFacet](#filterfacet)\] |      |             |

### Gift

| Field           | Argument                    | Type | Description |
| --------------- | --------------------------- | ---- | ----------- |
| **productName** | [String](#string)           |      |             |
| **skuName**     | [String](#string)           |      |             |
| **brand**       | [String](#string)           |      |             |
| **linkText**    | [String](#string)           |      |             |
| **description** | [String](#string)           |      |             |
| **images**      | \[[GiftImage](#giftimage)\] |      |             |

### GiftImage

| Field          | Argument          | Type | Description |
| -------------- | ----------------- | ---- | ----------- |
| **imageUrl**   | [String](#string) |      |             |
| **imageLabel** | [String](#string) |      |             |
| **imageText**  | [String](#string) |      |             |

### Image

| Field          | Argument          | Type | Description |
| -------------- | ----------------- | ---- | ----------- |
| **cacheId**    | [ID](#id)         |      |             |
| **imageId**    | [ID](#id)         |      |             |
| **imageLabel** | [String](#string) |      |             |
| **imageTag**   | [String](#string) |      |             |
| **imageUrl**   | [String](#string) |      |             |
| **imageText**  | [String](#string) |      |             |

### InputValue

| Field            | Argument                            | Type | Description |
| ---------------- | ----------------------------------- | ---- | ----------- |
| **label**        | [String](#string)                   |      |             |
| **maxLength**    | [Int](#int)                         |      |             |
| **type**         | [InputValueType](#inputvaluetype)   |      |             |
| **defaultValue** | [StringOrBoolean](#stringorboolean) |      |             |
| **domain**       | \[[String](#string)\]               |      |             |

### Installment

| Field                          | Argument          | Type | Description |
| ------------------------------ | ----------------- | ---- | ----------- |
| **Value**                      | [Float](#float)   |      |             |
| **InterestRate**               | [Float](#float)   |      |             |
| **TotalValuePlusInterestRate** | [Float](#float)   |      |             |
| **NumberOfInstallments**       | [Int](#int)       |      |             |
| **PaymentSystemName**          | [String](#string) |      |             |
| **PaymentSystemGroupName**     | [String](#string) |      |             |
| **Name**                       | [String](#string) |      |             |

### ItemMetadata

| Field          | Argument                                  | Type | Description |
| -------------- | ----------------------------------------- | ---- | ----------- |
| **items**      | \[[ItemMetadataUnit](#itemmetadataunit)\] |      |             |
| **priceTable** | \[[ItemPriceTable](#itempricetable)\]     |      |             |

### ItemMetadataUnit

| Field               | Argument                              | Type | Description |
| ------------------- | ------------------------------------- | ---- | ----------- |
| **id**              | [ID](#id)                             |      |             |
| **name**            | [String](#string)                     |      |             |
| **skuName**         | [String](#string)                     |      |             |
| **productId**       | [String](#string)                     |      |             |
| **refId**           | [String](#string)                     |      |             |
| **ean**             | [String](#string)                     |      |             |
| **imageUrl**        | [String](#string)                     |      |             |
| **detailUrl**       | [String](#string)                     |      |             |
| **seller**          | [String](#string)                     |      |             |
| **assemblyOptions** | \[[AssemblyOption](#assemblyoption)\] |      |             |

### ItemPriceTable

| Field      | Argument                              | Type | Description |
| ---------- | ------------------------------------- | ---- | ----------- |
| **type**   | [String](#string)                     |      |             |
| **values** | \[[PriceTableItem](#pricetableitem)\] |      |             |

### Items

| Field         | Argument          | Type | Description |
| ------------- | ----------------- | ---- | ----------- |
| **thumb**     | [String](#string) |      |             |
| **name**      | [String](#string) |      |             |
| **href**      | [String](#string) |      |             |
| **criteria**  | [String](#string) |      |             |
| **slug**      | [String](#string) |      |             |
| **productId** | [String](#string) |      |             |

### KitItem

| Field       | Argument                    | Type | Description |
| ----------- | --------------------------- | ---- | ----------- |
| **itemId**  | [ID](#id)                   |      |             |
| **amount**  | [Int](#int)                 |      |             |
| **product** | [OnlyProduct](#onlyproduct) |      |             |
| **sku**     | [SKU](#sku)                 |      |             |

### Offer

| Field                              | Argument                                      | Type                                                | Description |
| ---------------------------------- | --------------------------------------------- | --------------------------------------------------- | ----------- |
| **Installments**                   | \[[Installment](#installment)\]               |                                                     |             |
| criteria                           | [InstallmentsCriteria](#installmentscriteria) |                                                     |             |
| rates                              | [Boolean](#boolean)                           |                                                     |             |
| excludedPaymentSystems             | \[[String](#string)\]                         |                                                     |             |
| includedPaymentSystems             | \[[String](#string)\]                         |                                                     |             |
| **Price**                          | [Float](#float)                               |                                                     |             |
| **ListPrice**                      | [Float](#float)                               |                                                     |             |
| **spotPrice**                      | [Float](#float)                               |                                                     |             |
| **PriceWithoutDiscount**           | [Float](#float)                               |                                                     |             |
| **RewardValue**                    | [Float](#float)                               |                                                     |             |
| **PriceValidUntil**                | [String](#string)                             |                                                     |             |
| **AvailableQuantity**              | [Float](#float)                               |                                                     |             |
| **Tax**                            | [Float](#float)                               |                                                     |             |
| **taxPercentage**                  | [Float](#float)                               |                                                     |             |
| **CacheVersionUsedToCallCheckout** | [String](#string)                             |                                                     |             |
| **DeliverySlaSamples**             | \[[DeliverySlaSamples](#deliveryslasamples)\] |                                                     |             |
| **discountHighlights**             | \[[Discount](#discount)!\]                    | List of discount highlights.                        |             |
| **teasers**                        | \[[Teaser](#teaser)!\]                        |                                                     |             |
| **giftSkuIds**                     | \[[String](#string)\]                         | List of SKUs for gifts associated with the product. |             |
| **gifts**                          | \[[Gift](#gift)\]                             | List of gifts associated with the product.          |             |

### OnlyProduct

| Field                  | Argument                                  | Type | Description |
| ---------------------- | ----------------------------------------- | ---- | ----------- |
| **brand**              | [String](#string)                         |      |             |
| **categoryId**         | [ID](#id)                                 |      |             |
| **categoryTree**       | \[[Category](#category)\]                 |      |             |
| **clusterHighlights**  | \[[ClusterHighlight](#clusterhighlight)\] |      |             |
| **productClusters**    | \[[ProductClusters](#productclusters)\]   |      |             |
| **description**        | [String](#string)                         |      |             |
| **link**               | [String](#string)                         |      |             |
| **linkText**           | [String](#string)                         |      |             |
| **productId**          | [ID](#id)                                 |      |             |
| **productName**        | [String](#string)                         |      |             |
| **properties**         | \[[Property](#property)\]                 |      |             |
| **propertyGroups**     | \[[PropertyGroup](#propertygroup)\]       |      |             |
| **productReference**   | [String](#string)                         |      |             |
| **recommendations**    | [Recommendation](#recommendation)         |      |             |
| **jsonSpecifications** | [String](#string)                         |      |             |

### PageType

| Field    | Argument                                      | Type | Description |
| -------- | --------------------------------------------- | ---- | ----------- |
| **id**   | [String](#string)                             |      |             |
| **type** | [PageEntityIdentifier](#pageentityidentifier) |      |             |

### PriceRange

| Field         | Argument        | Type | Description |
| ------------- | --------------- | ---- | ----------- |
| **highPrice** | [Float](#float) |      |             |
| **lowPrice**  | [Float](#float) |      |             |

### PriceRangesFacet

| Field           | Argument             | Type | Description |
| --------------- | -------------------- | ---- | ----------- |
| **quantity**    | [Int](#int)!         |      |             |
| **name**        | [String](#string)    |      |             |
| **link**        | [String](#string)!   |      |             |
| **linkEncoded** | [String](#string)!   |      |             |
| **map**         | [String](#string)    |      |             |
| **value**       | [String](#string)!   |      |             |
| **selected**    | [Boolean](#boolean)! |      |             |
| **slug**        | [String](#string)    |      |             |

### PriceTableItem

| Field          | Argument          | Type | Description |
| -------------- | ----------------- | ---- | ----------- |
| **id**         | [String](#string) |      |             |
| **assemblyId** | [String](#string) |      |             |
| **price**      | [Int](#int)       |      |             |

### Product

| Field                   | Argument                                      | Type                                                                                | Description |
| ----------------------- | --------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ----------- |
| **brand**               | [String](#string)                             | Brand of the product.                                                                                |             |
| **brandId**             | [Int](#int)                                   | ID of the brand of the product.                                                                      |             |
| **cacheId**             | [ID](#id)                                     | LinkText is used as cacheId.                                                                         |             |
| **categoryId**          | [ID](#id)                                     |                                                                                |             |
| **categories** ⚠       | \[[String](#string)\]                         | Categories of the product.⚠ **DEPRECATED** Use categoryTree field for internationalization support. |             |
| **categoryTree**        | \[[Category](#category)\]                     | Product's category tree.                                                                             |             |
| **clusterHighlights**   | \[[ClusterHighlight](#clusterhighlight)\]     | List of related products.                                                                            |             |
| **productClusters**     | \[[ProductClusters](#productclusters)\]       |                                                                                |             |
| **description**         | [String](#string)                             | Product description.                                                                                |             |
| **items**               | \[[SKU](#sku)\]                               | SKU objects of the product.                                                                          |             |
| filter                  | [ItemsFilter](#itemsfilter)                   |                                                                                |             |
| **skuSpecifications**   | \[[SkuSpecification](#skuspecification)\]     | List of SKU Specifications.                                                                          |             |
| **link**                | [String](#string)                             | Product URL.                                                                                |             |
| **linkText**            | [String](#string)                             | Product slug.                                                                                |             |
| **productId**           | [ID](#id)                                     | Product ID.                                                                                |             |
| **productName**         | [String](#string)                             | Product name.                                                                                |             |
| **properties**          | \[[Property](#property)\]                     | Array of product properties.                                                                         |             |
| **propertyGroups**      | \[[PropertyGroup](#propertygroup)\]           | Array of product properties.                                                                         |             |
| **productReference**    | [String](#string)                             | Product reference.                                                                                |             |
| **titleTag**            | [String](#string)                             | Title used by HTML title tag.                                                                        |             |
| **metaTagDescription**  | [String](#string)                             | Description used by HTML tag.                                                                        |             |
| **recommendations**     | [Recommendation](#recommendation)             | Related Products.                                                                                |             |
| **jsonSpecifications**  | [String](#string)                             | JSON specification of the product.                                                                   |             |
| **benefits**            | \[[Benefit](#benefit)\]                       | List of benefits associated with this product.                                                       |             |
| **itemMetadata**        | [ItemMetadata](#itemmetadata)                 |                                                                                |             |
| **specificationGroups** | \[[SpecificationGroup](#specificationgroup)\] | Array of product SpecificationGroup.                                                                 |             |
| **priceRange**          | [ProductPriceRange](#productpricerange)       | Returns highest and lowest prices for available SKUs in product.                                     |             |
| **releaseDate**         | [String](#string)                             | Product Release Date, for list ordering and product cluster highlight.                               |             |
| **selectedProperties**  | \[[SelectedProperty](#selectedproperty)\]     | Product properties that will be selected by default. For example, {key: "Color", value: "Blue"}      |             |

### ProductClusters

| Field    | Argument          | Type | Description |
| -------- | ----------------- | ---- | ----------- |
| **id**   | [ID](#id)         |      |             |
| **name** | [String](#string) |      |             |

### ProductPriceRange

| Field            | Argument                  | Type | Description |
| ---------------- | ------------------------- | ---- | ----------- |
| **sellingPrice** | [PriceRange](#pricerange) |      |             |
| **listPrice**    | [PriceRange](#pricerange) |      |             |

### ProductSearch

| Field                  | Argument                                  | Type                                                                                | Description |
| ---------------------- | ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| **products**           | \[[Product](#product)\]                   | List of products.                                                                                |             |
| **recordsFiltered**    | [Int](#int)                               | Total number of products.                                                                                |             |
| **titleTag**           | [String](#string)                         | Title used in the title tag.                                                                                |             |
| **metaTagDescription** | [String](#string)                         | String to be used in the <meta name="description"... tag.                                                                                |             |
| **breadcrumb** ⚠      | \[[SearchBreadcrumb](#searchbreadcrumb)\] | ⚠ **DEPRECATED**Use breadcrumb from the facets query instead.                                                                                |             |
| **canonical**          | [String](#string)                         |                                                                                |             |
| **suggestion** ⚠      | [SearchSuggestions](#searchsuggestions)   | ⚠ **DEPRECATED**Use the suggestion query instead.                                                                                |             |
| **correction**         | [SearchCorrection](#searchcorrection)     | Object that indicates if the term was misspelled and suggests a possible correction.                                                                                |             |
| **operator**           | [Operator](#operator)                     | Indicates how the search engine deals with the fullText when there is more than one word.and: The results will contain all the words in the query. or: The results will contain at least one word from the original search query.If and was not possible, or will be the fallback. |             |
| **fuzzy**              | [String](#string)                         | Indicates how the search engine corrected the misspelled word by using fuzzy logic. It can be a number representing the max number ofmisspelled letters, or the string auto suggesting that the search engine should set this value by itself.                                     |             |
| **searchState**        | [String](#string)                         | As fuzzy and operator, it controls the search state, but it is for general purposes. This field allows the search engines to applyfeatures that are not handled by the other fields.The possible values in this field are defined by each search engine.                           |             |
| **banners** ⚠         | \[[SearchBanner](#searchbanner)\]         | ⚠ **DEPRECATED**Use the banners query instead.                                                                                |             |
| **redirect**           | [String](#string)                         | Returns the redirect URL set for the given query.                                                                                |             |

### ProductSuggestions

| Field          | Argument                 | Type                                                                                | Description |
| -------------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |
| **count**      | [Int](#int)!             | Number of suggested products.                                                                                |             |
| **products**   | \[[Product](#product)\]! | Suggested products.                                                                                |             |
| **misspelled** | [Boolean](#boolean)      | Indicates if the term is misspelled or not.                                                                                |             |
| **operator**   | [Operator](#operator)    | Indicates how the search engine will deal with the fullText if there is more than one word. Set the value as and if the returned products must have all the words in its metadata. Otherwise, set the value as or. |             |

### Property

| Field            | Argument              | Type | Description |
| ---------------- | --------------------- | ---- | ----------- |
| **originalName** | [String](#string)     |      |             |
| **name**         | [String](#string)     |      |             |
| **values**       | \[[String](#string)\] |      |             |

### PropertyGroup

| Field          | Argument              | Type | Description |
| -------------- | --------------------- | ---- | ----------- |
| **name**       | [String](#string)     |      |             |
| **properties** | \[[String](#string)\] |      |             |

### QueryArgs

| Field              | Argument                            | Type | Description |
| ------------------ | ----------------------------------- | ---- | ----------- |
| **map**            | [String](#string)                   |      |             |
| **query**          | [String](#string)                   |      |             |
| **selectedFacets** | \[[SelectedFacet](#selectedfacet)\] |      |             |

### Range

| Field    | Argument        | Type | Description |
| -------- | --------------- | ---- | ----------- |
| **from** | [Float](#float) |      |             |
| **to**   | [Float](#float) |      |             |

### Recommendation

| Field        | Argument                | Type | Description |
| ------------ | ----------------------- | ---- | ----------- |
| **buy**      | \[[Product](#product)\] |      |             |
| **view**     | \[[Product](#product)\] |      |             |
| **similars** | \[[Product](#product)\] |      |             |

### Reference

| Field     | Argument          | Type | Description |
| --------- | ----------------- | ---- | ----------- |
| **Key**   | [String](#string) |      |             |
| **Value** | [String](#string) |      |             |

### Region

| Field               | Argument            | Type | Description |
| ------------------- | ------------------- | ---- | ----------- |
| **IsPersisted**     | [Boolean](#boolean) |      |             |
| **IsRemoved**       | [Boolean](#boolean) |      |             |
| **Id**              | [ID](#id)           |      |             |
| **Name**            | [String](#string)   |      |             |
| **CountryCode**     | [String](#string)   |      |             |
| **ZipCode**         | [String](#string)   |      |             |
| **CultureInfoName** | [String](#string)   |      |             |

### SKU

### SKU

| Field                    | Argument                      | Type                                        | Description |
| ------------------------ | ----------------------------- | ------------------------------------------- | ----------- |
| **itemId**               | [ID](#id)                     |                                             |             |
| **name**                 | [String](#string)             |                                             |             |
| **nameComplete**         | [String](#string)             |                                             |             |
| **complementName**       | [String](#string)             |                                             |             |
| **ean**                  | [String](#string)             |                                             |             |
| **referenceId**          | \[[Reference](#reference)\]   |                                             |             |
| **measurementUnit**      | [String](#string)             |                                             |             |
| **unitMultiplier**       | [Float](#float)               |                                             |             |
| **kitItems**             | \[[KitItem](#kititem)\]       |                                             |             |
| **images**               | \[[Image](#image)\]           |                                             |             |
| quantity                 | [Int](#int)                   |                                             |             |
| **videos**               | \[[Video](#video)\]           |                                             |             |
| **sellers**              | \[[Seller](#seller)\]         |                                             |             |
| **variations**           | \[[Property](#property)\]     |                                             |             |
| **attachments** ⚠       | \[[Attachment](#attachment)\] | ⚠ **DEPRECATED** Use itemMetaData instead. |             |
| **estimatedDateArrival** | [String](#string)             |                                             |             |

### SKUSpecificationField

| Field            | Argument          | Type | Description |
| ---------------- | ----------------- | ---- | ----------- |
| **originalName** | [String](#string) |      |             |
| **name**         | [String](#string) |      |             |

### SKUSpecificationValue

| Field            | Argument          | Type | Description |
| ---------------- | ----------------- | ---- | ----------- |
| **originalName** | [String](#string) |      |             |
| **name**         | [String](#string) |      |             |

### SearchBanner

| Field    | Argument          | Type         | Description |
| -------- | ----------------- | ------------ | ----------- |
| **id**   | [String](#string) | Banner ID.   |             |
| **name** | [String](#string) | Banner name. |             |
| **area** | [String](#string) | Banner area. |             |
| **HTML** | [String](#string) | Banner HTML. |             |

### SearchBreadcrumb

| Field    | Argument          | Type                                    | Description |
| -------- | ----------------- | --------------------------------------- | ----------- |
| **name** | [String](#string) | Human-readable format of the facet key. |             |
| **href** | [String](#string) | Query link.                             |             |

### SearchCorrection

Object that indicates if the term was misspelled and suggests a possible correction.

| Field           | Argument            | Type                                                                                | Description |
| --------------- | ------------------- | --------------------------------------------------------------------------------------------------- | ----------- |
| **text**        | [String](#string)   | Corrected term. If the API was not able to correct the term, it will show the original search term. |             |
| **highlighted** | [String](#string)   | The same as text, but it highlights the corrected word. Useful when there is more than one word.    |             |
| **misspelled**  | [Boolean](#boolean) | Indicates whether the term was misspelled (true) or not (false).                                    |             |
| **correction**  | [Boolean](#boolean) | Indicates whether the API was able to suggest a correction (true) or not (false).                   |             |

### SearchMetadata

| Field                  | Argument          | Type | Description |
| ---------------------- | ----------------- | ---- | ----------- |
| **titleTag**           | [String](#string) |      |             |
| **metaTagDescription** | [String](#string) |      |             |

### SearchSuggestion

| Field          | Argument                                                    | Type                                              | Description |
| -------------- | ----------------------------------------------------------- | ------------------------------------------------- | ----------- |
| **term**       | [String](#string)!                                          | Search term.                                      |             |
| **count**      | [Int](#int)!                                                | Number of times the term was searched.            |             |
| **attributes** | \[[SearchSuggestionAttribute](#searchsuggestionattribute)\] | List of facets in which the term can be searched. |             |

### SearchSuggestionAttribute

| Field          | Argument           | Type                                    | Description |
| -------------- | ------------------ | --------------------------------------- | ----------- |
| **key**        | [String](#string)! | Facet key.                              |             |
| **value**      | [String](#string)! | Facet value.                            |             |
| **labelValue** | [String](#string)! | Human-readable format of the facet key. |             |

### SearchSuggestions

| Field        | Argument                                  | Type                          | Description |
| ------------ | ----------------------------------------- | ----------------------------- | ----------- |
| **searches** | \[[SearchSuggestion](#searchsuggestion)\] | A list of search suggestions. |             |

### SearchURLStats

| Field     | Argument           | Type | Description |
| --------- | ------------------ | ---- | ----------- |
| **path**  | [String](#string)! |      |             |
| **count** | [Int](#int)!       |      |             |

### SelectedFacet

| Field     | Argument          | Type | Description |
| --------- | ----------------- | ---- | ----------- |
| **key**   | [String](#string) |      |             |
| **value** | [String](#string) |      |             |

### SelectedProperty

| Field     | Argument          | Type | Description |
| --------- | ----------------- | ---- | ----------- |
| **key**   | [String](#string) |      |             |
| **value** | [String](#string) |      |             |

### Seller

| Field               | Argument            | Type | Description |
| ------------------- | ------------------- | ---- | ----------- |
| **sellerId**        | [ID](#id)           |      |             |
| **sellerName**      | [String](#string)   |      |             |
| **addToCartLink**   | [String](#string)   |      |             |
| **sellerDefault**   | [Boolean](#boolean) |      |             |
| **commertialOffer** | [Offer](#offer)     |      |             |

### SkuSpecification

| Field      | Argument                                            | Type | Description |
| ---------- | --------------------------------------------------- | ---- | ----------- |
| **field**  | [SKUSpecificationField](#skuspecificationfield)     |      |             |
| **values** | \[[SKUSpecificationValue](#skuspecificationvalue)\] |      |             |

### SpecificationGroup

| Field              | Argument                                                      | Type | Description |
| ------------------ | ------------------------------------------------------------- | ---- | ----------- |
| **originalName**   | [String](#string)                                             |      |             |
| **name**           | [String](#string)                                             |      |             |
| **specifications** | \[[SpecificationGroupProperty](#specificationgroupproperty)\] |      |             |

### SpecificationGroupProperty

| Field            | Argument              | Type | Description |
| ---------------- | --------------------- | ---- | ----------- |
| **originalName** | [String](#string)     |      |             |
| **name**         | [String](#string)     |      |             |
| **values**       | \[[String](#string)\] |      |             |

### Suggestions

| Field             | Argument            | Type                                                   | Description |
| ----------------- | ------------------- | ------------------------------------------------------ | ----------- |
| **cacheId**       | [ID](#id)           | searchTerm from Query autocomplete is used as cacheId. |             |
| **itemsReturned** | \[[Items](#items)\] |                                                        |             |

### Teaser

| Field          | Argument                            | Type | Description |
| -------------- | ----------------------------------- | ---- | ----------- |
| **name**       | [String](#string)                   |      |             |
| **conditions** | [TeaserCondition](#teasercondition) |      |             |
| **effects**    | [TeaserEffects](#teasereffects)     |      |             |

### TeaserCondition

| Field               | Argument                        | Type | Description |
| ------------------- | ------------------------------- | ---- | ----------- |
| **minimumQuantity** | [Int](#int)                     |      |             |
| **parameters**      | \[[TeaserValue](#teaservalue)\] |      |             |

### TeaserEffects

| Field          | Argument                        | Type | Description |
| -------------- | ------------------------------- | ---- | ----------- |
| **parameters** | \[[TeaserValue](#teaservalue)\] |      |             |

### TeaserValue

| Field     | Argument          | Type | Description |
| --------- | ----------------- | ---- | ----------- |
| **name**  | [String](#string) |      |             |
| **value** | [String](#string) |      |             |

### Video

| Field        | Argument          | Type | Description |
| ------------ | ----------------- | ---- | ----------- |
| **videoUrl** | [String](#string) |      |             |

### productSpecification

| Field           | Argument              | Type | Description |
| --------------- | --------------------- | ---- | ----------- |
| **fieldName**   | [String](#string)     |      |             |
| **fieldValues** | \[[String](#string)\] |      |             |

## Inputs

### AssemblyOptionInput

| Field          | Type                                             | Description |
| -------------- | ------------------------------------------------ | ----------- |
| **id**         | [ID](#id)!                                       |             |
| **quantity**   | [Int](#int)!                                     |             |
| **assemblyId** | [String](#string)!                               |             |
| **seller**     | [String](#string)!                               |             |
| **options**    | \[[AssemblyOptionInput](#assemblyoptioninput)!\] |             |

### Options

| Field             | Type                | Description                                                                                |
| ----------------- | ------------------- | ------------------------------------------------------------------------------------------------ |
| **allowRedirect** | [Boolean](#boolean) | If the search has a redirect enabled, this allows (true) or not (false) the redirect to be used. |

### ProductUniqueIdentifier

| Field     | Type                                                           | Description |
| --------- | -------------------------------------------------------------- | ----------- |
| **field** | [ProductUniqueIdentifierField](#productuniqueidentifierfield)! |             |
| **value** | [ID](#id)!                                                     |             |

### SelectedFacetInput

| Field     | Type              | Description                   |
| --------- | ----------------- | ----------------------------- |
| **key**   | [String](#string) | A key for the selected facet. |
| **value** | [String](#string) | Facet value.                  |

#### General filters

The `key` parameter also allows the following general filters.

| facetKey      | Description                                                                                |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| category-${n} | Filter the search by category, where n represents the category tree level (1 = department, 2 = category, 3 = subcategory, and so on). |
| region-id     | Filter the search by a region ID, for regionalization purposes. The value is the region ID.                                           |

## Enums

### CategoryTreeBehavior

| Value   | Description                                        |
| ------- | -------------------------------------------------- |
| default | Uses the default value set by the search provider. |
| show    | Shows the category tree when it is possible.       |
| hide    | Hides the category tree in any situation.          |

### CrossSelingInputEnum

| Value         | Description |
| ------------- | ----------- |
| buy           |             |
| similars      |             |
| view          |             |
| viewAndBought |             |
| accessories   |             |
| suggestions   |             |

### CrossSelingGroupByEnum

| Value   | Description                                                                                |
| ------- | ---------------------------------------------------------------------------------------------------- |
| PRODUCT | Default behavior. Groups SKUs from the same product and bring only products. Limited to 12 products. |
| NONE    | Returns all SKUs registered in the Catalog for the recommendation.                                   |

### FilterType

| Value        | Description |
| ------------ | ----------- |
| TEXT         |             |
| NUMBER       |             |
| CATEGORYTREE |             |
| BRAND        |             |
| PRICERANGE   |             |

### InputValueType

| Value   | Description |
| ------- | ----------- |
| TEXT    |             |
| BOOLEAN |             |
| OPTIONS |             |

### InstallmentsCriteria

| Value                  | Description |
| ---------------------- | ----------- |
| MAX\_WITHOUT\_INTEREST |             |
| MAX\_WITH\_INTEREST    |             |
| MAX                    |             |
| MIN                    |             |
| ALL                    |             |

### ItemsFilter

| Value            | Description                                                                   |
| ---------------- | ----------------------------------------------------------------------------- |
| ALL              | Returns all items, same as no filter.                                         |
| FIRST\_AVAILABLE | Returns only the first available item. Returns first if no item is available. |
| ALL\_AVAILABLE   | Returns all available items. Returns first if no item is available.           |

### Operator

| Value | Description |
| ----- | ----------- |
| and   |             |
| or    |             |

### PageEntityIdentifier

| Value       | Description |
| ----------- | ----------- |
| brand       |             |
| department  |             |
| category    |             |
| subcategory |             |
| search      |             |

### ProductUniqueIdentifierField

| Value     | Description |
| --------- | ----------- |
| id        |             |
| slug      |             |
| ean       |             |
| reference |             |
| sku       |             |

### SORT

| Value | Description |
| ----- | ----------- |
| ASC   |             |
| DESC  |             |

### SimulationBehavior

| Value         | Description                                                                                |
| ------------- | --------------------------------------------------------------------------------------------- |
| default       | Performs the simulation on the catalog as usual.                                              |
| only1P        | Performs the simulation on catalog only for seller 1P.                                        |
| regionalize1p | Only first party sellers will include the regionId.                                           |
| skip          | Calls catalog passing a parameter to not simulate each SKU and get its most up to date price. |
| async         | Performs the simulation on the client side.                                                   |

## Scalars

### Boolean

The `Boolean` scalar type represents `true` or `false`.

### Float

The `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/IEEE%5Ffloating%5Fpoint).

### ID

The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.

### Int

The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

### String

The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

### StringOrBoolean

Represents a [String](#string) or a [Boolean](#boolean) value.

[Responsive Values« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.responsive-values)[Session ClientNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.session-client)

See also

[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)

ON THIS PAGE

[Query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23query)

[Objects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23objects)

[AssemblyOption](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23assemblyoption)[Attachment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23attachment)[Banners](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23banners)[Benefit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23benefit)[BenefitItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23benefititem)[Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23brand)[BrandFacet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23brandfacet)[CategoriesTreeFacet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23categoriestreefacet)[Category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23category)[ClusterHighlight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23clusterhighlight)[CompositionItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23compositionitem)[CompositionType](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23compositiontype)[Correction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23correction)[DeliverySlaPerTypes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23deliveryslapertypes)[DeliverySlaSamples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23deliveryslasamples)[DepartmentFacet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23departmentfacet)[Discount](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23discount)[DomainValues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23domainvalues)[Facet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23facet)[FacetValue](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23facetvalue)[Facets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23facets)[FilterFacet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23filterfacet)[FilterFacets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23filterfacets)[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23gift)[GiftImage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23giftimage)[Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23image)[InputValue](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23inputvalue)[Installment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23installment)[ItemMetadata](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23itemmetadata)[ItemMetadataUnit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23itemmetadataunit)[ItemPriceTable](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23itempricetable)[Items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23items)[KitItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23kititem)[Offer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23offer)[OnlyProduct](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23onlyproduct)[PageType](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23pagetype)[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23pricerange)[PriceRangesFacet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23pricerangesfacet)[PriceTableItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23pricetableitem)[Product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23product)[ProductClusters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23productclusters)[ProductPriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23productpricerange)[ProductSearch](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23productsearch)[ProductSuggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23productsuggestions)[Property](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23property)[PropertyGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23propertygroup)[QueryArgs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23queryargs)[Range](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23range)[Recommendation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23recommendation)[Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23reference)[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23region)[SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23sku)[SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23sku)[SKUSpecificationField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23skuspecificationfield)[SKUSpecificationValue](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23skuspecificationvalue)[SearchBanner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23searchbanner)[SearchBreadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23searchbreadcrumb)[SearchCorrection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23searchcorrection)[SearchMetadata](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23searchmetadata)[SearchSuggestion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23searchsuggestion)[SearchSuggestionAttribute](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23searchsuggestionattribute)[SearchSuggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23searchsuggestions)[SearchURLStats](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23searchurlstats)[SelectedFacet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23selectedfacet)[SelectedProperty](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23selectedproperty)[Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23seller)[SkuSpecification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23skuspecification)[SpecificationGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23specificationgroup)[SpecificationGroupProperty](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23specificationgroupproperty)[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23suggestions)[Teaser](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23teaser)[TeaserCondition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23teasercondition)[TeaserEffects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23teasereffects)[TeaserValue](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23teaservalue)[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23video)[productSpecification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23productspecification)

[Inputs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23inputs)

[AssemblyOptionInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23assemblyoptioninput)[Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23options)[ProductUniqueIdentifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23productuniqueidentifier)[SelectedFacetInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23selectedfacetinput)

[Enums](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23enums)

[CategoryTreeBehavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23categorytreebehavior)[CrossSelingInputEnum](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23crossselinginputenum)[CrossSelingGroupByEnum](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23crossselinggroupbyenum)[FilterType](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23filtertype)[InputValueType](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23inputvaluetype)[InstallmentsCriteria](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23installmentscriteria)[ItemsFilter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23itemsfilter)[Operator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23operator)[PageEntityIdentifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23pageentityidentifier)[ProductUniqueIdentifierField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23productuniqueidentifierfield)[SORT](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23sort)[SimulationBehavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23simulationbehavior)

[Scalars](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23scalars)

[Boolean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23boolean)[Float](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23float)[ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23id)[Int](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23int)[String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23string)[StringOrBoolean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-graphql/docs/apps/vtex.search-graphql%23stringorboolean)

Was this helpful?

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)