### Example Variables for GraphQL Product Search Query

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Provides an example JSON object demonstrating the structure and typical values for variables used with the `ProductSearch` GraphQL query. It includes placeholders and example values for various search parameters like `query`, `selectedFacets`, `orderBy`, and pagination.

```JSON
{
  "query": "",
  "fullText": "",
  "map": "",
  "selectedFacets": [SelectedFacetInput],
  "category": "",
  "specificationFilters": ["xyz789"],
  "priceRange": "",
  "collection": "",
  "salesChannel": "",
  "orderBy": "OrderByScoreDESC",
  "from": 0,
  "to": 9,
  "hideUnavailableItems": false,
  "simulationBehavior": "default",
  "productOriginVtex": false,
  "operator": "and",
  "fuzzy": "abc123",
  "searchState": "abc123",
  "options": Options
}
```

--------------------------------

### GraphQL Query Example for Search Suggestions

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Illustrates the usage of the `searchSuggestions` GraphQL query to get suggested search terms based on a provided `fullText` input. The query returns a list of search suggestions.

```GraphQL
query SearchSuggestions($fullText: String!) {
  searchSuggestions(fullText: $fullText) {
    searches {
      ...SearchSuggestionFragment
    }
  }
}
```

```JSON
{"fullText": "xyz789"}
```

--------------------------------

### Product-like Object Example Structure

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

An example JSON structure representing a product or a similar entity, detailing various fields and their potential types or values.

```APIDOC
{
  "brand": "abc123",
  "categoryId": "4",
  "categoryTree": [Category],
  "clusterHighlights": [ClusterHighlight],
  "productClusters": [ProductClusters],
  "description": "xyz789",
  "link": "xyz789",
  "linkText": "abc123",
  "productId": "4",
  "productName": "abc123",
  "properties": [Property],
  "propertyGroups": [PropertyGroup],
  "productReference": "xyz789",
  "recommendations": Recommendation,
  "jsonSpecifications": "xyz789"
}
```

--------------------------------

### Options Input Type Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines input fields for search options, such as allowing redirects, and provides an example of how to set these options.

```APIDOC
Input Fields:
  `allowRedirect` - `Boolean`: If the search has a redirect enabled, this allows (`true`) or not (`false`) the redirect to be used.

Example:
  {"allowRedirect": true}
```

--------------------------------

### Product Object Example Structure

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Illustrates the comprehensive structure of a product object, detailing various fields such as brand, categories, items, and pricing information. This example represents a typical product data payload.

```JSON
{
  "brand": "abc123",
  "brandId": 987,
  "cacheId": "4",
  "categoryId": 4,
  "categories": ["abc123"],
  "categoryTree": [Category],
  "clusterHighlights": [ClusterHighlight],
  "productClusters": [ProductClusters],
  "description": "xyz789",
  "items": [SKU],
  "skuSpecifications": [SkuSpecification],
  "link": "abc123",
  "linkText": "abc123",
  "productId": "4",
  "productName": "abc123",
  "properties": [Property],
  "propertyGroups": [PropertyGroup],
  "productReference": "xyz789",
  "titleTag": "xyz789",
  "metaTagDescription": "xyz789",
  "recommendations": Recommendation,
  "jsonSpecifications": "xyz789",
  "benefits": [Benefit],
  "itemMetadata": ItemMetadata,
  "specificationGroups": [SpecificationGroup],
  "priceRange": ProductPriceRange,
  "releaseDate": "xyz789",
  "selectedProperties": [SelectedProperty]
}
```

--------------------------------

### Example Variables for Products GraphQL Query

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Provides an example JSON structure for the variables used with the `Products` GraphQL query. This demonstrates how to pass parameters such as search query, category, specification filters, price range, sales channel, ordering, and pagination details.

```JSON
{
  "query": "",
  "map": "",
  "category": "",
  "specificationFilters": ["xyz789"],
  "priceRange": "",
  "collection": "",
  "salesChannel": "",
  "orderBy": "OrderByScoreDESC",
  "from": 0,
  "to": 9,
  "hideUnavailableItems": false,
  "simulationBehavior": "default"
}
```

--------------------------------

### ProductSuggestions API Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines the structure for product suggestions, including the count of suggested products, the products themselves, and indicators for misspelling and search operator. Provides an example JSON structure for ProductSuggestions.

```APIDOC
ProductSuggestions:
  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.
```

```JSON
{
  "count": 987,
  "products": [Product],
  "misspelled": true,
  "operator": "and"
}
```

--------------------------------

### SelectedProperty API Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Describes a selected property with its key and value, along with an example JSON structure.

```APIDOC
SelectedProperty:
  key: String
  value: String
```

```json
{
  "key": "xyz789",
  "value": "xyz789"
}
```

--------------------------------

### Example GraphQL query for product data

Source: https://github.com/vtex-apps/search-graphql/blob/master/docs/README.md

