diff --git a/docs/README.md b/docs/README.md
index d1f246d..b9ce193 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,3 +1,4 @@
+# search-graphql
# VTEX Search GraphQL
This app exports a GraphQL schema for search results on VTEX Stores.
@@ -23,13 +24,640 @@ query ProductQuery($slug: String) {
```
To resolve this query, you need to have a app that implements the schema declared in this app, such as: [vtex.search-resolver](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) * [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)
+
Field | Argument | Type | Description |
---|---|---|---|
product | Product | +Returns a specified product + | |
slug | String | +Product slug + | |
identifier | ProductUniqueIdentifier | +Product identifier + | |
regionId | String | +Seller id encoded with base64 according to this format SW#{sellerId} + | |
salesChannel | Int | +Trade Policy + | |
banners | Banners | +Lists the banners registered for a given query. Check the [configuring banners documentation](https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/4ViKEivLJtJsvpaW0aqIQ5) for a full explanation of the banner feature. + | |
fullText | String | +Search term. It can contain any character. + | |
selectedFacets | [SelectedFacetInput] | +List of the selected facets -### Documentation +The order in which the terms appear is not relevant to the search. -The documentation is auto generated and can be found [here](https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html). +You can also repeat the same `facetKey` several times for different values. + | |
correction | Correction | +Tries to correct a misspelled term from the search. + | |
fullText | String | +Search term. It can contain any character. + | |
searchSuggestions | SearchSuggestions | +Lists suggested terms similar to the search term. + | |
fullText | String! | +Search term. It can contain any character. + | |
productSearch | ProductSearch | +Lists the products for a given query. + | |
query | String | +**Deprecated**. Use `fullText` instead. + | |
fullText | String | +Search term. It can contain any character. + | |
map | String | +**Deprecated**. Use `selectedFacets` instead. + | |
selectedFacets | [SelectedFacetInput] | +List of the selected facets -To generate the documentation you need to install the [spectaql](https://github.com/anvilco/spectaql/) and run: +The order in which the terms appear is not relevant to the search. -``` -npx spectaql spectaql-config.yml -t ./spectaql-documentation -``` +You can also repeat the same `facetKey` several times for different values. + | |
category | String | +**Deprecated**. Use `selectedFacets` instead. + | |
specificationFilters | [String] | +**Deprecated**. Use `selectedFacets` instead. + | |
priceRange | 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 | +**Deprecated**. Use `selectedFacets` instead. + | |
salesChannel | 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 | +Order by a criteria. OrderByPriceDESC/OrderByPriceASC, OrderByTopSaleDESC, OrderByReviewRateDESC, OrderByNameASC/OrderByNameDESC, OrderByReleaseDateDESC, OrderByBestDiscountDESC, OrderByScoreDESC +If you want to sort by a specification, use the format {specification key}:{asc|desc}. For example: "pricePerUnit:asc" or "size:desc" (this only works on `vtex.search-resolver@1.x`) + | |
from | Int | +Pagination item start + | |
to | Int | +Pagination item end + | |
hideUnavailableItems | Boolean | +If true, uses isAvailablePerSalesChannel_ parameter on query with segment's sales channel. Will override any given salesChannel arg + | |
simulationBehavior | SimulationBehavior | +If you want faster searches and do not care about most up to date prices and promotions, use skip value. + | |
productOriginVtex | 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 | +Indicates how the search-engine will deal with the fullText if there is more than one word. Set `and` if the returned products must have all the words in its metadata or `or` otherwise. + | |
fuzzy | 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 | +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 | +Search options that customize the search result. + | |
searchMetadata | SearchMetadata | ||
query | String | +Terms that is used in search e.g.: eletronics/samsung + | |
fullText | String | +Text inputted by the user as the search term + | |
map | String | +Defines terms types: Brand, Category, Department e.g.: c,b + | |
selectedFacets | [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] | +Returns products list filtered and ordered + | |
query | String | +Terms that is used in search e.g.: eletronics/samsung + | |
map | String | +Defines terms types: Brand, Category, Department e.g.: c,b + | |
category | String | +Filter by category. {a}/{b} - {a} and {b} are categoryIds + | |
specificationFilters | [String] | +Array of product specification. specificationFilter_{a}:{b} - {a} is the specificationId, {b} = specification value + | |
priceRange | 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 | +Filter by collection. where collection also know as productClusterId + | |
salesChannel | 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 | +Order by a criteria. OrderByPriceDESC/OrderByPriceASC, OrderByTopSaleDESC, OrderByReviewRateDESC, OrderByNameASC/OrderByNameDESC, OrderByReleaseDateDESC, OrderByBestDiscountDESC, OrderByScoreDESC + | |
from | Int | +Pagination item start + | |
to | Int | +Pagination item end + | |
hideUnavailableItems | Boolean | +If true, uses isAvailablePerSalesChannel_ parameter on query with segment's sales channel. Will override any given salesChannel arg + | |
simulationBehavior | SimulationBehavior | +If you want faster searches and do not care about most up to date prices and promotions, use skip value. + | |
productRecommendations | [Product] | ||
identifier | ProductUniqueIdentifier | ||
type | CrossSelingInputEnum | ||
productsByIdentifier | [Product] | ||
field | ProductUniqueIdentifierField! | ||
values | [ID!] | ||
salesChannel | String | +Filter by availability at a specific sales channel. + | |
facets | Facets | +Returns facets category + | |
query | String | +**Deprecated**. Use `fullText` instead. + | |
fullText | String | +Search term. It can contain any character. + | |
map | String | +**Deprecated**. Use `selectedFacets` instead. + | |
selectedFacets | [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 | +If true, uses isAvailablePerSalesChannel_ parameter on query with segment's sales channel. + | |
removeHiddenFacets | Boolean | +If true, remove hidden facets from the result. + | |
behavior | String | +If Static, ignores SpecificationFilters received on the map and query when returning +the facets available, which makes the facets never change. + | |
operator | Operator | +Indicates how the search-engine will deal with the fullText if there is more than one word. Set `and` if the returned products must have all the words in its metadata or `or` otherwise. + | |
fuzzy | 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 | +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 | +Pagination item start + | |
to | Int | +Pagination item end + | |
categoryTreeBehavior | CategoryTreeBehavior | +Determines the behavior of the category tree + | |
initialAttributes | String | +Initial attributes (based on the `initialMap` parameter) + | |
autocomplete | Suggestions | +Get auto complete suggestions in search + | |
maxRows | Int | +Number of items that is returned + | |
searchTerm | String | +Terms that is used in search e.g.: iphone + | |
topSearches | SearchSuggestions | +Get list of the 10 most searched terms + | |
autocompleteSearchSuggestions | SearchSuggestions | +Lists the suggested terms and attributes similar to the search term. + | |
fullText | String! | +Search term. It can contain any character. + | |
productSuggestions | ProductSuggestions | +Get product suggestions + | |
fullText | String! | +Text inputted by the user as the search term + | |
facetKey | String | +Selected facet key + | |
facetValue | String | +Selected facet value + | |
productOriginVtex | 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 | +If you want faster searches and do not care about most up to date prices and promotions, use skip value. + | |
hideUnavailableItems | Boolean | +If true, uses isAvailablePerSalesChannel_ parameter on query with segment's sales channel + | |
regionId | String | +Seller id encoded with base64 according to this format SW#{sellerId} + | |
salesChannel | Int | +Sales Channel related to the region ID + | |
orderBy | String | +Order by a criteria. OrderByPriceDESC/OrderByPriceASC, OrderByTopSaleDESC, OrderByReviewRateDESC, OrderByNameASC/OrderByNameDESC, OrderByReleaseDateDESC, OrderByBestDiscountDESC, OrderByScoreDESC +If you want to sort by a specification, use the format {specification key}:{asc|desc}. For example: "pricePerUnit:asc" or "size:desc" (this only works on `vtex.search-resolver@1.x`) + | |
searchURLsCount | [SearchURLStats] | +Get search urls access stats count + | |
limit | Int | +Number of items that is returned + | |
sort | SORT | +Sorting strategy, asc: ascending, desc: descending + |
Field | Argument | Type | Description |
---|---|---|---|
id | ID | ||
name | String | ||
required | Boolean | ||
composition | CompositionType | ||
inputValues | [InputValue] |
Field | Argument | Type | Description |
---|---|---|---|
id | ID | ||
name | String | ||
required | Boolean | ||
domainValues | [DomainValues] |
Field | Argument | Type | Description |
---|---|---|---|
banners | [SearchBanner] | +List of banners. + |
Field | Argument | Type | Description |
---|---|---|---|
featured | Boolean | + Flag which indicates if the benefit is featured or not + | |
id | String | + Id of the product which the benefit is associated + | |
name | String | + Name of the benefit + | |
items | [BenefitItem] | + Items of the benefit + | |
teaserType | String | + Type of benefit + |
Field | Argument | Type | Description |
---|---|---|---|
benefitProduct | Product | + Product itself + | |
benefitSKUIds | [String] | + IDs of the SKU Items that are taking part in the benefit + | |
discount | Float | + Discount applied to the benefit product + | |
minQuantity | Int | + Minimum quantity of the benefit product that is required to validate the benefit + |
Field | Argument | Type | Description |
---|---|---|---|
cacheId | ID | +slug is used as cacheId + | |
id | Int | +Brand id + | |
imageUrl | String | +Brand logo + | |
slug | String | +Text link + | |
name | String | +Name of brand + | |
titleTag | String | +Title used by html tag + | |
metaTagDescription | String | +Description used by html tag + | |
active | Boolean | +Brand is active + |
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
quantity | Int! | ||
name | String! | ||
link | String! | ||
linkEncoded | String! | ||
map | String | ||
value | String! | ||
selected | Boolean! |
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
quantity | Int! | ||
name | String | ||
link | String! | ||
linkEncoded | String! | ||
href | String! | +Contains slugified links according to the store structure. /:department/d, /:category/:subcategory, etc + | |
map | String | ||
value | String! | ||
children | [CategoriesTreeFacet] | ||
selected | Boolean! |
Field | Argument | Type | Description |
---|---|---|---|
cacheId | ID | + id is used as cacheId + | |
href | String | + URI of category + | |
slug | String | + Category text link + | |
id | Int | + Category ID + | |
name | String | + Category name + | |
titleTag | String | + Title used by html tag + | |
hasChildren | Boolean | + Description used by html tag + | |
metaTagDescription | String | + Has children categories + | |
children | [Category] | + Categories children + |
Field | Argument | Type | Description |
---|---|---|---|
id | ID | ||
name | String |
Field | Argument | Type | Description |
---|---|---|---|
id | ID | ||
minQuantity | Int | ||
maxQuantity | Int | ||
initialQuantity | Int | ||
priceTable | String | ||
seller | String |
Field | Argument | Type | Description |
---|---|---|---|
minQuantity | Int | ||
maxQuantity | Int | ||
items | [CompositionItem] |
Field | Argument | Type | Description |
---|---|---|---|
correction | SearchCorrection |
Field | Argument | Type | Description |
---|---|---|---|
TypeName | String | ||
Price | Float | ||
EstimatedTimeSpanToDelivery | String |
Field | Argument | Type | Description |
---|---|---|---|
DeliverySlaPerTypes | [DeliverySlaPerTypes] | ||
Region | Region |
Field | Argument | Type | Description |
---|---|---|---|
id | ID! | ||
quantity | Int! | ||
name | String | ||
link | String! | ||
linkEncoded | String! | ||
map | String | ||
value | String! | ||
selected | Boolean! |
Field | Argument | Type | Description |
---|---|---|---|
name | String | +Discount name + |
Field | Argument | Type | Description |
---|---|---|---|
FieldName | String | ||
MaxCaracters | String | ||
DomainValues | String |
Field | Argument | Type | Description |
---|---|---|---|
name | String | ||
values | [FacetValue] | ||
from | Int | ||
to | Int | ||
type | FilterType | ||
hidden | Boolean | ||
quantity | Int |
Field | Argument | Type | Description |
---|---|---|---|
id | ID | ||
quantity | Int! | ||
name | String | ||
key | String | ||
value | String | ||
selected | Boolean | ||
children | [FacetValue] | ||
range | Range | ||
link | String | ||
linkEncoded | String | ||
href | String |
Field | Argument | Type | Description |
---|---|---|---|
departments ⚠️ | [DepartmentFacet] | ⚠️ DEPRECATED +Use the `facets` instead. + | |
brands ⚠️ | [BrandFacet] | ⚠️ DEPRECATED +Use the `facets` instead. + | |
specificationFilters | [FilterFacets] | ||
categoriesTrees ⚠️ | [CategoriesTreeFacet] | ⚠️ DEPRECATED +Use the `facets` instead. + | |
priceRanges | [PriceRangesFacet] | +Price range for the given query. + | |
recordsFiltered ⚠️ | Int | ⚠️ DEPRECATED +Use the recordsFiltered from the `productSearch` instead. + | |
queryArgs | QueryArgs | +Info about the searched query. + | |
facets | [Facet] | +List of facets. + | |
sampling | 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] | +Generated breadcrumb for the given query. + |
Field | Argument | Type | Description |
---|---|---|---|
quantity | Int! | ||
name | String | ||
link | String! | ||
linkEncoded | String! | ||
map | String | ||
value | String! | ||
selected | Boolean! |
Field | Argument | Type | Description |
---|---|---|---|
name | String | ||
facets | [FilterFacet] |
Field | Argument | Type | Description |
---|---|---|---|
productName | String | ||
skuName | String | ||
brand | String | ||
linkText | String | ||
description | String | ||
images | [GiftImage] |
Field | Argument | Type | Description |
---|---|---|---|
imageUrl | String | ||
imageLabel | String | ||
imageText | String |
Field | Argument | Type | Description |
---|---|---|---|
cacheId | ID | ||
imageId | ID | ||
imageLabel | String | ||
imageTag | String | ||
imageUrl | String | ||
imageText | String |
Field | Argument | Type | Description |
---|---|---|---|
label | String | ||
maxLength | Int | ||
type | InputValueType | ||
defaultValue | StringOrBoolean | ||
domain | [String] |
Field | Argument | Type | Description |
---|---|---|---|
Value | Float | ||
InterestRate | Float | ||
TotalValuePlusInterestRate | Float | ||
NumberOfInstallments | Int | ||
PaymentSystemName | String | ||
PaymentSystemGroupName | String | ||
Name | String |
Field | Argument | Type | Description |
---|---|---|---|
items | [ItemMetadataUnit] | ||
priceTable | [ItemPriceTable] |
Field | Argument | Type | Description |
---|---|---|---|
id | ID | ||
name | String | ||
skuName | String | ||
productId | String | ||
refId | String | ||
ean | String | ||
imageUrl | String | ||
detailUrl | String | ||
seller | String | ||
assemblyOptions | [AssemblyOption] |
Field | Argument | Type | Description |
---|---|---|---|
type | String | ||
values | [PriceTableItem] |
Field | Argument | Type | Description |
---|---|---|---|
thumb | String | ||
name | String | ||
href | String | ||
criteria | String | ||
slug | String | ||
productId | String |
Field | Argument | Type | Description |
---|---|---|---|
itemId | ID | ||
amount | Int | ||
product | OnlyProduct | ||
sku | SKU |
Field | Argument | Type | Description |
---|---|---|---|
Installments | [Installment] | ||
criteria | InstallmentsCriteria | ||
rates | Boolean | ||
excludedPaymentSystems | [String] | ||
includedPaymentSystems | [String] | ||
Price | Float | ||
ListPrice | Float | ||
spotPrice | Float | ||
PriceWithoutDiscount | Float | ||
RewardValue | Float | ||
PriceValidUntil | String | ||
AvailableQuantity | Float | ||
Tax | Float | ||
taxPercentage | Float | ||
CacheVersionUsedToCallCheckout | String | ||
DeliverySlaSamples | [DeliverySlaSamples] | ||
discountHighlights | [Discount!] | +List of discount highlights + | |
teasers | [Teaser!] | ||
giftSkuIds | [String] | +List of SKUs for gifts associated with the product + | |
gifts | [Gift] | +List of gifts associated with the product + |
Field | Argument | Type | Description |
---|---|---|---|
brand | String | ||
categoryId | ID | ||
categoryTree | [Category] | ||
clusterHighlights | [ClusterHighlight] | ||
productClusters | [ProductClusters] | ||
description | String | ||
link | String | ||
linkText | String | ||
productId | ID | ||
productName | String | ||
properties | [Property] | ||
propertyGroups | [PropertyGroup] | ||
productReference | String | ||
recommendations | Recommendation | ||
jsonSpecifications | String |
Field | Argument | Type | Description |
---|---|---|---|
id | String | ||
type | PageEntityIdentifier |
Field | Argument | Type | Description |
---|---|---|---|
highPrice | Float | ||
lowPrice | Float |
Field | Argument | Type | Description |
---|---|---|---|
quantity | Int! | ||
name | String | ||
link | String! | ||
linkEncoded | String! | ||
map | String | ||
value | String! | ||
selected | Boolean! | ||
slug | String |
Field | Argument | Type | Description |
---|---|---|---|
id | String | ||
assemblyId | String | ||
price | Int |
Field | Argument | Type | Description |
---|---|---|---|
brand | String | +Brand of the product + | |
brandId | Int | +Id of the brand of the product + | |
cacheId | ID | +linkText is used as cacheId + | |
categoryId | ID | ||
categories ⚠️ | [String] |
+Categories of the product
+ ⚠️ DEPRECATED +Use 'categoryTree' field for internationalization support + | |
categoryTree | [Category] | +Product's categories + | |
clusterHighlights | [ClusterHighlight] | +List of related products + | |
productClusters | [ProductClusters] | ||
description | String | +Product description + | |
items | [SKU] | +SKU objects of the product + | |
filter | ItemsFilter | ||
skuSpecifications | [SkuSpecification] | +List of SKU Specifications + | |
link | String | +Product URL + | |
linkText | String | +Product slug + | |
productId | ID | +Product ID + | |
productName | String | +Product name + | |
properties | [Property] | +Array of product properties + | |
propertyGroups | [PropertyGroup] | +Array of product properties + | |
productReference | String | +Product reference + | |
titleTag | String | +Title used by html tag + | |
metaTagDescription | String | +Description used by html tag + | |
recommendations | Recommendation | +Related Products + | |
jsonSpecifications | String | +JSON specification of the product + | |
benefits | [Benefit] | +List of benefits associated with this product + | |
itemMetadata | ItemMetadata | ||
specificationGroups | [SpecificationGroup] | +Array of product SpecificationGroup + | |
priceRange | ProductPriceRange | +Returns highest and lowest prices for available SKUs in product. + | |
releaseDate | String | +Product Release Date, for list ordering and product cluster highlight + | |
selectedProperties | [SelectedProperty] | +Product properties that will be selected by default. e.g: {key: "Color", value: "Blue"} + |
Field | Argument | Type | Description |
---|---|---|---|
id | ID | ||
name | String |
Field | Argument | Type | Description |
---|---|---|---|
sellingPrice | PriceRange | ||
listPrice | PriceRange |
Field | Argument | Type | Description |
---|---|---|---|
products | [Product] | +List of products. + | |
recordsFiltered | Int | +Total number of products. + | |
titleTag | String | +Title used in the title's tag. + | |
metaTagDescription | String | +String to be used in the ` | |
breadcrumb ⚠️ | [SearchBreadcrumb] | ⚠️ DEPRECATED +Use the `breadcrumb` from the `facets` query instead. + | |
canonical | String | ||
suggestion ⚠️ | SearchSuggestions | ⚠️ DEPRECATED +Use the `suggestion` query instead. + | |
correction | SearchCorrection | +Object that indicates if the term was misspelled and suggests a possible correction. + | |
operator | Operator | +Indicates how the search-engine dealt with the fullText when there is more than one word.\n * `and` - It means that the products contains all the words in the query.\n * `or` - It means that 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 | +Indicates how the search engine corrected the misspelled word 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 | +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. + | |
banners ⚠️ | [SearchBanner] | ⚠️ DEPRECATED +Use the `banners` query instead. + | |
redirect | String | +Returns the redirect URL set for the given query. + |
Field | Argument | Type | Description |
---|---|---|---|
count | Int! | +Number of suggested products + | |
products | [Product]! | +Suggested products + | |
misspelled | Boolean | +If the term is misspelled or not + | |
operator | Operator | +Indicates how the search-engine will deal with the fullText if there is more than one word. Set `and` if the returned products must have all the words in its metadata or `or` otherwise. + |
Field | Argument | Type | Description |
---|---|---|---|
originalName | String | ||
name | String | ||
values | [String] |
Field | Argument | Type | Description |
---|---|---|---|
name | String | ||
properties | [String] |
Field | Argument | Type | Description |
---|---|---|---|
map | String | ||
query | String | ||
selectedFacets | [SelectedFacet] |
Field | Argument | Type | Description |
---|---|---|---|
from | Float | ||
to | Float |
Field | Argument | Type | Description |
---|---|---|---|
buy | [Product] | ||
view | [Product] | ||
similars | [Product] |
Field | Argument | Type | Description |
---|---|---|---|
Key | String | ||
Value | String |
Field | Argument | Type | Description |
---|---|---|---|
IsPersisted | Boolean | ||
IsRemoved | Boolean | ||
Id | ID | ||
Name | String | ||
CountryCode | String | ||
ZipCode | String | ||
CultureInfoName | String |
Field | Argument | Type | Description |
---|---|---|---|
itemId | ID | ||
name | String | ||
nameComplete | String | ||
complementName | String | ||
ean | String | ||
referenceId | [Reference] | ||
measurementUnit | String | ||
unitMultiplier | Float | ||
kitItems | [KitItem] | ||
images | [Image] | ||
quantity | Int | ||
videos | [Video] | ||
sellers | [Seller] | ||
variations | [Property] | ||
attachments ⚠️ | [Attachment] | ⚠️ DEPRECATED +Use itemMetaData instead + | |
estimatedDateArrival | String |
Field | Argument | Type | Description |
---|---|---|---|
originalName | String | ||
name | String |
Field | Argument | Type | Description |
---|---|---|---|
originalName | String | ||
name | String |
Field | Argument | Type | Description |
---|---|---|---|
id | String | +Banner ID. + | |
name | String | +Banner name. + | |
area | String | +Banner area. + | |
html | String | +Banner HTML. + |
Field | Argument | Type | Description |
---|---|---|---|
name | String | +Human-readable format of the facet key. + | |
href | String | +Query link. + |
Field | Argument | Type | Description |
---|---|---|---|
text | String | +The corrected term. If the API was not able to correct the term, it will show the original search term. + | |
highlighted | String | +The same as `text`, but it highlights the corrected word. Useful when there is more than one word. + | |
misspelled | Boolean | +Whether the term was misspelled (`true`) or not (`false`). + | |
correction | Boolean | +Whether the API was able to suggest a correction (`true`) or not (`false`). + |
Field | Argument | Type | Description |
---|---|---|---|
titleTag | String | ||
metaTagDescription | String |
Field | Argument | Type | Description |
---|---|---|---|
term | String! | +Search term. + | |
count | Int! | +Number of times the term was searched. + | |
attributes | [SearchSuggestionAttribute] | +List of facets in which the term can be searched. + |
Field | Argument | Type | Description |
---|---|---|---|
key | String! | +Facet key. + | |
value | String! | +Facet value. + | |
labelValue | String! | +Human-readable format of the facet key. + |
Field | Argument | Type | Description |
---|---|---|---|
searches | [SearchSuggestion] | +A list of search suggestions. + |
Field | Argument | Type | Description |
---|---|---|---|
path | String! | ||
count | Int! |
Field | Argument | Type | Description |
---|---|---|---|
key | String | ||
value | String |
Field | Argument | Type | Description |
---|---|---|---|
key | String | ||
value | String |
Field | Argument | Type | Description |
---|---|---|---|
sellerId | ID | ||
sellerName | String | ||
addToCartLink | String | ||
sellerDefault | Boolean | ||
commertialOffer | Offer |
Field | Argument | Type | Description |
---|---|---|---|
field | SKUSpecificationField | ||
values | [SKUSpecificationValue] |
Field | Argument | Type | Description |
---|---|---|---|
originalName | String | ||
name | String | ||
specifications | [SpecificationGroupProperty] |
Field | Argument | Type | Description |
---|---|---|---|
originalName | String | ||
name | String | ||
values | [String] |
Field | Argument | Type | Description |
---|---|---|---|
cacheId | ID | + searchTerm from Query autocomplete is used as cacheId + | |
itemsReturned | [Items] |
Field | Argument | Type | Description |
---|---|---|---|
name | String | ||
conditions | TeaserCondition | ||
effects | TeaserEffects |
Field | Argument | Type | Description |
---|---|---|---|
minimumQuantity | Int | ||
parameters | [TeaserValue] |
Field | Argument | Type | Description |
---|---|---|---|
parameters | [TeaserValue] |
Field | Argument | Type | Description |
---|---|---|---|
name | String | ||
value | String |
Field | Argument | Type | Description |
---|---|---|---|
videoUrl | String |
Field | Argument | Type | Description |
---|---|---|---|
fieldName | String | ||
fieldValues | [String] |
Field | Type | Description | |
---|---|---|---|
id | ID! | ||
quantity | Int! | ||
assemblyId | String! | ||
seller | String! | ||
options | [AssemblyOptionInput!] |
Field | Type | Description | |
---|---|---|---|
allowRedirect | Boolean | +If the search has a redirect enabled, this allows (`true`) or not (`false`) the redirect to be used. + |
Field | Type | Description | |
---|---|---|---|
field | ProductUniqueIdentifierField! | ||
value | ID! |
Field | Type | Description | |
---|---|---|---|
key | String | +# Facet key + +A key for the selected facet. + +## 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 (aka regionalization). The value is the region id | + | |
value | String | +Facet value. + |
Value | Description |
---|---|
default | +Uses the default value set by the search provider + |
show | +Show the category tree when it is possible + |
hide | +Hide the category tree in any situation + |
Value | Description |
---|---|
buy | |
similars | |
view | |
viewAndBought | |
accessories | |
suggestions |
Value | Description |
---|---|
TEXT | |
NUMBER | |
CATEGORYTREE | |
BRAND | |
PRICERANGE |
Value | Description |
---|---|
TEXT | |
BOOLEAN | |
OPTIONS |
Value | Description |
---|---|
MAX_WITHOUT_INTEREST | |
MAX_WITH_INTEREST | |
MAX | |
MIN | |
ALL |
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. + |
Value | Description |
---|---|
and | |
or |
Value | Description |
---|---|
brand | |
department | |
category | |
subcategory | |
search |
Value | Description |
---|---|
id | |
slug | |
ean | |
reference | |
sku |
Value | Description |
---|---|
ASC | |
DESC |
Value | Description |
---|---|
default | +Does simulation on catalog as usual + |
only1P | +Does simulation on catalog only for seller 1P + |
skip | +Calls catalog passing a parameter to not simulate each SKU and get its most up to date price. + |
async | +Does the simulation on the client side + |