openapi: 3.0.0
info:
  title: VTex Anti-fraud Provider Account Product List Page API
  description: ">ℹ️ Onboarding guide\r\n>\r\n> Check the new [Payments onboarding guide](https://developers.vtex.com/docs/guides/payments-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey.\r\n\r\nThe Anti-fraud Provider Protocol is a set of definitions to help you integrate your anti-fraud service API into VTEX platform.\r\n\r\nTo achieve this, you need to implement a web API (REST) following the specifications described in this documentation.\r\n\r\n>⚠️ You can also access our [template on GitHub](https://github.com/vtex-apps/antifraud-provider-example) to help you quickly develop your anti-fraud connector using the Anti-fraud Provider Protocol and VTEX IO.\r\n\r\nTo learn more about the Anti-fraud Provider Protocol, check our [developer guide](https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works).\r\n\r\n## Anti-fraud Provider API Index\r\n\r\n### Anti-fraud  Flow\r\n\r\n- `POST` [Send Anti-fraud Pre-Analysis Data (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/pre-analysis)\r\n- `POST` [Send Anti-fraud Data](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/transactions)\r\n- `PUT` [Update Anti-fraud Transactions (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#put-/transactions/-transactionId-)\r\n- `GET` [List Anti-fraud Provider Manifest](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/manifest)\r\n- `GET` [Get Anti-fraud Status](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/transactions/-transactions.id-)\r\n- `DELETE` [Stop Anti-fraud Analysis (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#delete-/transactions/-transactions.Id-)\r\n\r\n### OAuth Flow\r\n\r\n1. `POST` [Retrieve Token](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/authorization/token)\r\n2. `GET` [Redirect](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/redirect)\r\n3. `GET` [Return to VTEX](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorizationCode)\r\n4. `GET` [Get Credentials](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorization/credentials)"
  version: '1.0'
servers:
- url: https://{providerApiEndpoint}
  description: Anti-fraud provider endpoint URL.
  variables:
    providerApiEndpoint:
      description: Anti-fraud provider endpoint URL.
      default: '{providerApiEndpoint}'