This GraphQL query demonstrates how to fetch product data by slug using the `vtex.search-graphql` provider. It retrieves the product name for a given slug.

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

--------------------------------

### Installment Object Type Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines the Installment object type, detailing the properties of a single installment payment, including its value, interest rate, total value, number of installments, and payment system names.

```APIDOC
Installment:
  Fields:
    - Value: Float
    - InterestRate: Float
    - TotalValuePlusInterestRate: Float
    - NumberOfInstallments: Int
    - PaymentSystemName: String
    - PaymentSystemGroupName: String
    - Name: String
```

```JSON
{
  "Value": 123.45,
  "InterestRate": 123.45,
  "TotalValuePlusInterestRate": 123.45,
  "NumberOfInstallments": 123,
  "PaymentSystemName": "abc123",
  "PaymentSystemGroupName": "abc123",
  "Name": "xyz789"
}
```

--------------------------------

### SearchSuggestions API Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Describes the SearchSuggestions object, which contains a list of individual search suggestions, along with an example JSON structure.

```APIDOC
SearchSuggestions:
  searches: [SearchSuggestion] - A list of search suggestions.
```

```json
{"searches": [SearchSuggestion]}
```

--------------------------------

### SearchMetadata API Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines metadata fields for search results, such as titleTag and metaTagDescription, with an accompanying JSON example.

```APIDOC
SearchMetadata:
  titleTag: String
  metaTagDescription: String
```

```json
{
  "titleTag": "abc123",
  "metaTagDescription": "abc123"
}
```

--------------------------------

### Discount Object Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines the structure of a Discount object, which primarily contains its name. The example shows a simple JSON representation of a discount.

```APIDOC
Discount:
  name: String
```

```JSON
{"name": "abc123"}
```

--------------------------------

### SelectedFacet API Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Describes a selected facet with its key and value, along with an example JSON structure.

```APIDOC
SelectedFacet:
  key: String
  value: String
```

```json
{
  "key": "xyz789",
  "value": "xyz789"
}
```

--------------------------------

### Example GraphQL Query for Top Searches

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

An illustrative GraphQL query to fetch the top 10 most searched terms. This example demonstrates how to retrieve search suggestions using a fragment.

```GraphQL
query TopSearches {
  topSearches {
    searches {
      ...SearchSuggestionFragment
    }
  }
}
```

--------------------------------

### Example JSON for AssemblyOptionInput Type

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

A sample JSON object representing an instance of the `AssemblyOptionInput` GraphQL type. It illustrates typical values for its fields, including nested `AssemblyOptionInput` objects.

```JSON
{
  "id": 4,
  "quantity": 123,
  "assemblyId": "abc123",
  "seller": "xyz789",
  "options": [AssemblyOptionInput]
}
```

--------------------------------

### SearchURLStats API Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines the structure for search URL statistics, including the path and count, with an example JSON representation.

```APIDOC
SearchURLStats:
  path: String!
  count: Int!
```

```json
{"path": "xyz789", "count": 987}
```

--------------------------------

### SearchSuggestion API Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Describes a search suggestion object, including the search term, its count, and a list of associated attributes, along with an example JSON structure.

```APIDOC
SearchSuggestion:
  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.
```

```json
{
  "term": "xyz789",
  "count": 123,
  "attributes": [SearchSuggestionAttribute]
}
```

--------------------------------

### PriceTableItem Type Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines the structure for an item in a price table, including ID, assembly ID, and price, along with an example.

```APIDOC
Fields:
  `id` - `String`
  `assemblyId` - `String`
  `price` - `Int`

Example:
  {
    "id": "abc123",
    "assemblyId": "abc123",
    "price": 123
  }
```

--------------------------------

### Example Response for Products GraphQL Query

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Illustrates the expected JSON structure of the response from the `Products` GraphQL query. It shows the various fields returned for a product, including nested objects for categories, items, specifications, and pricing, providing a clear understanding of the data shape.

```JSON
{
  "data": {
    "products": {
      "brand": "xyz789",
      "brandId": 123,
      "cacheId": 4,
      "categoryId": "4",
      "categories": ["abc123"],
      "categoryTree": [Category],
      "clusterHighlights": [ClusterHighlight],
      "productClusters": [ProductClusters],
      "description": "abc123",
      "items": [SKU],
      "skuSpecifications": [SkuSpecification],
      "link": "xyz789",
      "linkText": "xyz789",
      "productId": "4",
      "productName": "abc123",
      "properties": [Property],
      "propertyGroups": [PropertyGroup],
      "productReference": "abc123",
      "titleTag": "abc123",
      "metaTagDescription": "abc123",
      "recommendations": Recommendation,
      "jsonSpecifications": "xyz789",
      "benefits": [Benefit],
      "itemMetadata": ItemMetadata,
      "specificationGroups": [SpecificationGroup],
      "priceRange": ProductPriceRange,
      "releaseDate": "xyz789",
      "selectedProperties": [SelectedProperty]
    }
  }
}
```

