Documentation
Feedback
Guides

Search GraphQL

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

The default implementation for this schema is on vtex.search-resolver app.

Usage

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


_10
"dependencies": {
_10
"vtex.search-graphql": "0.x"
_10
}

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


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

To resolve this query, you need to have a app that implements the schema declared in this app, such as: vtex.search-resolver.

Table of Contents

Query

FieldArgumentTypeDescription
productProductReturns a specified product
slugStringProduct slug
identifierProductUniqueIdentifierProduct identifier
regionIdStringSeller id encoded with base64 according to this format SW#{sellerId}
salesChannelIntTrade Policy
bannersBannersLists the banners registered for a given query. Check the configuring banners documentation for a full explanation of the banner feature.
fullTextStringSearch term. It can contain any character.
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.
correctionCorrectionTries to correct a misspelled term from the search.
fullTextStringSearch term. It can contain any character.
searchSuggestionsSearchSuggestionsLists suggested terms similar to the search term.
fullTextString!Search term. It can contain any character.
productSearchProductSearchLists the products for a given query.
queryStringDeprecated. Use fullText instead.
fullTextStringSearch term. It can contain any character.
mapStringDeprecated. 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.
categoryStringDeprecated. Use selectedFacets instead.
specificationFilters[String]Deprecated. Use selectedFacets instead.
priceRangeStringFilter by price range. e.g.: {a} TO {b} - {a} is the minimum price "from" and {b} is the highest price "to"
collectionStringDeprecated. Use selectedFacets instead.
salesChannelStringFilter by availability at a specific sales channel. e.g.: salesChannel:4 if want filter by available products for the sales channel 4
orderByStringSort 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.
fromIntPagination item start
toIntPagination item end
hideUnavailableItemsBooleanIf true, uses isAvailablePerSalesChannel_ parameter on query with segment's sales channel. Will override any given salesChannel arg
simulationBehaviorSimulationBehaviorIf you want faster searches and do not care about most up to date prices and promotions, use skip value.
productOriginVtexBooleanEach 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.
operatorOperatorIndicates 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.
fuzzyStringIndicates 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.
searchStateStringAs 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.
optionsOptionsSearch options that customize the search result.
searchMetadataSearchMetadata
queryStringTerms that is used in search e.g.: eletronics/samsung
fullTextStringText inputted by the user as the search term
mapStringDefines 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
queryStringTerms that is used in search e.g.: eletronics/samsung
mapStringDefines terms types: Brand, Category, Department e.g.: c,b
categoryStringFilter 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
priceRangeStringFilter by price range. e.g.: {a} TO {b} - {a} is the minimum price "from" and {b} is the highest price "to"
collectionStringFilter by collection. where collection also know as productClusterId
salesChannelStringFilter by availability at a specific sales channel. e.g.: salesChannel:4 if want filter by available products for the sales channel 4
orderByStringSort 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.
fromIntPagination item start
toIntPagination item end
hideUnavailableItemsBooleanIf true, uses isAvailablePerSalesChannel_ parameter on query with segment's sales channel. Will override any given salesChannel arg
simulationBehaviorSimulationBehaviorIf you want faster searches and do not care about most up to date prices and promotions, use skip value.
productRecommendations[Product]
identifierProductUniqueIdentifier
typeCrossSelingInputEnum
productsByIdentifier[Product]
fieldProductUniqueIdentifierField!
values[ID!]
salesChannelStringFilter by availability at a specific sales channel.
facetsFacetsReturns facets category
queryStringDeprecated. Use fullText instead.
fullTextStringSearch term. It can contain any character.
mapStringDeprecated. 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.
hideUnavailableItemsBooleanIf true, uses isAvailablePerSalesChannel_parameter on query with segment's sales channel.
removeHiddenFacetsBooleanIf true, remove hidden facets from the result.
behaviorStringIf Static, ignores SpecificationFilters received on the map and query when returning the facets available, which makes the facets never change.
operatorOperatorIndicates 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.
fuzzyStringIndicates 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.
searchStateStringAs 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.
fromIntPagination item start
toIntPagination item end
categoryTreeBehaviorCategoryTreeBehaviorDetermines the behavior of the category tree
initialAttributesStringInitial attributes (based on the initialMap parameter)
autocompleteSuggestionsGet auto complete suggestions in search
maxRowsIntNumber of items that is returned
searchTermStringTerms that is used in search e.g.: iphone
topSearchesSearchSuggestionsGet list of the 10 most searched terms
autocompleteSearchSuggestionsSearchSuggestionsLists the suggested terms and attributes similar to the search term.
fullTextString!Search term. It can contain any character.
productSuggestionsProductSuggestionsGet product suggestions
fullTextString!Text inputted by the user as the search term
facetKeyStringSelected facet key
facetValueStringSelected facet value
productOriginVtexBooleanEach 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.
simulationBehaviorSimulationBehaviorIf you want faster searches and do not care about most up to date prices and promotions, use skip value.
hideUnavailableItemsBooleanIf true, uses isAvailablePerSalesChannel_ parameter on query with segment's sales channel
regionIdStringSeller id encoded with base64 according to this format SW#{sellerId}
salesChannelIntSales Channel related to the region ID
orderByStringSort 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.
searchURLsCount[SearchURLStats]Get search urls access stats count
limitIntNumber of items that is returned
sortSORTSorting strategy, asc: ascending, desc: descending

