JUMP TO📝 OverviewOverviewPlatformsTLS Support🎨 IntegrationsTweakwise APISearchMerchandisingSuggestionsGuided SellingItemsFacetsColor swatchesSliderBucket sliderSearch within filtersSorting, ordering and pagingLanguage SupportOverriding App ConfigurationTweakwise JS + Plugin StudioGetting startedConfigure Plugin StudioPlugin configurationCreating product tilesLook & feelDeployCopy configurationBasic web app configurationSearch & MerchandisingInstant SearchSearch + SuggestionsMerchandisingGoogle AnalyticsManual initializationOptionsEventsSuggestionsMigrating from instant search to suggestionsOptionsCategory suggestion navigationRecommendationsOptionsEventsGuided SellingOptionsEventsCustomize resultsMeasuring the FunnelExamplesAdd to cartAdd to favorites / wishlistProduct SuggestionsColor swatchesRealtime pricingMeasure impressions using GA4Impact on SEOTypescriptKnown issuesTweakwise JSSearch & MerchandisingInstallationProduct lister pagesGoogle AnalyticsOptionsRecommendationsOptionsGuided SellingOptionsSuggestionsMigrating from instant search to autocompleteOptionsCommon customizationsCustom stylingAdd to cartAdd to favorites / wishlistColor facetVAT price switcherCustomize product suggestionsImpact on SEOMagento PlatformAdobe CommerceMagento 2 Open SourceMagento 1 / OpenMagePersonalizationShopware🔎 Frontend APIIntroductionAutocompleteAutocompletegetGrouped autocompletegetCatalogFilter templatesgetSorting templatesgetFeatured recommendationsgetProduct recommendationsgetProduct recommendations groupsgetGuided Selling setupsgetLanguagesgetCategory treeCategory treegetFacetsFacetsgetFacet attributesgetFeedFeedgetGuided sellingComparegetFunnelgetInstanceInstancegetNavigationNavigationgetGrouped navigationgetNavigation searchSearchgetGrouped searchgetProductsProductsgetProductgetRecommendationsProduct recommendationsgetProduct recommendations single rulegetProduct recommendations groupedgetFeatured productsgetOptional parametersSearchbannerssearchbannersgetSuggestionsSuggestionsgetSuggestions groupedgetSuggestion productsgetSuggestion products groupedgetBackend APIIntroductionAuthenticationAttributeGet attributesgetGet attributegetDelete attributedeleteGet attribute valuesgetGet attribute usagesgetCategoryGet 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 childrengetFilter 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 all (usage) links for filter templategetGoogle Analytics 4Get link stategetRemove linkgetGet metricsgetGet dimensionsgetGet propertiesgetGoogle Analytics 4 reportsGet reportsgetCreate reportpostGet reportgetUpdate reportputDelete reportdeletePreview report datagetPreview report datapostInstanceGet instancegetGet list of instancesgetGet the instance configurationgetInstance statisticsGet total productsgetGet total categoriesgetGet instance statisticsgetItemGet itemgetDelete itemdeletePatch itempatchGet all itemsgetUpdate itemputCreate itempostGet all connected categories for an item.getGet all item types.getJavascriptGet file contentgetUpdate file contentpostInitializepostDeploypostGet changesgetCopy JS implementation from another instancepostBuilderGet buildergetDelete a builderdeleteGet all buildersgetUpdate builderputCreates a new builderpostGet builder usagesgetGet available componentsgetBuilder AuthorizationsGet an authorizationgetUpdate an authorizationputDelete an authorizationdeleteGet all authorizationsgetCreate an authorizationpostGet usage links of an authorizationgetBuilder External Data ComponentGet an external data componentgetDelete an external data componentdeleteGet all external data componentsgetUpdate an external data componentputCreate an external data componentpostGet usage links of external data componentgetGet the performance of the external data componentgetProductGet productgetDelete productdeletePatch productpatchGet all productsgetUpdate productputCreate productpostSynonymGet 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 statusget📈 Analytics APIIntroductionEventsTrack page viewpostTrack purchasepostTrack searchpostPowered by FiltersSee facets.