--------------------------------

### Installment API Definition

Source: https://github.com/vtex-apps/search-graphql/blob/master/docs/README.md

Defines the structure for an Installment object, detailing financial information related to payment installments, including value, interest rates, total value, number of installments, and payment system names.

```APIDOC
Installment:
  Value: Float
  InterestRate: Float
  TotalValuePlusInterestRate: Float
  NumberOfInstallments: Int
  PaymentSystemName: String
  PaymentSystemGroupName: String
  Name: String
```

--------------------------------

### Example JSON for BenefitItem Type

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

A sample JSON object representing an instance of the `BenefitItem` GraphQL type. It illustrates typical values for its fields, including a product reference, SKU IDs, discount, and minimum quantity.

```JSON
{
  "benefitProduct": Product,
  "benefitSKUIds": ["abc123"],
  "discount": 987.65,
  "minQuantity": 987
}
```

--------------------------------

### Generic JSON Object Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

An example of a generic JSON object structure, possibly representing a search result item or a similar entity.

```json
{
  "id": "abc123",
  "name": "xyz789",
  "area": "xyz789",
  "html": "xyz789"
}
```

--------------------------------

### ProductClusters API Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines the structure for product clusters, including their unique identifier and name. Provides an example JSON representation of a ProductCluster object.

```APIDOC
ProductClusters:
  id: ID
  name: String
```

```JSON
{"id": 4, "name": "xyz789"}
```

--------------------------------

### Example GraphQL Query for Search URLs Count

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Illustrative GraphQL query to fetch search URL access counts. This example demonstrates how to use the `limit` and `sort` variables to control the query's output.

```GraphQL
query SearchURLsCount(
  $limit: Int,
  $sort: SORT
) {
  searchURLsCount(
    limit: $limit,
    sort: $sort
  ) {
    path
    count
  }
}
```

--------------------------------

### SearchSuggestionAttribute API Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines the structure for a search suggestion attribute, including its key, value, and human-readable label, with an example JSON representation.

```APIDOC
SearchSuggestionAttribute:
  key: String! - Facet key.
  value: String! - Facet value.
  labelValue: String! - Human-readable format of the facet key.
```

```json
{
  "key": "xyz789",
  "value": "abc123",
  "labelValue": "abc123"
}
```

--------------------------------

### APIDOC: CompositionItem Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines the structure for an item within a product composition, including quantity constraints and pricing details.

```APIDOC
CompositionItem:
  id: ID
  minQuantity: Int
  maxQuantity: Int
  initialQuantity: Int
  priceTable: String
  seller: String
```

```JSON
{
  "id": 4,
  "minQuantity": 123,
  "maxQuantity": 987,
  "initialQuantity": 123,
  "priceTable": "xyz789",
  "seller": "abc123"
}
```

--------------------------------

### Seller API Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines the structure for a seller, including seller ID, name, add-to-cart link, default status, and commercial offer, with an example JSON representation.

```APIDOC
Seller:
  sellerId: ID
  sellerName: String
  addToCartLink: String
  sellerDefault: Boolean
  commertialOffer: Offer
```

```json
{
  "sellerId": "4",
  "sellerName": "abc123",
  "addToCartLink": "xyz789",
  "sellerDefault": false,
  "commertialOffer": Offer
}
```

--------------------------------

### JSON Response for Product Suggestions Query

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Example JSON response structure returned by the `ProductSuggestions` GraphQL query. It illustrates the format of the data, including the total count of suggestions, a list of products, and flags for misspelling or operator usage.

```JSON
{
  "data": {
    "productSuggestions": {
      "count": 987,
      "products": [Product],
      "misspelled": false,
      "operator": "and"
    }
  }
}
```

--------------------------------

### ProductPriceRange API Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines the price range structure for products, including selling and list prices, both referencing the PriceRange type. Includes an example JSON structure for ProductPriceRange.

```APIDOC
ProductPriceRange:
  sellingPrice: PriceRange
  listPrice: PriceRange
```

```JSON
{
  "sellingPrice": PriceRange,
  "listPrice": PriceRange
}
```

--------------------------------

### ProductSearch API Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Describes the ProductSearch object, which encapsulates search results including products, total records, SEO metadata, breadcrumbs, and search correction/suggestion details. Provides an example JSON structure for a ProductSearch response.

```APIDOC
ProductSearch:
  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 <meta name="description"... tag
  breadcrumb: [SearchBreadcrumb] - Use the `breadcrumb` from the `facets` query instead.
  canonical: String
  suggestion: SearchSuggestions - 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] - Use the `banners` query instead.
  redirect: String - Returns the redirect url set for the given query.
```