Objects

AssemblyOption

FieldArgumentTypeDescription
idID
nameString
requiredBoolean
compositionCompositionType
inputValuesInputValue[]

Attachment

FieldArgumentTypeDescription
idID
nameString
requiredBoolean
domainValuesDomainValues[]

Banners

FieldArgumentTypeDescription
bannersSearchBanner[]List of banners.

Benefit

Benefit of a Product

FieldArgumentTypeDescription
featuredBooleanFlag which indicates if the benefit is featured or not
idStringId of the product which the benefit is associated
nameStringName of the benefit
items[BenefitItem]Items of the benefit
teaserTypeStringType of benefit

BenefitItem

FieldArgumentTypeDescription
benefitProductProductProduct itself
benefitSKUIds[String]IDs of the SKU Items that are taking part in the benefit
discountFloatDiscount applied to the benefit product
minQuantityIntMinimum quantity of the benefit product that is required to validate the benefit

Brand

FieldArgumentTypeDescription
cacheIdIDslug is used as cacheId
idIntBrand id
imageUrlStringBrand logo
slugStringText link
nameStringName of brand
titleTagStringTitle used by html tag
metaTagDescriptionStringDescription used by html tag
activeBooleanBrand is active

BrandFacet

FieldArgumentTypeDescription
idID!
quantityInt!
nameString!
linkString!
linkEncodedString!
mapString
valueString!
selectedBoolean!

CategoriesTreeFacet

FieldArgumentTypeDescription
idID!
quantityInt!
nameString
linkString!
linkEncodedString!
hrefString!Contains slugified links according to the store structure. /:department/d, /:category/:subcategory, etc
mapString
valueString!
children[CategoriesTreeFacet]
selectedBoolean!

Category

FieldArgumentTypeDescription
cacheIdIDid is used as cacheId
hrefStringURI of category
slugStringCategory text link
idIntCategory ID
nameStringCategory name
titleTagStringTitle used by html tag
hasChildrenBooleanDescription used by html tag
metaTagDescriptionStringHas children categories
children[Category]Categories children

ClusterHighlight

FieldArgumentTypeDescription
idID
nameString

CompositionItem

FieldArgumentTypeDescription
idID
minQuantityInt
maxQuantityInt
initialQuantityInt
priceTableString
sellerString

CompositionType

FieldArgumentTypeDescription
minQuantityInt
maxQuantityInt
items[CompositionItem]

Correction

FieldArgumentTypeDescription
correctionSearchCorrection

DeliverySlaPerTypes

FieldArgumentTypeDescription
TypeNameString
PriceFloat
EstimatedTimeSpanToDeliveryString

DeliverySlaSamples

FieldArgumentTypeDescription
DeliverySlaPerTypes[DeliverySlaPerTypes]
RegionRegion

DepartmentFacet

FieldArgumentTypeDescription
idID!
quantityInt!
nameString
linkString!
linkEncodedString!
mapString
valueString!
selectedBoolean!

Discount

