VTEX Search API

openapi: 3.0.0
info:
  title: VTex Anti-fraud Provider Account Search 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: Search
paths:
  /api/catalog_system/pub/products/search/{search}:
    get:
      tags:
      - Search
      summary: VTex Search for Products
      description: "Retrieves general information about the products related to the term searched. \r\nThis is the main search used by the store. The user can type anything to be searched.  \r\n\r\nFor example, if they search for a \"decanter\", this is the URL: `https://{{accountName}}.{{environment}}.com.br/api/catalog_system/pub/products/search/decanter`. \r\n\r\nNote that maybe the response can be HTTP 200 or 206, 206 means that it's a partial content response.\r\n\r\nIf it is a 206 take a look at the Headers, will be an entry called resources. E.g.: resources → 0-9/19. This means that the response is showing items from 0 to 9, 10 items, but there were 19 items found. See more information at the paging route example."
      operationId: ProductSearch
      parameters:
      - name: Accept
        in: header
        description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
        required: true
        style: simple
        schema:
          type: string
          example: application/json
      - name: Content-Type
        in: header
        description: Describes the type of the content being sent.
        required: true
        style: simple
        schema:
          type: string
          example: application/json
      - name: search
        in: path
        description: Term used to search products
        required: true
        style: simple
        schema:
          type: string
          example: jacket
      responses:
        '200':
          description: OK
          content:
            application/json:
              example:
              - productId: '35'
                productName: Kit de Hoegaarden
                brand: Hoegaarden
                brandId: 2000004
                brandImageUrl: https://merch.vteximg.com.br/arquivos/ids/155532/hoegardden-logo.jpg
                linkText: kit-6-cerveja-hoegaarden
                productReference: 000806
                productReferenceCode: null
                categoryId: '1'
                productTitle: ''
                metaTagDescription: ''
                releaseDate: '2020-10-07T00:00:00'
                clusterHighlights:
                  '138': teste2
                productClusters:
                  '138': teste2
                  '143': NaoPesquisavel
                  '146': colecaotestesubcategoria
                  '161': merch_import_test1
                searchableClusters:
                  '138': teste2
                categories:
                - /Beers Beers Mesmo/
                categoriesIds:
                - /1/
                link: https://merch.vtexcommercestable.com.br/kit-6-cerveja-hoegaarden/p
                Percentuals:
                - 4,9
                Percentual:
                - 4,9
                Total:
                - Percentuals
                - Percentual
                Teste de Api:
                - a
                Ale:
                - '1'
                Teste da Api2:
                - Teste de Api
                - Ale
                Alcool:
                - Percentual
                allSpecifications:
                - Percentuals
                - Percentual
                - Teste de Api
                - Ale
                allSpecificationsGroups:
                - Total
                - Teste da Api2
                description: ''
                items:
                - itemId: '310118469'
                  name: Kit com 6
                  nameComplete: Kit de Hoegaarden Kit com 6
                  complementName: ''
                  ean: ''
                  referenceId:
                  - Key: RefId
                    Value: 000806
                  measurementUnit: un
                  unitMultiplier: 1
                  modalType: null
                  isKit: true
                  kitItems:
                  - itemId: '310118466'
                    amount: 6
                  images:
                  - imageId: '155489'
                    imageLabel: ''
                    imageTag: <img src="~/arquivos/ids/155489-#width#-#height#/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000" width="#width#" height="#height#" alt="hoegaarden-kit" id="" />
                    imageUrl: https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000
                    imageText: hoegaarden-kit
                    imageLastModified: '2020-10-07T12:49:27.5800000Z'
                  sellers:
                  - sellerId: '1'
                    sellerName: COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE
                    addToCartLink: https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1
                    sellerDefault: true
                    commertialOffer:
                      DeliverySlaSamplesPerRegion:
                        '0':
                          DeliverySlaPerTypes: []
                          Region: null
                      Installments:
                      - Value: 42
                        InterestRate: 0
                        TotalValuePlusInterestRate: 42
                        NumberOfInstallments: 1
                        PaymentSystemName: Visa
                        PaymentSystemGroupName: creditCardPaymentGroup
                        Name: Visa à vista
                      - Value: 21
                        InterestRate: 0
                        TotalValuePlusInterestRate: 42
                        NumberOfInstallments: 2
                        PaymentSystemName: Visa
                        PaymentSystemGroupName: creditCardPaymentGroup
                        Name: Visa 2 vezes sem juros
                      - Value: 14
                        InterestRate: 0
                        TotalValuePlusInterestRate: 42
                        NumberOfInstallments: 3
                        PaymentSystemName: Visa
                        PaymentSystemGroupName: creditCardPaymentGroup
                        Name: Visa 3 vezes sem juros
                      - Value: 10.5
                        InterestRate: 0
                        TotalValuePlusInterestRate: 42
                        NumberOfInstallments: 4
                        PaymentSystemName: Visa
                        PaymentSystemGroupName: creditCardPaymentGroup
                        Name: Visa 4 vezes sem juros
                      - Value: 42
                        InterestRate: 0
                        TotalValuePlusInterestRate: 42
                        NumberOfInstallments: 1
                        PaymentSystemName: Promissory
                        PaymentSystemGroupName: promissoryPaymentGroup
                        Name: Promissory à vista
                      DiscountHighLight: []
                      GiftSkuIds: []
                      Teasers:
                      - <Name>k__BackingField: TesteInfoAdicional
                        <GeneralValues>k__BackingField:
                          Time: Flamengo
                          Nome: Pedro
                          Camisa: '9'
                        <Conditions>k__BackingField:
                          <MinimumQuantity>k__BackingField: 0
                          <Parameters>k__BackingField:
                          - <Name>k__BackingField: PaymentMethodId
                            <Value>k__BackingField: '4'
                        <Effects>k__BackingField:
                          <Parameters>k__BackingField:
                          - <Name>k__BackingField: PercentualDiscount
                            <Value>k__BackingField: '1'
                      PromotionTeasers:
                      - Name: TesteInfoAdicional
                        GeneralValues:
                          Time: Flamengo
                          Nome: Pedro
                          Camisa: '9'
                        Conditions:
                          MinimumQuantity: 0
                          Parameters:
                          - Name: PaymentMethodId
                            Value: '4'
                        Effects:
                          Parameters:
                          - Name: PercentualDiscount
                            Value: '1'
                      BuyTogether: []
                      ItemMetadataAttachment: []
                      Price: 42
                      ListPrice: 42
                      PriceWithoutDiscount: 42
                      RewardValue: 0
                      PriceValidUntil: '4000-01-01T03:00:00Z'
                      AvailableQuantity: 16
                      IsAvailable: true
                      Tax: 0
                      SaleChannel: 0
                      DeliverySlaSamples:
                      - DeliverySlaPerTypes: []
                        Region: null
                      GetInfoErrorMessage: null
                      CacheVersionUsedToCallCheckout: 95EF7E5476DF276E679167A399FE3103_
                      PaymentOptions:
                        installmentOptions:
                        - paymentSystem: '2'
                          bin: null
                          paymentName: Visa
                          paymentGroupName: creditCardPaymentGroup
                          value: 4200
                          installments:
                          - count: 1
                            hasInterestRate: false
                            interestRate: 0
                            value: 4200
                            total: 4200
                            sellerMerchantInstallments:
                            - id: MERCH
                              count: 1
                              hasInterestRate: false
                              interestRate: 0
                              value: 4200
                              total: 4200
                          - count: 2
                            hasInterestRate: false
                            interestRate: 0
                            value: 2100
                            total: 4200
                            sellerMerchantInstallments:
                            - id: MERCH
                              count: 2
                              hasInterestRate: false
                              interestRate: 0
                              value: 2100
                              total: 4200
                          - count: 3
                            hasInterestRate: false
                            interestRate: 0
                            value: 1400
                            total: 4200
                            sellerMerchantInstallments:
                            - id: MERCH
                              count: 3
                              hasInterestRate: false
                              interestRate: 0
                              value: 1400
                              total: 4200
                          - count: 4
                            hasInterestRate: false
                            interestRate: 0
                            value: 1050
                            total: 4200
                            sellerMerchantInstallments:
                            - id: MERCH
                              count: 4
                              hasInterestRate: false
                              interestRate: 0
                              value: 1050
                              total: 4200
                        - paymentSystem: '17'
                          bin: null
                          paymentName: Promissory
                          paymentGroupName: promissoryPaymentGroup
                          value: 4200
                          installments:
                          - count: 1
                            hasInterestRate: false
                            interestRate: 0
                            value: 4200
                            total: 4200
                            sellerMerchantInstallments:
                            - id: MERCH
                              count: 1
                              hasInterestRate: false
                              interestRate: 0
                              value: 4200
                              total: 4200
                        paymentSystems:
                        - id: 17
                          name: Promissory
                          groupName: promissoryPaymentGroup
                          validator: null
                          stringId: '17'
                          template: promissoryPaymentGroup-template
                          requiresDocument: false
                          isCustom: false
                          description: null
                          requiresAuthentication: false
                          dueDate: '2021-07-01T18:43:00.0264384Z'
                          availablePayments: null
                        - id: 2
                          name: Visa
                          groupName: creditCardPaymentGroup
                          validator: null
                          stringId: '2'
                          template: creditCardPaymentGroup-template
                          requiresDocument: false
                          isCustom: false
                          description: null
                          requiresAuthentication: false
                          dueDate: '2021-07-01T18:43:00.0264384Z'
                          availablePayments: null
                        payments: []
                        giftCards: []
                        giftCardMessages: []
                        availableAccounts: []
                        availableTokens: []
                  Videos: []
                  estimatedDateArrival: null
              schema:
                type: array
                items:
                  type: object
                  required:
                  - productId
                  - productName
                  - brand
                  - brandId
                  - brandImageUrl
                  - linkText
                  - productReference
                  - productReferenceCode
                  - categoryId
                  - productTitle
                  - metaTagDescription
                  - releaseDate
                  - clusterHighlights
                  - productClusters
                  - searchableClusters
                  - categories
                  - categoriesIds
                  - link
                  - Percentuals
                  - Percentual
                  - Total
                  - Teste de Api
                  - Ale
                  - Teste da Api2
                  - Alcool
                  - allSpecifications
                  - allSpecificationsGroups
                  - description
                  - items
                  properties:
                    productId:
                      type: string
                      description: Product unique identifier.
                      example: '35'
                    productName:
                      type: string
                      description: Product name.
                      example: Kit de Hoegaarden
                    brand:
                      type: string
                      description: Brand name.
                      example: Hoegaarden
                    brandId:
                      type: integer
                      description: Product brand ID.
                      example: 2000004
                    brandImageUrl:
                      type: string
                      description: Product's brand image URL.
                      example: https://merch.vteximg.com.br/arquivos/ids/155532/hoegardden-logo.jpg
                    linkText:
                      type: string
                      description: Product URL.
                      example: kit-6-cerveja-hoegaarden
                    productReference:
                      type: string
                      description: Product reference.
                      example: 000806
                    productReferenceCode:
                      type: integer
                      description: Product reference ID.
                      nullable: true
                      example: 1234
                    categoryId:
                      type: string
                      description: Product category ID.
                      example: '1'
                    productTitle:
                      type: string
                      description: Text that is in the browser tab and corresponds to the title of the product page. This field is important for SEO.
                      example: Kit 6 cerveja Hoegaarden
                    metaTagDescription:
                      type: string
                      description: Brief description of the category. It's recommended that you don't exceed 150 characters so that the search engines can display it correctly in the results page.
                      example: Category for Beers
                    releaseDate:
                      type: string
                      description: Product release date.
                      example: '2020-10-07T00:00:00'
                    clusterHighlights:
                      type: object
                      description: Cluster highlight ID and name.
                      example:
                        '138': teste2
                    productClusters:
                      type: object
                      description: Product clusters' IDs and names.
                      example:
                        '138': teste2
                        '143': NaoPesquisavel
                        '146': colecaotestesubcategoria
                        '161': merch_import_test1
                    searchableClusters:
                      type: object
                      description: Searchable clusters IDs and names
                      example:
                        '138': teste2
                    categories:
                      type: array
                      description: Array of the product's categories URLs.
                      example:
                      - /Beers Beers Mesmo/
                    categoriesIds:
                      type: array
                      description: Array of the product's categories IDs.
                      example:
                      - /1/
                    link:
                      type: string
                      description: Product URL.
                      example: https://merch.vtexcommercestable.com.br/kit-6-cerveja-hoegaarden/p
                    allSpecifications:
                      type: array
                      description: Array of the product's specifications.
                      example:
                      - Percentuals
                      - Percentual
                      items:
                        type: string
                        description: Product specification.
                        example: Percentual
                    allSpecificationsGroups:
                      type: array
                      description: Array of the product's specifications groups.
                      example:
                      - Total
                      - Teste da Api2
                      items:
                        type: string
                        description: Product specification group
                        example: Teste da Api2
                    description:
                      type: string
                      description: Description of the main information related to the product. A simple and easy to understand summary for the customer.
                      example: Description example
                      nullable: true
                    items:
                      type: array
                      description: Array containing the product SKU general information.
                      example:
                      - itemId: '310118469'
                        name: Kit com 6
                        nameComplete: Kit de Hoegaarden Kit com 6
                        complementName: ''
                        ean: ''
                        referenceId:
                        - Key: RefId
                          Value: 000806
                        measurementUnit: un
                        unitMultiplier: 1
                        modalType: null
                        isKit: true
                        kitItems:
                        - itemId: '310118466'
                          amount: 6
                        images:
                        - imageId: '155489'
                          imageLabel: ''
                          imageTag: <img src="~/arquivos/ids/155489-#width#-#height#/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000" width="#width#" height="#height#" alt="hoegaarden-kit" id="" />
                          imageUrl: https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000
                          imageText: hoegaarden-kit
                          imageLastModified: '2020-10-07T12:49:27.5800000Z'
                        sellers:
                        - sellerId: '1'
                          sellerName: COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE
                          addToCartLink: https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1
                          sellerDefault: true
                          commertialOffer:
                            DeliverySlaSamplesPerRegion:
                              '0':
                                DeliverySlaPerTypes: []
                                Region: null
                            Installments:
                            - Value: 42
                              InterestRate: 0
                              TotalValuePlusInterestRate: 42
                              NumberOfInstallments: 1
                              PaymentSystemName: Visa
                              PaymentSystemGroupName: creditCardPaymentGroup
                              Name: Visa à vista
                            - Value: 21
                              InterestRate: 0
                              TotalValuePlusInterestRate: 42
                              NumberOfInstallments: 2
                              PaymentSystemName: Visa
                              PaymentSystemGroupName: creditCardPaymentGroup
                              Name: Visa 2 vezes sem juros
                            - Value: 14
                              InterestRate: 0
                              TotalValuePlusInterestRate: 42
                              NumberOfInstallments: 3
                              PaymentSystemName: Visa
                              PaymentSystemGroupName: creditCardPaymentGroup
                              Name: Visa 3 vezes sem juros
                            - Value: 10.5
                              InterestRate: 0
                              TotalValuePlusInterestRate: 42
                              NumberOfInstallments: 4
                              PaymentSystemName: Visa
                              PaymentSystemGroupName: creditCardPaymentGroup
                              Name: Visa 4 vezes sem juros
                            - Value: 42
                              InterestRate: 0
                              TotalValuePlusInterestRate: 42
                              NumberOfInstallments: 1
                              PaymentSystemName: Promissory
                              PaymentSystemGroupName: promissoryPaymentGroup
                              Name: Promissory à vista
                            DiscountHighLight: []
                            GiftSkuIds: []
                            Teasers:
                            - <Name>k__BackingField: TesteInfoAdicional
                              <GeneralValues>k__BackingField:
                                Time: Flamengo
                                Nome: Pedro
                                Camisa: '9'
                              <Conditions>k__BackingField:
                                <MinimumQuantity>k__BackingField: 0
                                <Parameters>k__BackingField:
                                - <Name>k__BackingField: PaymentMethodId
                                  <Value>k__BackingField: '4'
                              <Effects>k__BackingField:
                                <Parameters>k__BackingField:
                                - <Name>k__BackingField: PercentualDiscount
                                  <Value>k__BackingField: '1'
                            PromotionTeasers:
                            - Name: TesteInfoAdicional
                              GeneralValues:
                                Time: Flamengo
                                Nome: Pedro
                                Camisa: '9'
                              Conditions:
                                MinimumQuantity: 0
                                Parameters:
                                - Name: PaymentMethodId
                                  Value: '4'
                              Effects:
                                Parameters:
                                - Name: PercentualDiscount
                                  Value: '1'
                            BuyTogether: []
                            ItemMetadataAttachment: []
                            Price: 42
                            ListPrice: 42
                            PriceWithoutDiscount: 42
                            RewardValue: 0
                            PriceValidUntil: '4000-01-01T03:00:00Z'
                            AvailableQuantity: 16
                            IsAvailable: true
                            Tax: 0
                            SaleChannel: 0
                            DeliverySlaSamples:
                            - DeliverySlaPerTypes: []
                              Region: null
                            GetInfoErrorMessage: null
                            CacheVersionUsedToCallCheckout: 95EF7E5476DF276E679167A399FE3103_
                            PaymentOptions:
                              installmentOptions:
                              - paymentSystem: '2'
                                bin: null
                                paymentName: Visa
                                paymentGroupName: creditCardPaymentGroup
                                value: 4200
                                installments:
                                - count: 1
                                  hasInterestRate: false
                                  interestRate: 0
                                  value: 4200
                                  total: 4200
                                  sellerMerchantInstallments:
                                  - id: MERCH
                                    count: 1
                                    hasInterestRate: false
                                    interestRate: 0
                                    value: 4200
                                    total: 4200
                                - count: 2
                                  hasInterestRate: false
                                  interestRate: 0
                                  value: 2100
                                  total: 4200
                                  sellerMerchantInstallments:
                                  - id: MERCH
                                    count: 2
                                    hasInterestRate: false
                                    interestRate: 0
                                    value: 2100
                                    total: 4200
                                - count: 3
                                  hasInterestRate: false
                                  interestRate: 0
                                  value: 1400
                                  total: 4200
                                  sellerMerchantInstallments:
                                  - id: MERCH
                                    count: 3
                                    hasInterestRate: false
                                    interestRate: 0
                                    value: 1400
                                    total: 4200
                                - count: 4
                                  hasInterestRate: false
                                  interestRate: 0
                                  value: 1050
                                  total: 4200
                                  sellerMerchantInstallments:
                                  - id: MERCH
                                    count: 4
                                    hasInterestRate: false
                                    interestRate: 0
                                    value: 1050
                                    total: 4200
                              - paymentSystem: '17'
                                bin: null
                                paymentName: Promissory
                                paymentGroupName: promissoryPaymentGroup
                                value: 4200
                                installments:
                                - count: 1
                                  hasInterestRate: false
                                  interestRate: 0
                                  value: 4200
    

# --- truncated at 32 KB (435 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vtex/refs/heads/main/openapi/vtex-search-api-openapi.yml