```JSON
{
  "products": [Product],
  "recordsFiltered": 987,
  "titleTag": "xyz789",
  "metaTagDescription": "xyz789",
  "breadcrumb": [SearchBreadcrumb],
  "canonical": "abc123",
  "suggestion": SearchSuggestions,
  "correction": SearchCorrection,
  "operator": "and",
  "fuzzy": "abc123",
  "searchState": "abc123",
  "banners": [SearchBanner],
  "redirect": "abc123"
}
```

--------------------------------

### Example JSON for AssemblyOption Type

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

A sample JSON object representing an instance of the `AssemblyOption` GraphQL type. It shows typical values for its fields, including a boolean for `required` and references to other types.

```JSON
{
  "id": "4",
  "name": "xyz789",
  "required": true,
  "composition": CompositionType,
  "inputValues": [InputValue]
}
```

--------------------------------

### Example Variables for Search URLs Count Query

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

A JSON object providing example variable values for the `searchURLsCount` GraphQL query. It sets a limit of 100 items and specifies an ascending sort order.

```JSON
{"limit": 100, "sort": "ASC"}
```

--------------------------------

### Example JSON Structure for Product Item

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Illustrates a typical JSON structure for a product item, showing various identifiers and attributes like ID, name, SKU, product ID, reference ID, EAN, image URL, detail URL, seller, and assembly options.

```JSON
{
  "id": "4",
  "name": "xyz789",
  "skuName": "xyz789",
  "productId": "xyz789",
  "refId": "abc123",
  "ean": "abc123",
  "imageUrl": "xyz789",
  "detailUrl": "abc123",
  "seller": "abc123",
  "assemblyOptions": [AssemblyOption]
}
```

--------------------------------

### PriceRange Type Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines the structure for specifying a price range with high and low price values, including an example.

```APIDOC
Fields:
  `highPrice` - `Float`
  `lowPrice` - `Float`

Example:
  {"highPrice": 987.65, "lowPrice": 987.65}
```

--------------------------------

### GraphQL Query Example for Search Metadata

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

An example of how to use the `searchMetadata` GraphQL query to retrieve title and meta description tags for a given search context. It demonstrates the structure for providing query, fullText, map, and selectedFacets as variables.

```GraphQL
query SearchMetadata(
  $query: String,
  $fullText: String,
  $map: String,
  $selectedFacets: [SelectedFacetInput]
) {
  searchMetadata(
    query: $query,
    fullText: $fullText,
    map: $map,
    selectedFacets: $selectedFacets
  ) {
    titleTag
    metaTagDescription
  }
}
```

```JSON
{
  "query": "",
  "fullText": "",
  "map": "",
  "selectedFacets": [SelectedFacetInput]
}
```

```JSON
{
  "data": {
    "searchMetadata": {
      "titleTag": "xyz789",
      "metaTagDescription": "abc123"
    }
  }
}
```

--------------------------------

### Example for Boolean GraphQL Scalar Type

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

A simple example showing a valid value for the `Boolean` GraphQL scalar type. It demonstrates the basic representation of a boolean value.

```JSON
true
```

--------------------------------

### Example JSON for Banners Type

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

A sample JSON object representing an instance of the `Banners` GraphQL type. It illustrates the structure for a list of `SearchBanner` objects.

```JSON
{"banners": [SearchBanner]}
```

--------------------------------

### Example Variables for `facets` GraphQL Query

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

A JSON object providing sample values for the variables used in the `facets` GraphQL query, illustrating how to pass parameters like `fullText`, `selectedFacets`, and pagination details.

```JSON
{
  "query": "",
  "fullText": "",
  "map": "",
  "selectedFacets": [],
  "hideUnavailableItems": false,
  "removeHiddenFacets": false,
  "behavior": "Static",
  "operator": "and",
  "fuzzy": "xyz789",
  "searchState": "abc123",
  "from": 987,
  "to": 123,
  "categoryTreeBehavior": "default",
  "initialAttributes": "xyz789"
}
```

--------------------------------

### APIDOC: DeliverySlaSamples Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines the structure for delivery SLA samples, including a list of delivery SLA types and region information.

```APIDOC
DeliverySlaSamples:
  DeliverySlaPerTypes: [DeliverySlaPerTypes]
  Region: Region
```

```JSON
{
  "DeliverySlaPerTypes": [DeliverySlaPerTypes],
  "Region": Region
}
```

--------------------------------

### Example Response for Search URLs Count Query

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

A sample JSON response demonstrating the data structure returned by the `searchURLsCount` GraphQL query. It includes the `path` and `count` for a specific search URL.

```JSON
{
  "data": {
    "searchURLsCount": {
      "path": "xyz789",
      "count": 987
    }
  }
}
```

--------------------------------

### PriceRangesFacet Type Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines the structure for a price range facet, including quantity, name, links, and selection status, with a detailed example.