tags:
- name: Product List Page
paths:
  /correction_search:
    get:
      summary: VTex Get attempt of correction of a misspelled term
      description: "Tries to correct a misspelled term from the search.\r\n\r\nThis endpoint does not require authentication."
      tags:
      - Product List Page
      parameters:
      - $ref: '#/components/parameters/query'
      - $ref: '#/components/parameters/locale'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Correction'
              example:
                correction:
                  correction: true
                  misspelled: true
                  text: mountain bike
                  highlighted: mountain <em>bike</em>
  /banners/{facets}:
    get:
      summary: VTex Get list of banners registered for query
      description: "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.\r\n\r\nThis endpoint does not require authentication."
      tags:
      - Product List Page
      parameters:
      - $ref: '#/components/parameters/query'
      - $ref: '#/components/parameters/facetsPath'
      - $ref: '#/components/parameters/locale'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Banners'
              example:
                banners:
                - id: summersale
                  name: Summer Sale
                  area: '1'
                  html: <h1>This is a test</h1>
  /product_search/{facets}:
    get:
      summary: VTex Get list of products for a query
      description: "Lists the active products for a given query.\r\n\r\nThis endpoint does not require authentication."
      tags:
      - Product List Page
      parameters:
      - $ref: '#/components/parameters/facetsPath'
      - $ref: '#/components/parameters/query'
      - in: query
        name: simulationBehavior
        schema:
          type: string
          enum:
          - default
          - skip
          - only1P
          nullable: true
          default: default
        description: "Defines the simulation behavior.\n\n * `default` - Calls the simulation for every single seller.\n * `skip` - Never calls the simulation.\n * `only1P` - Only calls the simulation for first party sellers."
      - in: query
        name: count
        description: Number of products per page.
        schema:
          type: number
          nullable: true
          default: 24
      - in: query
        name: page
        description: Current search page.
        schema:
          type: number
          nullable: true
          default: 1
      - in: query
        name: sort
        description: "Defines the sort type. The possible values are: \r\n- `price:desc`: The results will be sorted by price in descending order, from highest to lowest.\r\n- `price:asc`: The results will be sorted by price in ascending order, from lowest to highest.\r\n- `orders:desc`: The results will be sorted by the amount of orders in the past 90 days, in descending order.\r\n- `name:desc`: The results will be sorted by name in descending alphabetical order.\r\n- `name:asc`: The results will be sorted by name in ascending alphabetical order.\r\n- `release:desc`: The results will be sorted by release date in descending order, from most recent to least recent.\r\n- `discount:desc`: The results will be sorted by discount percentage in descending order, from highest to lowest.\r\n\r\nIf `null`, the products will be sorted by relevance."
        schema:
          type: string
          nullable: true
          enum:
          - price:desc
          - price:asc
          - orders:desc
          - name:desc
          - name:asc
          - release:desc
          - discount:desc
          example: price:desc
      - $ref: '#/components/parameters/locale'
      - $ref: '#/components/parameters/hideUnavailableItems'
      responses:
        '200':
          description: List of products for the given query.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductSearch'
              example:
                products:
                - cacheId: sp-2000003
                  productId: '2000003'
                  description: Introducing our exquisite Top Wood Clock, a timeless blend of elegance and craftsmanship. Crafted from premium-quality wood, this clock seamlessly combines functionality with aesthetic appeal. Its sleek design and rich wood finish make it a sophisticated addition to any space, from classic to contemporary interiors.
                  productName: Top Wood Clock
                  productReference: clock120
                  linkText: wood-clock
                  brand: Sony
                  brandId: 2000005
                  link: /wood-clock/p
                  categories:
                  - /Home & Decor/
                  categoryId: '40'
                  categoriesIds:
                  - /40/
                  priceRange:
                    sellingPrice:
                      highPrice: 197.99
                      lowPrice: 197.99
                    listPrice:
                      highPrice: 197.99
                      lowPrice: 197.99
                  specificationGroups:
                  - originalName: allSpecifications
                    name: allSpecifications
                    specifications:
                    - originalName: sellerId
                      name: sellerId
                      values:
                      - '1'
                  skuSpecifications: []
                  productClusters:
                  - id: '1970'
                    name: Summer
                  clusterHighlights:
                  - id: '1970'
                    name: Summer
                  properties:
                  - name: sellerId
                    originalName: sellerId
                    values:
                    - '1'
                  items:
                  - sellers:
                    - sellerId: '1'
                      sellerName: VTEX
                      addToCartLink: ''
                      sellerDefault: true
                      commertialOffer:
                        DeliverySlaSamplesPerRegion: {}
                        DeliverySlaSamples: []
                        AvailableQuantity: 10000
                        discountHighlights: []
                        Installments:
                        - Value: 197.99
                          InterestRate: 0
                          TotalValuePlusInterestRate: 197.99
                          NumberOfInstallments: 1
                          Name: American Express à vista
                          PaymentSystemName: American Express
                        - Value: 197.99
                          InterestRate: 0
                          TotalValuePlusInterestRate: 197.99
                          NumberOfInstallments: 1
                          Name: Visa à vista
                          PaymentSystemName: Visa
                        - Value: 98.99
                          InterestRate: 0
                          TotalValuePlusInterestRate: 197.99
                          NumberOfInstallments: 2
                          Name: Visa 2 vezes sem juros
                          PaymentSystemName: Visa
                        - Value: 65.99
                          InterestRate: 0
                          TotalValuePlusInterestRate: 197.99
                          NumberOfInstallments: 3
                          Name: Visa 3 vezes sem juros
                          PaymentSystemName: Visa
                        - Value: 49.49
                          InterestRate: 0
                          TotalValuePlusInterestRate: 197.99
                          NumberOfInstallments: 4
                          Name: Visa 4 vezes sem juros
                          PaymentSystemName: Visa
                        - Value: 39.59
                          InterestRate: 0
                          TotalValuePlusInterestRate: 197.99
                          NumberOfInstallments: 5
                          Name: Visa 5 vezes sem juros
                          PaymentSystemName: Visa
                        - Value: 32.99
                          InterestRate: 0
                          TotalValuePlusInterestRate: 197.99
                          NumberOfInstallments: 6
                          Name: Visa 6 vezes sem juros
                          PaymentSystemName: Visa
                        - Value: 197.99
                          InterestRate: 0
                          TotalValuePlusInterestRate: 197.99
                          NumberOfInstallments: 1
                          Name: Diners à vista
                          PaymentSystemName: Diners
                        - Value: 100.48
                          InterestRate: 100
                          TotalValuePlusInterestRate: 200.96
                          NumberOfInstallments: 2
                          Name: Diners 2 vezes com juros
                          PaymentSystemName: Diners
                        - Value: 197.99
                          InterestRate: 0
                          TotalValuePlusInterestRate: 197.99
                          NumberOfInstallments: 1
                          Name: Mastercard à vista
                          PaymentSystemName: Mastercard
                        - Value: 197.99
                          InterestRate: 0
                          TotalValuePlusInterestRate: 197.99
                          NumberOfInstallments: 1
                          Name: Boleto Bancário à vista
                          PaymentSystemName: Boleto Bancário
                        - Value: 197.99
                          InterestRate: 0
                          TotalValuePlusInterestRate: 197.99
                          NumberOfInstallments: 1
                          Name: Vale à vista
                          PaymentSystemName: Vale
                        - Value: 197.99
                          InterestRate: 0
                          TotalValuePlusInterestRate: 197.99
                          NumberOfInstallments: 1
                          Name: Promissory à vista
                          PaymentSystemName: Promissory
                        - Value: 197.99
                          InterestRate: 0
                          TotalValuePlusInterestRate: 197.99
                          NumberOfInstallments: 1
                          Name: Customer Credit à vista
                          PaymentSystemName: Customer Credit
                        - Value: 98.99
                          InterestRate: 0
                          TotalValuePlusInterestRate: 197.99
                          NumberOfInstallments: 2
                          Name: Customer Credit 2 vezes sem juros
                          PaymentSystemName: Customer Credit
                        - Value: 67.97
                          InterestRate: 100
                          TotalValuePlusInterestRate: 203.91
                          NumberOfInstallments: 3
                          Name: Customer Credit 3 vezes com juros
                          PaymentSystemName: Customer Credit
                        - Value: 197.99
                          InterestRate: 0
                          TotalValuePlusInterestRate: 197.99
                          NumberOfInstallments: 1
                          Name: Free à vista
                          PaymentSystemName: Free
                        Price: 197.99
                        ListPrice: 197.99
                        spotPrice: 197.99
                        taxPercentage: 0
                        PriceWithoutDiscount: 197.99
                        Tax: 0
                        GiftSkuIds: []
                        BuyTogether: []
                        ItemMetadataAttachment: []
                        RewardValue: 0
                        PriceValidUntil: '2023-04-01T13:13:20Z'
                        GetInfoErrorMessage: null
                        CacheVersionUsedToCallCheckout: ''
                        teasers:
                        - name: 8% Boleto
                          conditions:
                            minimumQuantity: 0
                            parameters:
                            - name: PaymentMethodId
                              value: '6'
                          effects:
                            parameters:
                            - name: PercentualDiscount
                              value: '8.0'
                    images:
                    - imageId: '155484'
                      cacheId: '155484'
                      imageTag: ''
                      imageLabel: ''
                      imageText: ''
                      imageUrl: https://storecomponents.vtexassets.com/arquivos/ids/155484/Frame.jpg?v=636793817478300000
                    - imageId: '155485'
                      cacheId: '155485'
                      imageTag: ''
                      imageLabel: ''
                      imageText: ''
                      imageUrl: https://storecomponents.vtexassets.com/arquivos/ids/155485/Frame-1.jpg?v=636793817642000000
                    - imageId: '155486'
                      cacheId: '155486'
                      imageTag: ''
                      imageLabel: ''
                      imageText: ''
                      imageUrl: https://storecomponents.vtexassets.com/arquivos/ids/155486/Frame-2.jpg?v=636793817785530000
                    itemId: '2000534'
                    name: '1'
                    nameComplete: Top Wood Clock 1
                    complementName: ''
                    referenceId:
                    - Key: RefId
                      Value: '16001'
                    measurementUnit: un
                    unitMultiplier: 1
                    variations: []
                    ean: '16001'
                    modalType: ''
                    videos: []
                    attachments: []
                    isKit: false
                  origin: intelligent-search
                - cacheId: sp-2000214
                  productId: '2000214'
                  description: ''
                  productName: kevin1
                  linkText: kevin1-lkn
                  brand: Sony
                  brandId: 2000005
                  link: /kevin1-lkn/p
                  categories:
                  - /Home & Decor/
                  categoryId: '40'
                  categoriesIds:
                  - /40/
                  priceRange:
                    sellingPrice:
                      highPrice: 10
                      lowPrice: 10
                    listPrice:
                      highPrice: 10
                      lowPrice: 10
                  specificationGroups:
                  - originalName: allSpecifications
                    name: allSpecifications
                    specifications:
                    - originalName: sellerId
                      name: sellerId
                      values:
                      - '1'
                  skuSpecifications: []
                  productClusters: []
                  clusterHighlights: []
                  properties:
                  - name: sellerId
                    originalName: sellerId
                    values:
                    - '1'
                  items:
                  - sellers:
                    - sellerId: '1'
                      sellerName: VTEX
                      addToCartLink: ''
                      sellerDefault: true
                      commertialOffer:
                        DeliverySlaSamplesPerRegion: {}
                        DeliverySlaSamples: []
                        AvailableQuantity: 10000
                        discountHighlights: []
                        Installments:
                        - Value: 10
                          InterestRate: 0
                          TotalValuePlusInterestRate: 10
                          NumberOfInstallments: 1
                          Name: American Express à vista
                          PaymentSystemName: American Express
                        - Value: 10
                          InterestRate: 0
                          TotalValuePlusInterestRate: 10
                          NumberOfInstallments: 1
                          Name: Visa à vista
                          PaymentSystemName: Visa
                        - Value: 10
                          InterestRate: 0
                          TotalValuePlusInterestRate: 10
                          NumberOfInstallments: 1
                          Name: Diners à vista
                          PaymentSystemName: Diners
                        - Value: 10
                          InterestRate: 0
                          TotalValuePlusInterestRate: 10
                          NumberOfInstallments: 1
                          Name: Mastercard à vista
                          PaymentSystemName: Mastercard
                        - Value: 10
                          InterestRate: 0
                          TotalValuePlusInterestRate: 10
                          NumberOfInstallments: 1
                          Name: Boleto Bancário à vista
                          PaymentSystemName: Boleto Bancário
                        - Value: 10
                          InterestRate: 0
                          TotalValuePlusInterestRate: 10
                          NumberOfInstallments: 1
                          Name: Vale à vista
                          PaymentSystemName: Vale
                        - Value: 10
                          InterestRate: 0
                          TotalValuePlusInterestRate: 10
                          NumberOfInstallments: 1
                          Name: Promissory à vista
                          PaymentSystemName: Promissory
                        - Value: 10
                          InterestRate: 0
                          TotalValuePlusInterestRate: 10
                          NumberOfInstallments: 1
                          Name: Customer Credit à vista
                          PaymentSystemName: Customer Credit
                        - Value: 5
                          InterestRate: 0
                          TotalValuePlusInterestRate: 10
                          NumberOfInstallments: 2
                          Name: Customer Credit 2 vezes sem juros
                          PaymentSystemName: Customer Credit
                        - Value: 3.43
                          InterestRate: 100
                          TotalValuePlusInterestRate: 10.29
                          NumberOfInstallments: 3
                          Name: Customer Credit 3 vezes com juros
                          PaymentSystemName: Customer Credit
                        - Value: 10
                          InterestRate: 0
                          TotalValuePlusInterestRate: 10
                          NumberOfInstallments: 1
                          Name: Free à vista
                          PaymentSystemName: Free
                        Price: 10
                        ListPrice: 10
                        spotPrice: 10
                        taxPercentage: 0
                        PriceWithoutDiscount: 10
                        Tax: 0
                        GiftSkuIds: []
                        BuyTogether: []
                        ItemMetadataAttachment: []
                        RewardValue: 0
                        PriceValidUntil: '2023-04-01T13:13:20Z'
                        GetInfoErrorMessage: null
                        CacheVersionUsedToCallCheckout: ''
                        teasers:
                        - name: 8% Boleto
                          conditions:
                            minimumQuantity: 0
                            parameters:
                            - name: PaymentMethodId
                              value: '6'
                          effects:
                            parameters:
                            - name: PercentualDiscount
                              value: '8.0'
                    images:
                    - imageId: '155675'
                      cacheId: '155675'
                      imageTag: ''
                      imageLabel: vtex
                      imageText: vtex
                      imageUrl: https://storecomponents.vtexassets.com/arquivos/ids/155675/vtex.jpg?v=637655270451200000
                    itemId: '310124211'
                    name: kevin1sku
                    nameComplete: kevin1sku
                    complementName: ''
                    referenceId:
                    - Key: RefId
                      Value: 2983678w63478
                    measurementUnit: un
                    unitMultiplier: 1
                    variations: []
                    ean: '2398428937489'
                    modalType: ''
                    videos: []
                    attachments: []
                    isKit: false
                  origin: intelligent-search
                recordsFiltered: 5
                correction:
                  misspelled: false
                fuzzy: '0'
                operator: and
                translated: false
  /facets/{facets}:
    get:
      summary: VTex Get list of the possible facets for a given query
      description: "Lists the possible facets for a given query.\r\n\r\nThis endpoint does not require authentication."
      tags:
      - Product List Page
      parameters:
      - $ref: '#/components/parameters/facetsPath'
      - $ref: '#/components/parameters/query'
      - $ref: '#/components/parameters/locale'
      - $ref: '#/components/parameters/hideUnavailableItems'
      responses:
        '200':
          description: List of facets for the given query.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Facets'
              example:
                facets:
                - values:
                  - id: '47'
                    quantity: 1
                    name: Clothing
                    key: category-2
                    value: clothing
                    selected: false
                    href: shirt/blue/clothing?map=ft,color,category
                  type: TEXT
                  name: Category
                  hidden: false
                  key: category-2
                  quantity: 1
                - values:
                  - quantity: 1
                    name: ''
                    key: price
                    selected: false
                    range:
                      from: 45
                      to: 50
                  type: PRICERANGE
                  name: Price
                  hidden: false
                  key: price
                  quantity: 1
                - values:
                  - id: '2000045'
                    quantity: 1
                    name: New Offers!!
                    key: brand
                    value: new-offers--
                    selected: false
                    href: shirt/blue/new-offers--?map=ft,color,brand
                  type: TEXT
                  name: Brand
                  hidden: false
                  key: brand
                  quantity: 1
                - values:
                  - id: '103'
                    quantity: 1
                    name: Blue
                    key: color
                    value: blue
                    selected: true
                    href: shirt/blue/blue?map=ft,color,color
                  type: TEXT
                  name: Color
                  hidden: true
                  key: color
                  quantity: 1
                - values:
                  - id: '25'
                    quantity: 1
                    name: Apparel & Accessories
                    key: category-1
                    value: apparel---accessories
                    selected: false
                    href: shirt/blue/apparel---accessories?map=ft,color,department
                  type: TEXT
                  name: Department
                  hidden: false
                  key: category-1
                  quantity: 1
                - values:
                  - id: ''
                    quantity: 1
                    name: Test
                    key: filter-test
                    value: test
                    selected: false
                    href: shirt/blue/test?map=ft,color,filter-test
                  type: TEXT
                  name: Filter Test
                  hidden: false
                  key: filter-test
                  quantity: 1
                - values:
                  - id: '48'
                    quantity: 1
                    name: Tops
                    key: category-3
                    value: tops
                    selected: false
                    href: shirt/blue/tops?map=ft,color,subcategory
                  type: TEXT
                  name: Subcategory
                  hidden: false
                  key: category-3
                  quantity: 1
                sampling: false
                breadcrumb:
                - name: shirt
                  href: /shirt?map=ft
                - name: Blue
                  href: /shirt/blue?map=ft,color
                queryArgs:
                  query: shirt
                  selectedFacets:
                  - key: color
                    value: blue
                  - key: ft
                    value: shirt
                translated: false
