JUMP TO📝 OverviewOverviewPlatformsTLS Support🎨 IntegrationsTweakwise APISearchMerchandisingSuggestionsGuided SellingRecommendationsItemsFacetsColor swatchesSliderBucket sliderSearch within filtersSorting, ordering and pagingLanguage SupportHow toOverride App ConfigurationUse request parametersPersonalization & insightsPass data to External Data providerTweakwise JS + Plugin StudioGetting startedConfigure Plugin StudioPlugin configurationCreating product tilesLook & feelDeployCopy configurationBasic web app configurationSearch & MerchandisingInstant SearchSearch + SuggestionsMerchandisingGoogle AnalyticsManual initializationLanguage supportOptionsEventsDefaultsPersonalizationSuggestionsOptionsLanguage support / translationsMigrating from instant search to suggestionsCategory suggestion navigationRecommendationsOptionsEventsGuided SellingOptionsEventsCustomize resultsMeasuring the FunnelHow toAdd to cartAdd to favorites / wishlistProduct SuggestionsColor swatchesRealtime pricingMeasure impressions using GA4Use request parametersSupport common B2B scenariosOverride builder, sorting & filter templatesPass data to External Data provider (JS)Modify visual tileImpact on SEOTypescriptKnown issuesEvent TagIdentificationProfilesServer to serverMagento PlatformMagento 2 Open SourceMagento JSInstallationExport data to TweakwiseConsuming data from Tweakwise in MagentoAdobe CommerceMagento 1 / OpenMagePersonalizationHow toCustomize visual tilesCustomer specific catalogShopwareInstallationExport data to TweakwiseConfigure the Tweakwise feed with ShopwareGenerate the Tweakwise feed with ShopwareContent of the feedConsuming data from TweakwiseConfigure a new frontendConfigure your Shopware listing pageRecommendations in ShopwareMigrate your plugin from legacy Javascript to Plugin StudioAvailable featuresVendreSana CommerceSana adoption matrixFrontend APIIntroductionAutocompleteAutocompletegetGrouped autocompletegetCatalogFilter templatesgetSorting templatesgetBuildersgetFeatured recommendationsgetProduct recommendationsgetProduct recommendations groupsgetGuided Selling setupsgetLanguagesgetCategory treeCategory treegetFacetsFacetsgetFacet attributesgetFeedFeedgetGuided sellingComparegetFunnelgetInstanceInstancegetNavigationNavigationgetGrouped navigationgetNavigation searchSearchgetGrouped searchgetProductsProductsgetProductgetRecommendationsProduct recommendationsgetProduct recommendations single rulegetProduct recommendations multi rulegetFeatured productsgetOptional parametersSearchbannerssearchbannersgetSuggestionsSuggestionsgetSuggestions groupedgetSuggestion productsgetSuggestion products groupedgetBackend APIIntroductionAuthenticationAttributeRefreshes the cache for the specified attribute.getGet attributesgetGet attributegetDelete attributedeleteGet attribute valuesgetGet distinct attribute valuesgetGet attribute usagesgetAutocompleteSuggestionGet all autocomplete suggestionsgetUpdate autocomplete suggestionputCreates a new autocomplete suggestionpostGet autocomplete suggestionsgetDelete autocomplete suggestiondeleteBlacklistedSuggestionGet all blacklisted suggestionsgetUpdate a blacklisted suggestionputCreate a blacklisted suggestionpostGet a blacklisted suggestiongetDelete a blacklisted suggestiondeleteCategoryGet category by keygetGet category by IDgetDelete categorydeletePatch categorypatchGet all categoriesgetUpdate categoryputCreate categorypostGet Category tree. If called without parameters it will return root.getGet Category tree childrengetLookup endpoint for categoriesgetGet category path by idgetEstablishedSuggestionGet all established suggestionsgetFilter TemplatesGet filter template by idgetDelete filter templatedeleteGet all filter templatesgetUpdate filter templateputCreate filter templatepostGet filter template attribute by idgetDelete filter template attributedeleteGet all filter template attributesgetUpdate filter template attributeputCreate filter template attributepostGet filter template usagesgetGoogle Analytics 4Get link stategetRemove linkgetGet metricsgetGet dimensionsgetGet propertiesgetGoogle Analytics 4 reportsGet reportsgetCreate reportpostGet reportgetUpdate reportputDelete reportdeletePreview report datapostHiddenFilterGet all hidden filters.getAdd a new hidden filter.postDelete a hidden filter.deleteInstanceGet instancegetGet list of instancesgetGet the instance configurationgetUpdate the instance configurationputInstance statisticsGet total productsgetGet total categoriesgetGet instance statisticsgetItemGet itemgetDelete itemdeletePatch itempatchGet all itemsgetUpdate itemputCreate itempostGet all item typesgetJavascriptGet file contentgetUpdate file contentpostInitializepostDeploypostGet changesgetCopy JS implementation from another instancepostManualSuggestionGet all manual suggestionsgetUpdate a manual suggestionputCreate a manual suggestionpostGet a manual suggestiongetDelete a manual suggestiondeletePersonalizationGet profile data by key.getBuilderGet buildergetDelete a builderdeleteGet all buildersgetUpdate builderputCreates a new builderpostGet builder usagesgetGet available componentsgetGet builder click rategetBuilder AuthorizationsGet an authorizationgetDelete an authorizationdeleteGet all authorizationsgetUpdate an authorizationputCreate an authorizationpostGet authorization usagesgetBuilder External Data ComponentGet an external data componentgetDelete an external data componentdeleteGet all external data componentsgetUpdate an external data componentputCreate an external data componentpostGet external data component usagesgetGet the performance of the external data componentgetProductGet productgetDelete productdeletePatch productpatchGet all productsgetUpdate productputCreate productpostResponseDataAttributeGet all response data attributes.getCreate a new response data attribute.postDelete a response data attribute.deleteSynonymGet suggestionsgetGet all synonymsgetUpdates a synonym with the specified data, overrides all fields to the new value.putCreate synonympostGet synonym for given idgetDelete the synonymdeleteGet the current state of the AI synonyms generation feature.getUpdate the state of the AI synonyms generation feature.putTaskStart taskgetGet task statusgetAnalytics APIIntroductionEventsTrack item clickpostTrack page viewpostTrack purchasepostTrack searchpostOlder integrationsClassic Tweakwise JSSearch & MerchandisingInstallationProduct lister pagesGoogle AnalyticsOptionsRecommendationsOptionsGuided SellingOptionsSuggestionsMigrating from instant search to autocompleteOptionsCommon customizationsCustom stylingAdd to cartAdd to favorites / wishlistColor facetVAT price switcherCustomize product suggestionsImpact on SEOPowered by Known issues Our JavaScript solutions are not fully compatible with platforms using the Prototype JS JavaScript library