```APIDOC
Fields:
  `quantity` - `Int!`
  `name` - `String`
  `link` - `String!`
  `linkEncoded` - `String!`
  `map` - `String`
  `value` - `String!`
  `selected` - `Boolean!`
  `slug` - `String`

Example:
  {
    "quantity": 987,
    "name": "abc123",
    "link": "abc123",
    "linkEncoded": "abc123",
    "map": "xyz789",
    "value": "abc123",
    "selected": false,
    "slug": "xyz789"
  }
```

--------------------------------

### JSON Variables for Product Suggestions Query

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Example JSON object containing variables to be used with the `ProductSuggestions` GraphQL query. This demonstrates how to pass parameters like full text, facet keys, simulation behavior, and sales channel to customize the product suggestion results.

```JSON
{
  "fullText": "abc123",
  "facetKey": "abc123",
  "facetValue": "abc123",
  "productOriginVtex": false,
  "simulationBehavior": "default",
  "hideUnavailableItems": true,
  "regionId": "xyz789",
  "salesChannel": 123,
  "orderBy": "OrderByScoreDESC"
}
```

--------------------------------

### SearchBreadcrumb API Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines the structure of a search breadcrumb item, including its name and query link, along with an example JSON representation.

```APIDOC
SearchBreadcrumb:
  name: String - Human-readable format of the facet key.
  href: String - Query link.
```

```json
{
  "name": "abc123",
  "href": "abc123"
}
```

--------------------------------

### Example GraphQL Query for `facets`

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

A sample GraphQL query demonstrating how to retrieve various facet types (departments, brands, filters, categories, price ranges) using the `facets` query with multiple input variables.

```GraphQL
query Facets(
  $query: String,
  $fullText: String,
  $map: String,
  $selectedFacets: [SelectedFacetInput],
  $hideUnavailableItems: Boolean,
  $removeHiddenFacets: Boolean,
  $behavior: String,
  $operator: Operator,
  $fuzzy: String,
  $searchState: String,
  $from: Int,
  $to: Int,
  $categoryTreeBehavior: CategoryTreeBehavior,
  $initialAttributes: String
) {
  facets(
    query: $query,
    fullText: $fullText,
    map: $map,
    selectedFacets: $selectedFacets,
    hideUnavailableItems: $hideUnavailableItems,
    removeHiddenFacets: $removeHiddenFacets,
    behavior: $behavior,
    operator: $operator,
    fuzzy: $fuzzy,
    searchState: $searchState,
    from: $from,
    to: $to,
    categoryTreeBehavior: $categoryTreeBehavior,
    initialAttributes: $initialAttributes
  ) {
    departments {
      ...DepartmentFacetFragment
    }
    brands {
      ...BrandFacetFragment
    }
    specificationFilters {
      ...FilterFacetsFragment
    }
    categoriesTrees {
      ...CategoriesTreeFacetFragment
    }
    priceRanges {
      ...PriceRangesFacetFragment
    }
    recordsFiltered
    queryArgs {
      ...QueryArgsFragment
    }
    facets {
      ...FacetFragment
    }
    sampling
    breadcrumb {
      ...SearchBreadcrumbFragment
    }
  }
}
```

--------------------------------

### Generic JSON Data Structure Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

An example of a generic JSON data structure, possibly representing a facet or item with common properties like ID, quantity, name, and links.

```JSON
{
  "id": "4",
  "quantity": 987,
  "name": "xyz789",
  "link": "xyz789",
  "linkEncoded": "abc123",
  "map": "xyz789",
  "value": "xyz789",
  "selected": false
}
```

--------------------------------

### SelectedFacetInput API Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines the input structure for a selected facet, including its key and value, and details general filters applicable to the key. An example JSON is provided.

```APIDOC
SelectedFacetInput:
  key: String - Facet key
    General filters:
      facetKey: Description
      category-${n}: Filter the search by a price range. The facet value follows the format ${minPrice}:${maxPrice}
      region-id: Filter the search by a region id (aka regionalization). The value is the region id
  value: String - Facet value
```

```json
{
  "key": "xyz789",
  "value": "abc123"
}
```

--------------------------------

### Example Response for Top Searches Query

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

A sample JSON response demonstrating the data structure returned by the `topSearches` GraphQL query. It contains a data object with an array of `SearchSuggestion` objects.

```JSON
{
  "data": {
    "topSearches": {"searches": [SearchSuggestion]}
  }
}
```

--------------------------------

### Generic Object Structure Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

An example of a generic object structure that includes a name and a list of facets, likely representing a filterable entity within the search context.

```JSON
{
  "name": "xyz789",
  "facets": [FilterFacet]
}
```

--------------------------------

### APIDOC: CompositionType Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines the structure for a product composition, including overall quantity constraints and a list of composition items.

```APIDOC
CompositionType:
  minQuantity: Int
  maxQuantity: Int
  items: [CompositionItem]
```

```JSON
{
  "minQuantity": 987,
  "maxQuantity": 123,
  "items": [CompositionItem]
}
```