components:
  parameters:
    hideUnavailableItems:
      in: query
      name: hideUnavailableItems
      description: Defines whether the result should hide unavailable items (`true`), or not (`false`).
      schema:
        type: boolean
        default: false
    locale:
      in: query
      name: locale
      description: Indicates the target language as a BCP 47 language code. The Intelligent Search must have indexed the account in the target language.
      example: en-US
      schema:
        type: string
        nullable: true
    facetsPath:
      in: path
      name: facets
      required: true
      description: "## Format\r\n\r\nThe `facets` parameter follows the format: `/${facetKey1}/${facetValue1}/${facetKey2}/${facetValue2}/.../${facetKeyN}/${facetValueN}`.\r\n\r\nThe order in which the terms appear is not relevant to the search.\r\n\r\nYou can also repeat the same `facetKey` several times for different values. For example: `category-1/shoes/color/blue/color/red/color/yellow`.\r\n\r\n## General filters\r\n\r\nThe `facets` parameter also allows the following general filters:\r\n\r\n| `facetKey` | Description | Example |\r\n| - | - | - |\r\n| `price` | Filter the search by a price range, following the format `${minPrice}:${maxPrice}`. | `/color/blue/price/100:500?query=shirt` |\r\n| `category-${n}` | Filter the search by category, where `n` represents the category tree level (1 = department, 2 = category, 3 = subcategory, and so on). | `category-1/clothing/category-2/shirts` |\r\n| `productClusterIds` | Filter the search by collection, following the format `productClusterIds/{collectionId}`. | `productClusterIds/262` |\r\n| `trade-policy` |  Filter the search by trade policy (also known as sales channel), following the format `trade-policy/{tradePolicyId}`. | `trade-policy/2`|\n"
      example: category-1/clothing/category-2/shirt/category-3/man
      schema:
        nullable: true
        type: string
        default: /
        example: color/blue
    query:
      in: query
      name: query
      description: Search term. It can contain any character.
      schema:
        type: string
        example: shirt
  schemas:
    Facets:
      type: object
      description: Response body object.
      properties:
        facets:
          type: array
          description: List of facets.
          items:
            type: object
            description: Facet information.
            properties:
              values:
                type: array
                description: Possible values.
                items:
                  type: object
                  description: Value information.
                  properties:
                    id:
                      type: string
                      description: Value ID.
                    quantity:
                      type: number
                      description: Number of resulting products.
                    name:
                      type: string
                      description: Human-readable format of the facet value.
                    key:
                      type: string
                      description: Facet key.
                    value:
                      type: string
                      description: Facet value.
                    selected:
                      type: boolean
                      description: Defines whether the value is selected (`true`) or not (`false`).
                    href:
                      type: string
                      description: Query URL.
              type:
                type: string
                description: "Facet type\n - `TEXT` - The value is a simple text.\n - `PRICERANGE` - The value contains the property `range` representing the minimum and the maximum price for the query."
                enum:
                - TEXT
                - PRICERANGE
              name:
                type: string
                description: Human-readable format of the facet key.
              hidden:
                type: boolean
                description: Defines whether the client-side should hide the facet (`true`) or not (`false`).
              key:
                type: string
                description: Facet key.
              quantity:
                type: number
                description: Number of possible values.
        sampling:
          type: boolean
          description: 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:
          type: array
          description: Generated breadcrumb for the given query.
          items:
            type: object
            description: Breadcrumb information.
            properties:
              name:
                type: string
                description: Human-readable format of the facet key.
              href:
                type: string
                description: Query link.
        queryArgs:
          type: object
          description: Term and facets used in the query.
          properties:
            query:
              type: string
              description: Search term used in the query.
            selectedFacets:
              type: array
              description: Facets used in the query.
              items:
                type: object
                description: Selected facet information.
                properties:
                  key:
                    type: string
                    description: facet key.
                  value:
                    type: string
                    description: facet value.
        translated:
          type: boolean
          description: Defines whether the facets were translated by Intelligent Search (`true`) or not (`false`).
    Correction:
      type: object
      description: Response body object.
      properties:
        correction:
          type: object
          description: Object that indicates if the term was misspelled and suggests a possible correction.
          properties:
            misspelled:
              type: boolean
              description: Defines whether the term was misspelled (`true`) or not (`false`).
            correction:
              type: boolean
              description: Defines whether the API was able to suggest a correction (`true`) or not (`false`).
            text:
              type: string
              description: The corrected term. If the API was not able to correct the term, it will show the original search term.
            highlighted:
              type: string
              description: The same as `text`, but it highlights the corrected word. Useful when there is more than one word.
    ProductSearch:
      type: object
      description: Response body object.
      properties:
        products:
          type: array
          description: List of active products.
          items:
            type: object
            description: Product information.
            properties:
              cacheId:
                description: Cache ID.
                type: string
              productId:
                description: Product unique identifier.
                type: string
              description:
                description: Product description.
                type: string
              productName:
                description: Product name.
                type: string
              productReference:
                description: Product reference code.
                type: string
              linkText:
                description: Product text link.
                type: string
              brand:
                description: Brand name.
                type: string
              brandId:
                description: Brand unique identifier.
                type: number
              link:
                description: Product slug in the store.
                type: string
              categories:
                description: Category path.
                type: array
                items:
                  description: Category name.
                  type: string
              categoryId:
                description: Category unique identifier.
                type: string
              categoriesIds:
                description: List of category IDs in the corresponding category path.
                type: array
                items:
                  description: Category ID.
                  type: string
              priceRange:
                description: Price range information.
                type: object
                properties:
                  sellingPrice:
                    description: Selling price.
                    type: object
                    properties:
                      highPrice:
                        description: Highest selling price.
                        type: number
                      lowPrice:
                        description: Lowest selling price.
                        type: number
                  listPrice:
                    description: List price information.
                    type: object
                    properties:
                      highPrice:
                        description: Highest list price.
                        type: number
                      lowPrice:
                        description: Lowest list price.
                        type: number
              specificationGroups:
                description: Specification groups information.
                type: array
                items:
                  description: Specification group information.
                  type: object
                  properties:
                    originalName:
                      description: Speficiation group original name.
                      type: string
                    name:
                      description: Specification group name.
                      type: string
                    specifications:
                      description: List of specifications.
                      type: array
                      items:
                        description: Specification information.
                        type: object
                        properties:
                          originalName:
                            description: Specification original name.
                            type: string
                          name:
                            description: Specification name.
                            type: string
                          values:
                            description: Specification values.
                            type: array
                            items:
                              description: Specification value.
                              type: string
              skuSpecifications:
                description: SKU specifications.
                type: array
                items:
                  description: SKU specification information.
                  type: object
                  properties:
                    field:
                      description: SKU specification field information.
                      type: object
                      properties:
                        name:
                          description: SKU specification field name.
                          type: string
                        originalName:
                          description: SKU specification field original name.
                          type: string
                    values:
                      description: SKU specification field values.
                      type: array
                      items:
                        description: SKU specification value.
                        type: object
                        properties:
                          name:
                            description: SKU specification value name.
                            type: string
                          originalName:
                            description: SKU specification value original name.
                            type: string
              productClusters:
                description: Product clusters information.
                type: array
                items:
                  description: Product cluster information.
                  type: object
                  properties:
                    id:
                      description: Product cluster unique identifier.
                      type: string
                    name:
                      description: Product cluster name.
                      type: string
              clusterHighlights:
                description: Cluster highlights information.
                type: array
                items:
                  description: Cluster highlight information.
                  type: object
                  properties:
                    id:
                      description: Product cluster unique identifier.
                      type: string
                    name:
                      description: Product cluster name.
                      type: string
              properties:
                description: Product properties.
                type: array
                items:
                  description: Product property.
                  type: object
                  properties:
                    name:
                      description: Property name.
                      type: string
                    originalName:
                      description: Property original name.
                      type: string
                    values:
                      description: Property values.
                      type: array
                      items:
                        description: Property value.
                        type: string
              items:
                description: Information about the related SKUs.
                type: array
                items:
                  description: SKU information.
                  type: object
                  additionalProperties: true
                  properties:
                    sellers:
                      description: List of sellers.
                      type: array
                      items:
                        description: Seller information.
                        type: object
                        properties:
                          sellerId:
                            description: Seller unique identifier.
                            type: string
                          sellerName:
                            description: Seller name.
                            type: string
                          addToCartLink:
                            description: Add to cart link.
                            type: string
                          sellerDefault:
                            description: Default seller.
                            type: boolean
                          commertialOffer:
                            description: Commercial offer information.
                            type: object
                            properties:
                              DeliverySlaSamplesPerRegion:
                                description: Delivery SLA samples per region.
                                type: object
                                additionalProperties: true
                              DeliverySlaSamples:
                                description: Delivery SLA samples.
                                type: array
                                items:
                                  type: object
                                  description: Delivery SLA sample.
                                  properties:
                                    DeliverySlaPerTypes:
                                      type: array
                                      description: Delivery SLA per types.
                                    Region:
                                      type: string
                                      description: Region.
                                      nullable: true
                              AvailableQuantity:
                                description: Available quantity of the item.
                                type: number
                              discountHighlights:
                                description: Discount highlights.
                                type: array
                                items:
                                  type: object
                                  description: Discount highlight information.
                                  properties:
                                    name:
                                      type: string
                                      description: Discount highlight name.
                              Installments:
                                description: Installments information.
                                type: array
                                items:
                                  description: Installment information.
                                  type: object
                                  properties:
                                    PaymentSystemName:
                                      description: Payment system name.
                                      type: string
                                    Value:
                                      description: Total value.
                                      type: number
                                    InterestRate:
                                      description: Interest rate.
                                      type: number
                                    TotalValuePlusInterestRate:
                                      description: Total value plus interest rate.
                                      type: number
                                    NumberOfInstallments:
                                      description: Number of installments.
                                      type: number
                                    Name:
                                      description: Payment condition name.
                                      type: string
                                    PaymentSystemGroupName:
                                      description: Payment system group.
                                      type: string
                              Price:
                                description: Price of the item.
                                type: number
                              ListPrice:
                                description: List price of the item.
                                type: number
                              spotPrice:
                                description: Spot price.
                                type: number
                              taxPercentage:
                                description: Tax percentage.
                                type: number
                              PriceWithoutDiscount:
                                description: Price with discount.
                                type: number
                              Tax:
                                description: Tax value.
                                type: number
                              GiftSkuIds:
                                description: List of SKU gifts IDs.
                                type: array
                                items:
                                  type: string
                                  description: SKU gift unique identifier.
                              BuyTogether:
                                description: Array of other items that can be bought together with the item in question.
                                type: array
                                items:
                                  type: string
                                  description: Unique identifier of each SKU that can be bought together.
                              ItemMetadataAttachment:
                                description: Item metadata attachment.
                                type: array
                                items:
                                  description: Item metadata attachment information.
                                  type: object
                                  properties:
                                    Name:
                                      description: SKU name.
                                      type: string
                                    NameComplete:
                                      description: Complete name of the product combined with the SKU name.
                                      type: string
                                    MainImage:
                                      description: Main image URL.
                                      type: string
                                    BrandName:
                                      description: Brand name.
                                      type: string
                                    CategoryId:
                                      description: Category unique identifier.
                                      type: number
                                    ProductId:
                                      description: Product unique identifier.
                                      type: number
                                    id:
                                      description: SKU unique identifier.
                                      type: string
                                    seller:
                                      description: Seller unique identifier.
                                      type: string
                                    assemblyOptions:
                                      description: Assembly options attachment.
                                      type: array
                                      items:
                                        description: Assembly options attachment information.
                                        properties:
                                          id:
                                            description: Attachment unique identifier.
                                            type: string
                                          name:
                                            description: Attachment name.
                                            type: string
                                          required:
                                            description: Defines whether the attachment is required (`true`) or not (`false`).
                                            type: boolean
                                          inputValues:
                                            description: Input values information.
                                            type: object
                                            additionalProperties: true
                              RewardValue:
                                description: Credit that the customer receives when finalizing an order that includes the SKU. By filling this field out with `1`, the customer receives credit on the site in the selected currency, e.g. U$ 1.
                                type: number
                              PriceValidUntil:
                                description: Date until the price is valid, in ISO 8601 format.
                                type: string
                              GetInfoErrorMessage:
                                description: Get info error message.
                                type: string
                                nullable: true
                              CacheVersionUsedToCallCheckout:
                                description: Cache version used to call Checkout.
                                type: string
                              teasers:
                                description: Teasers information.
                                type: array
                                items:
                                  description: Teaser information.
                                  type: object
                                  properties:
                                    name:
                                      description: Promotion name.
                                      type: string
                                    conditions:
                                      description: Conditions for the promotion the be valid.
                                      type: object
                                      properties:
                                        minimumQuantity:
                                          description: Minimum quantity of the item for the promotion to be valid.
                                          type: number
                                        parameters:
                                          description: Condition parameters.
                                          type: array
                                          items:
                                            description: Condition parameters.
                                            type: object
                                            properties:
                                              name:
                                                description: Condition name.
                                                type: string
                                              value:
                                                description: Condition value.
                                                type: string
                                    effects:
                                      description: Promotion effects.
                                      type: object
                                      properties:
                                        parameters:
                                          description: Effects parameters.
                                          type: array
                                          items:
                                            description: Effect parameters.
                                            type: object
                                            properties:
                                              name:
                                                description: Effect name.
                                                type: string
                                              value:
                                                description: Effect value.
                                                type: string
                    images:
                      description: SKU images information.
                      type: array
                      items:
                        description: SKU image information.
                        type: object
                        properties:
                          imageId:
                            description: Image unique identifier.
                            type: string
                          cacheId:
                            description: Cache ID.
                            type: string
                          imageTag:
                            description: HTML tag for the selected image.
                            type: string
                          imageLabel:
                            description: Image label.
                            type: string
                          imageText:
                            description: Image text.
                            type: string
                          imageUrl:
                            description: Image URL.
                            type: string
                    itemId:
                      description: SKU unique identifier.
                      type: string
                    name:
                      description: SKU name.
                      type: string
                    nameComplete:
                      description: Combination of the product name with the SKU name.
                      type: string
                    complementName:
                      description: Complement name.
                      type: string
                    referenceId:
                      description: SKU alternate IDs.
                      type: array
                      items:
                        description: Alternate ID information.
                        type: object
                        properties:
                          Key:
                            description: Alternate ID key.
                            type: string
                          Value:
                            description: Alternate ID value.
                            type: string
                    measurementUnit:
                      description: Measurement unit. This field should only be used when it is necessary to convert the unit of measure for sale. For example, if a product is sold in boxes, but customers want to buy per square meter (m²). In common cases, use `'un'`.
                      type: string
                    unitMultiplier:
                      description: Multiple number of SKU. If the multiplier is 5.0000, the product can be added in multiple quantities of 5, 10, 15, 20, onward.
                      type: number
                    variations:
                      description: Variations.
                      type: array
                      items:
                        description: Variation information.
                        type: object
                        properties:
                          name:
                            description: Variation name.
                            type: string
                          values:
                            description: Variation values.
                            type: array
                            items:
                              description: Variation value.
                              type: string
                    ean:
                      description: EAN value.
                      type: string
                    modalType:
                      description: Links an unusual type of SKU that needs special transportation, such as meat, glass, or a mattress, to a carrier specialized in delivering it. This field should be filled in with the name of the modal (e.g. "Chemicals" or "Refrigerated products"). To learn more about this feature, read our articles [How the modal works](https://help.vtex.com/en/tutorial/how-does-the-modal-work--tutorials_125) and [Setting up modal for carriers](https://help.vtex.com/en/tutorial/configure-modal--3jhLqxuPhuiq24UoykCcqy).
                      type: string
                    videos:
                      description: SKU videos.
                      type: array
                      items:
                        type: string
                        description: Video URL.
                    attachments:
                      description: Array with information about the attachments that are related to the SKU.
                      type: array
                      items:
                        type: object
                        description: Attachment information.
                        properties:
                          id:
                            type: string
                            description: Attachment unique identifier.
                          name:
                            type: string
                            description: Attachment name.
                          required:
                            type: boolean
                            description: Defines if the attachment is required (`true`) or not (`false`).
                          domainValues:
                            type: array
                            description: Attachment domain values.
                            items:
                              type: object
                              description: Attachment information.
                              properties:
                                FieldName:
                                  type: string
                                  description: Attachment name.
                                DomainValues:
                                  type: string
                                  description: Attachment value.
                    isKit:
                      description: Defines whether the SKU is made up of one or more SKUs (part of a kit) (`true`) or not (`false`). Must be enabled if you are adding a kit. Once activated, this definition cannot be reverted.
                      type: boolean
              releaseDate:
                description: Release date.
                type: number
              origin:
                description: Origin of products in the trade policy.
                type: string
        recordsFiltered:
          type: number
          description: Total number of filtered active products.
        correction:
          type: object
          description: Object with information of misspelled terms.
          properties:
            misspelled:
              type: boolean
              description: Defines whether the term is misspelled (`true`) or not (`false`).
        fuzzy:
          type: string
          description: 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.
        operator:
          type: string
          enum:
          - and
          - or
          description: "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."
        translated:
          type: boolean
          description: Defines whether the list of products was translated by Intelligent Search (`true`) or not (`false`).
        pagination:
          type: object
          description: Pagination information.
          properties:
            count:
              description: Page count.
              type: number
            current:
              description: Information about the current page.
              type: object
              properties:
                index:
                  description: Page index.
                  type: number
                proxyUrl:
                  description: Proxy URL.
                  type: string
            before:
              description: Information about the previous pages.
              type: array
              items:
                description: Page information.
                type: object
                properties:
                  index:
                    description: Page index.
                    type: number
                  proxyUrl:
                    description: Proxy URL.
                    type: string
            after:
              description: Information about the following pages.
              type: array
              items:
                description: Page information.
                type: object
                properties:
                  index:
                    description: Page index.
                    type: number
                  proxyUrl:
                    description: Proxy URL.
                    type: string
            perPage:
              description: Amount of results per page.
              type: number
            next:
              description: Information about the next page.
              type: object
              properties:
                index:
                  description: Page index.
                  type: number
                proxyUrl:
                  description: Proxy URL.
                  type: string
            previous:
              description: Information about the previous page.
              type: object
              properties:
                index:
                  description: Page index.
                  type: number
            first:
              description: Information about the first page.
              type: object
              properties:
                index:
                  description: Page index.
                  type: number
            last:
              description: Information about the last page.
              type: object
              properties:
                index:
                  description: Page index.
                  type: number
    Banners:
      type: object
      description: Response body object.
      properties:
        banners:
          type: array
          description: List of banners.
          items:
            type: object
            properties:
              id:
                type: string
                description: Banner ID.
              name:
                type: string
                description: Banner name.
              area:
                type: string
                description: Banner area, which can be a number between 1 and 4, to be used in the store's [Banner](https://developers.vtex.com/docs/guides/vtex-search-banner) block.
              html:
                type: string
                description: Banner HTML, which can be an image or text.
  securitySchemes:
    VtexIdclientAutCookie:
      type: apiKey
      in: header
      name: VtexIdclientAutCookie
      description: '[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.'