Discount object

FieldArgumentTypeDescription
nameStringDiscount name

DomainValues

FieldArgumentTypeDescription
FieldNameString
MaxCaractersString
DomainValuesString

Facet

FieldArgumentTypeDescription
nameString
values[FacetValue]
fromInt
toInt
typeFilterType
hiddenBoolean
quantityInt

FacetValue

FieldArgumentTypeDescription
idID
quantityInt!
nameString
keyString
valueString
selectedBoolean
children[FacetValue]
rangeRange
linkString
linkEncodedString
hrefString

Facets

FieldArgumentTypeDescription
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.
queryArgsQueryArgsInfo about the searched query.
facets[Facet]List of facets.
samplingBooleanIndicates whether there was sampling in the aggregation of facets or not. In search results that have many products, only the first30000 will be aggregated to avoid performance issues.
breadcrumb[SearchBreadcrumb]Generated breadcrumb for the given query.

FilterFacet

FieldArgumentTypeDescription
quantityInt!
nameString
linkString!
linkEncodedString!
mapString
valueString!
selectedBoolean!

FilterFacets

FieldArgumentTypeDescription
nameString
facets[FilterFacet]

Gift

FieldArgumentTypeDescription
productNameString
skuNameString
brandString
linkTextString
descriptionString
images[GiftImage]

GiftImage

FieldArgumentTypeDescription
imageUrlString
imageLabelString
imageTextString

Image

FieldArgumentTypeDescription
cacheIdID
imageIdID
imageLabelString
imageTagString
imageUrlString
imageTextString

InputValue

FieldArgumentTypeDescription
labelString
maxLengthInt
typeInputValueType
defaultValueStringOrBoolean
domain[String]

Installment

FieldArgumentTypeDescription
ValueFloat
InterestRateFloat
TotalValuePlusInterestRateFloat
NumberOfInstallmentsInt
PaymentSystemNameString
PaymentSystemGroupNameString
NameString

ItemMetadata

FieldArgumentTypeDescription
items[ItemMetadataUnit]
priceTable[ItemPriceTable]

ItemMetadataUnit

FieldArgumentTypeDescription
idID
nameString
skuNameString
productIdString
refIdString
eanString
imageUrlString
detailUrlString
sellerString
assemblyOptions[AssemblyOption]

ItemPriceTable

FieldArgumentTypeDescription
typeString
values[PriceTableItem]

Items

FieldArgumentTypeDescription
thumbString
nameString
hrefString
criteriaString
slugString
productIdString

KitItem

FieldArgumentTypeDescription
itemIdID
amountInt
productOnlyProduct
skuSKU

Offer

FieldArgumentTypeDescription
Installments[Installment]
criteriaInstallmentsCriteria
ratesBoolean
excludedPaymentSystems[String]
includedPaymentSystems[String]
PriceFloat
ListPriceFloat
spotPriceFloat
PriceWithoutDiscountFloat
RewardValueFloat
PriceValidUntilString
AvailableQuantityFloat
TaxFloat
taxPercentageFloat
CacheVersionUsedToCallCheckoutString
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

OnlyProduct

FieldArgumentTypeDescription
brandString
categoryIdID
categoryTree[Category]
clusterHighlights[ClusterHighlight]
productClusters[ProductClusters]
descriptionString
linkString
linkTextString
productIdID
productNameString
properties[Property]
propertyGroups[PropertyGroup]
productReferenceString
recommendationsRecommendation
jsonSpecificationsString

PageType

FieldArgumentTypeDescription
idString
typePageEntityIdentifier

PriceRange

FieldArgumentTypeDescription
highPriceFloat
lowPriceFloat

PriceRangesFacet

FieldArgumentTypeDescription
quantityInt!
nameString
linkString!
linkEncodedString!
mapString
valueString!
selectedBoolean!
slugString

PriceTableItem

FieldArgumentTypeDescription
idString
assemblyIdString
priceInt

Product