--------------------------------

### APIDOC: CrossSelingInputEnum Values and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines the possible values for cross-selling input, indicating different types of related product suggestions.

```APIDOC
CrossSelingInputEnum (Enum):
  buy
  similars
  view
  viewAndBought
  accessories
  suggestions
```

```JSON
"buy"
```

--------------------------------

### Example Response for `facets` GraphQL Query

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

A sample JSON response structure returned by the `facets` GraphQL query, showing the typical data format for departments, brands, filters, categories, price ranges, and other search-related information.

```JSON
{
  "data": {
    "facets": {
      "departments": [DepartmentFacet],
      "brands": [BrandFacet],
      "specificationFilters": [FilterFacets],
      "categoriesTrees": [CategoriesTreeFacet],
      "priceRanges": [PriceRangesFacet],
      "recordsFiltered": 123,
      "queryArgs": QueryArgs,
      "facets": [Facet],
      "sampling": false,
      "breadcrumb": [SearchBreadcrumb]
    }
  }
}
```

--------------------------------

### JSON Example: Generic Filter Object

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

An example of a JSON object used to specify a filter, typically for search or data retrieval, by defining a field and its corresponding value.

```JSON
{"field": "id", "value": "4"}
```

--------------------------------

### APIDOC: ClusterHighlight Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines the structure for a cluster highlight, typically used for product clusters or promotions.

```APIDOC
ClusterHighlight:
  id: ID
  name: String
```

```JSON
{"id": 4, "name": "xyz789"}
```

--------------------------------

### Example JSON for Attachment Type

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

A sample JSON object representing an instance of the `Attachment` GraphQL type. It shows typical values for its fields, including a boolean for `required` and a reference to `DomainValues`.

```JSON
{
  "id": "4",
  "name": "xyz789",
  "required": true,
  "domainValues": [DomainValues]
}
```

--------------------------------

### DomainValues Object Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines the structure for domain-specific values, including the field name, maximum characters allowed, and the actual domain values. The example illustrates a JSON object conforming to this structure.

```APIDOC
DomainValues:
  FieldName: String
  MaxCaracters: String
  DomainValues: String
```

```JSON
{
  "FieldName": "xyz789",
  "MaxCaracters": "xyz789",
  "DomainValues": "abc123"
}
```

--------------------------------

### Offer Object Definition in VTEX Search GraphQL API

Source: https://github.com/vtex-apps/search-graphql/blob/master/docs/README.md

This snippet provides the detailed structure of the 'Offer' object, including its fields and their respective types. It covers pricing details, installment criteria, available quantities, tax information, and associated promotional elements like discounts and gifts.

```APIDOC
Offer:
  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.
```

--------------------------------

### Example JSON for Benefit Type

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

A sample JSON object representing an instance of the `Benefit` GraphQL type. It shows typical values for its fields, including a boolean flag, string identifiers, and a list of `BenefitItem` objects.

```JSON
{
  "featured": false,
  "id": "xyz789",
  "name": "xyz789",
  "items": [BenefitItem],
  "teaserType": "abc123"
}
```

--------------------------------

### Example Response for GraphQL Product Search Query

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Illustrates the expected JSON structure of the response returned by the `ProductSearch` GraphQL query. It shows the `products` array, `recordsFiltered` count, SEO metadata (`titleTag`, `metaTagDescription`), and other search-related objects like `breadcrumb`, `suggestion`, and `banners`.

```JSON
{
  "data": {
    "productSearch": {
      "products": [Product],
      "recordsFiltered": 123,
      "titleTag": "abc123",
      "metaTagDescription": "xyz789",
      "breadcrumb": [SearchBreadcrumb],
      "canonical": "abc123",
      "suggestion": SearchSuggestions,
      "correction": SearchCorrection,
      "operator": "and",
      "fuzzy": "abc123",
      "searchState": "xyz789",
      "banners": [SearchBanner],
      "redirect": "xyz789"
    }
  }
}
```

--------------------------------

### APIDOC: Category Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines the structure for a product category, including its ID, name, slug, and hierarchical children. Used for organizing products.

```APIDOC
Category:
  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 # Has children categories
  metaTagDescription: String # Description used by html tag
  children: [Category] # Categories children
```

```JSON
{
  "cacheId": "4",
  "href": "abc123",
  "slug": "xyz789",
  "id": 123,
  "name": "abc123",
  "titleTag": "xyz789",
  "hasChildren": false,
  "metaTagDescription": "xyz789",
  "children": [Category]
}
```

--------------------------------

### InstallmentsCriteria Enum Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines the InstallmentsCriteria enum, which specifies different criteria for calculating or displaying installment options, such as maximum without interest, maximum with interest, or all available options.

```APIDOC
InstallmentsCriteria:
  Values:
    - MAX_WITHOUT_INTEREST
    - MAX_WITH_INTEREST
    - MAX
    - MIN
    - ALL
```

