template?

Record<string, string>

(Optional)

templateId?

string

(Optional)

templateMetadata

{ applyUniqueVersion?: boolean; settingsCssUrl?: string; themeCssUrl?: string; themeCssVersion?: string; themeLibVersion?: string; themeNameLib?: string; setupVersion?: "v1" | "v2" | "v3"; templateVersion?: string; updatedAt?: number; integratedTheme?: { [themeId: string]: { collectionPage?: boolean; searchPage?: boolean; instantSearch?: boolean; productListSelector?: { collectionPage?: string[]; searchPage?: string[]; }; isOnboarding?: boolean; selectorFromAppEmbed?: string; neededToHideElements?: string[]; selectorFromMetafield?: string; selectedSelector?: string; placeholderAdded?: boolean; placeholder?: string; }; }; customizedFallback?: { source: "Shopify"; templateName?: string; templateURL?: string; }; } & { [templateName: string]: string; }

templateSettings

{ additionalElementSettings?: { customSortingList?: string; enableCollectionSearch?: boolean; }; appPreferenceSettings: { watermark: boolean; }; currentAppIntegration: {}; filterSettings: { activeScrollToTop: boolean; availableAfterFiltering: boolean; changeMobileButtonLabel: boolean; filterLayout: "vertical" | "horizontal"; filterTreeHorizontalStyle: "style1" | "style2" | "style3" | "style-expand"; filterTreeMobileStyle: "style1" | "style2" | "style2-fullwidth" | "style3" | "style3-fullwidth"; filterTreeVerticalStyle: "style-default" | "style-off-canvas" | "style-expand"; isShortenUrlParam: boolean; keepToggleState: boolean; productAndVariantAvailable: boolean; showFilterOptionCount: boolean; showLoading: boolean; showOutOfStockOption: boolean; showRefineBy: boolean; showSingleOption: boolean; showVariantImageBasedOnSelectedFilter: string; sortingAvailableFirst: boolean; stickyFilterOnDesktop: boolean; stickyFilterOnMobile: boolean; style?: { filterMobileButtonBackgroundColor: string; filterMobileButtonFontFamily: string; filterMobileButtonFontSize: number | string; filterMobileButtonFontTransform: string; filterMobileButtonFontWeight: number | string; filterMobileButtonTextColor: string; filterOptionFontFamily: string; filterOptionFontSize: number | string; filterOptionTextColor: string; filterTitleFontFamily: string; filterTitleFontSize: number | string; filterTitleFontTransform: "none" | "capitalize" | "uppercase" | "lowercase"; filterTitleFontWeight: number | string; filterTitleTextColor: string; }; generalSettings: { addCollectionToProductUrl: boolean; breakpointdesktop: string; breakpointmobile: string; breakpointtabletlandscapemax: string; breakpointtabletlandscapetmin: string; breakpointtabletportraitmax: string; breakpointtabletportraitmin: string; }; preOrderSettings?: { buttonText?: string; deliveryText?: string; showDeliveryText?: boolean; }; searchSettings?: { enableFuzzySearch?: boolean; enableDefaultResult?: boolean; showSuggestionLoading?: boolean; showSearchBtnMobile?: boolean; removePriceDecimal?: boolean; highlightSuggestionResult?: boolean; openProductNewTab?: boolean; suggestionMode?: "prod" | "test"; reduceMinMatch?: boolean; fullMinMatch?: boolean; enablePlusCharacterSearch?: boolean; suggestionMaxHeight?: number; suggestionDymLimit?: number; skipFields?: Array<string>; showVariantsAsProduct?: boolean; extraParamsISWToSearchPage?: string; suggestionStyle?: "style1" | "style2" | "style3"; suggestionMobileStyle?: "style1" | "style2"; suggestionMobileProductItemType?: "list" | "grid"; suggestionStyle1ProductItemType?: "list" | "grid"; suggestionStyle1ProductPosition?: "none"; suggestionStyle1ProductPerRow?: 1 | 2; suggestionStyle2ProductItemType?: "list" | "grid"; suggestionStyle2ProductPosition?: "left" | "right"; suggestionStyle2ProductPerRow?: 1 | 2; suggestionStyle3ProductItemType?: "list" | "grid"; suggestionStyle3ProductPosition?: "left" | "right"; suggestionStyle3ProductPerRow?: 2 | 3; showSearchBtnStyle3?: boolean; readonly suggestionBlocks: Array<{ type: "suggestions" | "collections" | "pages" | "products"; label: string; status: "active" | "disabled"; number: number; }>; productAvailable: boolean; showSuggestionProductVendor: boolean; showSuggestionProductPrice: boolean; showSuggestionProductSalePrice: boolean; showSuggestionProductImage: boolean; showSuggestionProductSku: boolean; searchBoxOnclick: Readonly<{ recentSearch: { label: string; status: boolean; number: number; }; searchTermSuggestion: { label: string; status: boolean; data: Array<string>; }; productSuggestion: { label: string; status: boolean; data: Array<string | number>; }; }>; searchPanelBlocks: Readonly<{ products: { label: string; pageSize: number | string; active: boolean; displayImage: boolean; }; collections: { label: string; pageSize: number | string; active: boolean; displayImage: boolean; displayDescription: boolean; }; pages: { label: string; pageSize: number | string; active: boolean; displayImage: boolean; displayExcerpt: boolean; }; searchTermSuggestions: { label: string; type: string; active: boolean; searchTermList: Array<string>; }; mostPopularProducts: { label: string; type: string; active: boolean; productList: Array<string>; }; searchEmptyResultMessages: { label: string; active: boolean; }; searchTips: { label: string; active: boolean; searchTips: string; }; }>; readonly suggestionNoResult: { search_terms: { label: string; status: boolean; data: Array<string>; backup?: Array<string>; }; products: { label: string; status: boolean; data: Array<string | number>; backup?: Array<string | number>; }; }; }; srcThemeNameLib: string; themeName: string; themeSettings: { productItems: { general: {}; productImg: {}; productInfo: {}; }; additionalElements: {}; quickView: {}; cart: {}; productList: {}; searchPage: {}; filterTree: {}; isw: {}; }; }; searchSettings: {}; themeSettings: ThemeSettings; }

templateUrl?

string

(Optional)