FieldArgumentTypeDescription
brandStringBrand of the product
brandIdIntId of the brand of the product
cacheIdIDlinkText is used as cacheId
categoryIdID
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]
descriptionStringProduct description
items[SKU]SKU objects of the product
filterItemsFilter
skuSpecifications[SkuSpecification]List of SKU Specifications
linkStringProduct URL
linkTextStringProduct slug
productIdIDProduct ID
productNameStringProduct name
properties[Property]Array of product properties
propertyGroups[PropertyGroup]Array of product properties
productReferenceStringProduct reference
titleTagStringTitle used by html tag
metaTagDescriptionStringDescription used by html tag
recommendationsRecommendationRelated Products
jsonSpecificationsStringJSON specification of the product
benefits[Benefit]List of benefits associated with this product
itemMetadataItemMetadata
specificationGroups[SpecificationGroup]Array of product SpecificationGroup
priceRangeProductPriceRangeReturns highest and lowest prices for available SKUs in product.
releaseDateStringProduct 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"}

ProductClusters

FieldArgumentTypeDescription
idID
nameString

ProductPriceRange

FieldArgumentTypeDescription
sellingPricePriceRange
listPricePriceRange

ProductSearch

FieldArgumentTypeDescription
products[Product]List of products.
recordsFilteredIntTotal number of products.
titleTagStringTitle used in the title's tag.
metaTagDescriptionStringString to be used in the <meta name="description"... tag.
breadcrumb ⚠️[SearchBreadcrumb]

⚠️ DEPRECATED

Use the breadcrumb from the facets query instead.
canonicalString
suggestion ⚠️SearchSuggestions

⚠️ DEPRECATED

Use the suggestion query instead.
correctionSearchCorrectionObject that indicates if the term was misspelled and suggests a possible correction.
operatorOperatorIndicates how the search-engine dealt with the fullText when there is more than one word.\n and - It means that theproducts contains all the words in the query.\n or - It means that the results will contain at least one word from theoriginal search query. If and was not possible, or will be the fallback.
fuzzyStringIndicates 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.
searchStateStringAs 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]

⚠️ DEPRECATED

Use the banners query instead.
redirectStringReturns the redirect URL set for the given query.

ProductSuggestions

FieldArgumentTypeDescription
countInt!Number of suggested products
products[Product]!Suggested products
misspelledBooleanIf the term is misspelled or not
operatorOperatorIndicates 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.

Property

FieldArgumentTypeDescription
originalNameString
nameString
values[String]

PropertyGroup

FieldArgumentTypeDescription
nameString
properties[String]

QueryArgs

FieldArgumentTypeDescription
mapString
queryString
selectedFacets[SelectedFacet]

Range

FieldArgumentTypeDescription
fromFloat
toFloat

Recommendation

FieldArgumentTypeDescription
buy[Product]
view[Product]
similars[Product]

Reference

FieldArgumentTypeDescription
KeyString
ValueString

Region

FieldArgumentTypeDescription
IsPersistedBoolean
IsRemovedBoolean
IdID
NameString
CountryCodeString
ZipCodeString
CultureInfoNameString

SKU

FieldArgumentTypeDescription
itemIdID
nameString
nameCompleteString
complementNameString
eanString
referenceId[Reference]
measurementUnitString
unitMultiplierFloat
kitItems[KitItem]
images[Image]
quantityInt
videos[Video]
sellers[Seller]
variations[Property]
attachments ⚠️[Attachment]

⚠️ DEPRECATED

Use itemMetaData instead
estimatedDateArrivalString

SKUSpecificationField

FieldArgumentTypeDescription
originalNameString
nameString

SKUSpecificationValue

FieldArgumentTypeDescription
originalNameString
nameString

SearchBanner

FieldArgumentTypeDescription
idStringBanner ID.
nameStringBanner name.
areaStringBanner area.
htmlStringBanner HTML.

SearchBreadcrumb

FieldArgumentTypeDescription
nameStringHuman-readable format of the facet key.
hrefStringQuery link.

SearchCorrection

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

FieldArgumentTypeDescription
textStringThe corrected term. If the API was not able to correct the term, it will show the original search term.
highlightedStringThe same as text, but it highlights the corrected word. Useful when there is more than one word.
misspelledBooleanWhether the term was misspelled (true) or not (false).
correctionBooleanWhether the API was able to suggest a correction (true) or not (false).

SearchMetadata