```JSON
"MAX_WITHOUT_INTEREST"
```

--------------------------------

### APIDOC: Offer Type Definition

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines the `Offer` type, encompassing various pricing, availability, and promotional details, including installments, prices, taxes, delivery SLAs, discounts, teasers, and gifts.

```APIDOC
Offer:
  Fields:
    Installments: [Installment]
    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
  Arguments (for Installments field):
    criteria: InstallmentsCriteria
    rates: Boolean
    excludedPaymentSystems: [String]
    includedPaymentSystems: [String]
```

```JSON
{
  "Installments": [Installment],
  "Price": 123.45,
  "ListPrice": 123.45,
  "spotPrice": 987.65,
  "PriceWithoutDiscount": 987.65,
  "RewardValue": 987.65,
  "PriceValidUntil": "abc123",
  "AvailableQuantity": 123.45,
  "Tax": 987.65,
  "taxPercentage": 123.45,
  "CacheVersionUsedToCallCheckout": "xyz789",
  "DeliverySlaSamples": [DeliverySlaSamples],
  "discountHighlights": [Discount],
  "teasers": [Teaser],
  "giftSkuIds": ["abc123"],
  "gifts": [Gift]
}
```

--------------------------------

### FacetValue Object Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines a single value within a Facet, providing details such as its ID, quantity, name, key, value, selection status, and hierarchical children. It also includes range, link, linkEncoded, and href properties. The example shows a comprehensive JSON structure for a FacetValue.

```APIDOC
FacetValue:
  id: ID
  quantity: Int!
  name: String
  key: String
  value: String
  selected: Boolean
  children: [FacetValue]
  range: Range
  link: String
  linkEncoded: String
  href: String
```

```JSON
{
  "id": "4",
  "quantity": 123,
  "name": "xyz789",
  "key": "abc123",
  "value": "abc123",
  "selected": true,
  "children": [FacetValue],
  "range": Range,
  "link": "abc123",
  "linkEncoded": "xyz789",
  "href": "xyz789"
}
```

--------------------------------

### APIDOC: DeliverySlaPerTypes Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines the structure for delivery SLA (Service Level Agreement) details per type, including type name, price, and estimated delivery time.

```APIDOC
DeliverySlaPerTypes:
  TypeName: String
  Price: Float
  EstimatedTimeSpanToDelivery: String
```

```JSON
{
  "TypeName": "xyz789",
  "Price": 987.65,
  "EstimatedTimeSpanToDelivery": "abc123"
}
```

--------------------------------

### APIDOC: CategoryTreeBehavior Enum Values and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines the possible behaviors for displaying the category tree in search results.

```APIDOC
CategoryTreeBehavior (Enum):
  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
```

```JSON
"default"
```

--------------------------------

### APIDOC: Product Suggestions GraphQL Query

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Detailed API documentation for the `productSuggestions` GraphQL query. This query retrieves product suggestions based on user input and various filtering criteria. It outlines the query's purpose, its return type, and a comprehensive list of arguments with their types, descriptions, and default behaviors.

```APIDOC
productSuggestions:
  Description: Get product suggestions
  Response: Returns a ProductSuggestions
  Arguments:
    fullText:
      Type: String!
      Description: Text inputted by the user as the search term
    facetKey:
      Type: String
      Description: Selected facet key
    facetValue:
      Type: String
      Description: Selected facet value
    productOriginVtex:
      Type: Boolean
      Description: 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. Default = `false`
    simulationBehavior:
      Type: SimulationBehavior
      Description: If you want faster searches and do not care about most up to date prices and promotions, use skip value. Default = `default`
    hideUnavailableItems:
      Type: Boolean
      Description: If true, uses isAvailablePerSalesChannel_ parameter on query with segment's sales channel
    regionId:
      Type: String
      Description: Seller id encoded with base64 according to this format SW#{sellerId}
    salesChannel:
      Type: Int
      Description: Sales Channel related to the region ID
    orderBy:
      Type: String
      Description: 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`). Default = "OrderByScoreDESC"
```

--------------------------------

### Operator Enum Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines the possible values for an operator, typically used in search queries, along with an example of its usage.

```APIDOC
Enum Values:
  `and`
  `or`

Example:
  "and"
```

--------------------------------

### ItemMetadata Object Type Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines the ItemMetadata object type, which contains metadata about items, including a list of individual item units and their associated price tables.

```APIDOC
ItemMetadata:
  Fields:
    - items: [ItemMetadataUnit]
    - priceTable: [ItemPriceTable]
```

```JSON
{
  "items": [ItemMetadataUnit],
  "priceTable": [ItemPriceTable]
}
```

--------------------------------

### GiftImage Object Type Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines the GiftImage object type, specifying the properties of an image associated with a gift item, including its URL, label, and descriptive text.

```APIDOC
GiftImage:
  Fields:
    - imageUrl: String
    - imageLabel: String
    - imageText: String