FieldArgumentTypeDescription
titleTagString
metaTagDescriptionString

SearchSuggestion

FieldArgumentTypeDescription
termString!Search term.
countInt!Number of times the term was searched.
attributes[SearchSuggestionAttribute]List of facets in which the term can be searched.

SearchSuggestionAttribute

FieldArgumentTypeDescription
keyString!Facet key.
valueString!Facet value.
labelValueString!Human-readable format of the facet key.

SearchSuggestions

FieldArgumentTypeDescription
searches[SearchSuggestion]A list of search suggestions.

SearchURLStats

FieldArgumentTypeDescription
pathString!
countInt!

SelectedFacet

FieldArgumentTypeDescription
keyString
valueString

SelectedProperty

FieldArgumentTypeDescription
keyString
valueString

Seller

FieldArgumentTypeDescription
sellerIdID
sellerNameString
addToCartLinkString
sellerDefaultBoolean
commertialOfferOffer

SkuSpecification

FieldArgumentTypeDescription
fieldSKUSpecificationField
values[SKUSpecificationValue]

SpecificationGroup

FieldArgumentTypeDescription
originalNameString
nameString
specifications[SpecificationGroupProperty]

SpecificationGroupProperty

FieldArgumentTypeDescription
originalNameString
nameString
values[String]

Suggestions

FieldArgumentTypeDescription
cacheIdIDsearchTerm from Query autocomplete is used as cacheId
itemsReturned[Items]

Teaser

FieldArgumentTypeDescription
nameString
conditionsTeaserCondition
effectsTeaserEffects

TeaserCondition

FieldArgumentTypeDescription
minimumQuantityInt
parameters[TeaserValue]

TeaserEffects

FieldArgumentTypeDescription
parameters[TeaserValue]

TeaserValue

FieldArgumentTypeDescription
nameString
valueString

Video

FieldArgumentTypeDescription
videoUrlString

productSpecification

FieldArgumentTypeDescription
fieldNameString
fieldValues[String]

Inputs

AssemblyOptionInput

FieldTypeDescription
idID!
quantityInt!
assemblyIdString!
sellerString!
options[AssemblyOptionInput!]

Options

FieldTypeDescription
allowRedirectBooleanIf the search has a redirect enabled, this allows (true) or not (false) the redirect to be used.

ProductUniqueIdentifier

FieldTypeDescription
fieldProductUniqueIdentifierField!
valueID!

SelectedFacetInput

FieldTypeDescription
keyStringA key for the selected facet.
valueStringFacet value.

General filters

The key parameter also allows the following general filters.

facetKeyDescription
category-${n}Filter the search by category, where n represents the category tree level (1 = department, 2 = category, 3 = subcategory, and so on)
region-idFilter the search by a region id (aka regionalization). The value is the region id

Enums

CategoryTreeBehavior

ValueDescription
defaultUses the default value set by the search provider
showShow the category tree when it is possible
hideHide the category tree in any situation

CrossSelingInputEnum

ValueDescription
buy
similars
view
viewAndBought
accessories
suggestions

FilterType

ValueDescription
TEXT
NUMBER
CATEGORYTREE
BRAND
PRICERANGE

InputValueType

ValueDescription
TEXT
BOOLEAN
OPTIONS

InstallmentsCriteria

ValueDescription
MAX_WITHOUT_INTEREST
MAX_WITH_INTEREST
MAX
MIN
ALL

ItemsFilter

ValueDescription
ALLReturns all items, same as no filter.
FIRST_AVAILABLEReturns only the first available item. Returns first if no item is available.
ALL_AVAILABLEReturns all available items. Returns first if no item is available.

Operator

ValueDescription
and
or

PageEntityIdentifier

ValueDescription
brand
department
category
subcategory
search

ProductUniqueIdentifierField

ValueDescription
id
slug
ean
reference
sku

SORT

ValueDescription
ASC
DESC

SimulationBehavior

ValueDescription
defaultDoes simulation on catalog as usual
only1PDoes simulation on catalog only for seller 1P
skipCalls catalog passing a parameter to not simulate each SKU and get its most up to date price.
asyncDoes 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.

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

Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
Was this helpful?
Yes
No
Suggest edits (Github)
Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
On this page