```

```JSON
{
  "imageUrl": "xyz789",
  "imageLabel": "xyz789",
  "imageText": "abc123"
}
```

--------------------------------

### GraphQL `product` Query API Reference

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Documentation for the `product` GraphQL query, which returns details for a specified product.

```APIDOC
product query:
  Description: Returns a specified product
  Response: Product
```

--------------------------------

### APIDOC: `products` Query Definition

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Detailed API documentation for the `products` query, which returns a filtered and ordered list of products. This section specifies the response type and all available arguments, including their types, descriptions, and default values, crucial for constructing effective product listing queries.

```APIDOC
products:
  Description: Returns products list filtered and ordered
  Response: [Product]
  Arguments:
    query:
      Type: String
      Description: Terms that is used in search e.g.: eletronics/samsung. Default = ""
    map:
      Type: String
      Description: Defines terms types: Brand, Category, Department e.g.: c,b. Default = ""
    category:
      Type: String
      Description: Filter by category. {a}/{b} - {a} and {b} are categoryIds. Default = ""
    specificationFilters:
      Type: [String]
      Description: Array of product specification. specificationFilter_{a}:{b} - {a} is the specificationId, {b} = specification value
    priceRange:
      Type: String
      Description: Filter by price range. e.g.: {a} TO {b} - {a} is the minimum price "from" and {b} is the highest price "to". Default = ""
    collection:
      Type: String
      Description: Filter by collection. where collection also know as productClusterId. Default = ""
    salesChannel:
      Type: String
      Description: Filter by availability at a specific sales channel. e.g.: salesChannel:4 if want filter by available products for the sales channel 4. Default = ""
    orderBy:
      Type: String
      Description: Order by a criteria. OrderByPriceDESC/OrderByPriceASC, OrderByTopSaleDESC, OrderByReviewRateDESC, OrderByNameASC/OrderByNameDESC, OrderByReleaseDateDESC, OrderByBestDiscountDESC, OrderByScoreDESC. Default = "OrderByScoreDESC"
    from:
      Type: Int
      Description: Pagination item start. Default = 0
    to:
      Type: Int
      Description: Pagination item end. Default = 9
    hideUnavailableItems:
      Type: Boolean
      Description: If true, uses isAvailablePerSalesChannel_ parameter on query with segment's sales channel. Will override any given salesChannel arg. Default = false
    simulationBehavior:
      Type: SimulationBehavior
      Description: If you want faster searches and do not care about most up to date prices and promotions, use skip value. Default = default
```

--------------------------------

### GraphQL productSearch Query API Reference

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Detailed API documentation for the `productSearch` GraphQL query, which lists products based on various criteria. It describes the query's purpose, return type, and all available arguments with their types, descriptions, and default values.

```APIDOC
productSearch
Description: Lists the products for a given query.
Response: ProductSearch
Arguments:
  query: String (Deprecated. Use fullText instead. Default = "")
  fullText: String (Search term. It can contain any character. Default = "")
  map: String (Deprecated. Use selectedFacets instead. Default = "")
  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.)
  category: String (Deprecated. Use selectedFacets instead. Default = "")
  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". Default = "")
  collection: String (Deprecated. Use selectedFacets instead. Default = "")
  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. Default = "")
  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). Default = "OrderByScoreDESC")
  from: Int (Pagination item start. Default = 0)
  to: Int (Pagination item end. Default = 9)
  hideUnavailableItems: Boolean (If true, uses isAvailablePerSalesChannel_ parameter on query with segment's sales channel. Will override any given salesChannel arg. Default = false)
  simulationBehavior: SimulationBehavior (If you want faster searches and do not care about most up to date prices and promotions, use skip value. Default = default)
  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. Default = false)
  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.)
```

--------------------------------

### Gift Object Type Definition and Example

Source: https://github.com/vtex-apps/search-graphql/blob/master/spectaql-documentation/index.html

Defines the Gift object type, which describes a gift item with properties such as product name, SKU name, brand, and associated images. This type is likely used to represent promotional or bundled items.

```APIDOC
Gift:
  Fields:
    - productName: String
    - skuName: String
    - brand: String
    - linkText: String
    - description: String
    - images: [GiftImage]
```

```JSON
{
  "productName": "xyz789",
  "skuName": "xyz789",
  "brand": "abc123",
  "linkText": "abc123",
  "description": "abc123",
  "images": [GiftImage]
}
```

--------------------------------

### Recommendation API Fields

Source: https://github.com/vtex-apps/search-graphql/blob/master/docs/README.md

Defines fields related to product recommendations, including 'buy', 'view', and 'similars', all returning a list of products.

```APIDOC
Recommendation:
  buy: [Product]
  view: [Product]
  similars: [Product]
```