Skip to content

Getting started

What is Storesynk?Build with AI Try it in 2 minutes Connect your store Set up your project Core concepts Go live

Features

All features Bundles Mix & match Product add-ons Volume discounts Customer accounts Customer pricing Page gates Localization Analytics Back in stock Plans and billing

Guides

Build with AI

Build with AI Claude Code Claude Desktop Cursor Lovable What the AI can do

Products

Display product info Images and gallery Variant options Quantity Add to cart and buy now Subscriptions Metafields Sale badge SEO and product JSON-LD

Collections & search

Product grid Filtered collection Sort and price range Load more Search page Predictive search

Cart

Cart drawer Cart page Discount codes Cart note Checkout link

Frameworks

Plain HTML (no build step)Astro Next.js React SSR (TanStack Start, Remix, Vite)Converting existing HTML

Troubleshooting

Troubleshooting The core diagnostic lens Nothing renders Add to cart & the cart Options & variants Subscriptions Metafields Images & media Search & product lists Collections & filtering Bundles Volume discounts Mix & match Product add-ons Customer accounts & pricing Money & formatting Markets & localization Setup & credentials Analytics & back in stock Server-side rendering & adoption

Reference

Tags

Tag reference Context model Required-ancestor matrix Template-clone containers Engine-managed attributes Tag catalog Accessibility Server-side rendering & adoption Structural / providers Lists & search Collections & filtering Product displayers Media Options Subscriptions - selling plans Metafields Quantity Actions Bundles Volume discounts Mix & match Product add-ons Customer accounts Customer pricing Cart line Cart Markets locale pickers Complete tag index TypeScript typings

Validator rules

Validator rules Code families Ancestor & descendant Fragments & framework files Required-ancestor vocabulary SSK-1xx - structure & nesting SSK-2xx - attributes SSK-3xx - tag identity SSK-4xx - setup SSK-5xx - accessibility Reporting

@storesynk/core

analytics

Variables

parseProviderList

Functions

routeClientDestinations

References

AnalyticsCart AnalyticsCartLine AnalyticsEvent AnalyticsEventMap AnalyticsEventName CartLineUpdatePayload CartUpdatePayload CartViewPayload CollectionViewPayload ConsentConfig createStorefrontAnalytics CustomEventPayload PageViewPayload PayloadFor ProductPayload ProductViewPayload ShopAnalytics StorefrontAnalytics StorefrontAnalyticsConfig StorefrontAnalyticsDestination StorefrontAnalyticsDestinationSetupContext StorefrontAnalyticsOptions

index

Namespaces

cartQueries

variables

CART_BUYER_IDENTITY_UPDATE CART_CREATE CART_DISCOUNT_CODES_UPDATE CART_LINES_ADD CART_LINES_REMOVE CART_LINES_UPDATE CART_NOTE_UPDATE CART_QUERY

productQueries

type-aliases

BundlesMetafieldData CustomerPricingMetafieldData MediaData MetafieldData ProductData ProductOptionData VariantData VolumeDiscountsMetafieldData VolumeDiscountsProductData

variables

CATALOG_LISTING COLLECTION_LISTING COLLECTION_PRODUCTS CUSTOMER_PRICING PREDICTIVE_SEARCH PRODUCT_BUNDLES PRODUCT_BY_HANDLE PRODUCT_BY_ID PRODUCT_HANDLES PRODUCT_METAFIELDS PRODUCTS_LIST SEARCH_PRODUCTS VOLUME_DISCOUNTS

Classes

CustomerAuthRequiredError

Interfaces

Observable StoresynkCartConfig StoresynkConfig StoresynkPixelsConfig

Type Aliases

AccountPortalSource AnyStorefrontQueryString AvailableCountry AvailableLanguage BucketedLines BundleEntry BundleMemberProduct BundleMemberVariant BundleMetaobject BundlePricing Cart CartBuyerIdentity CartLineInput CartMutationResult CartTransport CartTransportContext CreateStorefrontConfig CustomerApiEndpoints CustomerAuthEndpoints CustomerCookieData CustomerData CustomerDisplayerConfig CustomerPricingAdoptData CustomerPricingEntry CustomerPricingMetaobject CustomerPricingPreview CustomerPricingRefs CustomerSession CustomerSessionConfig CustomerSessionState CustomerSessionStatus CustomerTokens CustomerTokenStorage DisplayerConfig FetchPageGatesOptions GateAccess GateCustomer GateDecision GateDenied GatePathRule I18n I18nSource I18nState InferResult InferVariables InstallStandardActionsConfig ListingFilterData ListingFilterValueData ListingSearchState LiveBundle LocalePersistOption LocalePersistStrategy LocalizationData MoneyInput NormalizedProduct PageGateEntry PageGateMetaobject PageGatesMetafieldData PendingAuth ProductRenderState ResolvedBundleMember ResolvedVolumeTier RestoredCustomerSession ResultOf ShopData Storefront StorefrontClient StorefrontClientConfig StorefrontError StorefrontQueryString StorefrontResult VolumeDiscountAdoptData VolumeDiscountEntry VolumeDiscountMetaobject VolumeDiscountRefs VolumeTier VolumeTierPricing

Variables

buildImageSrcset BUNDLE_VARIANT_CAP BUNDLES_KEY CONFIG_PAYLOAD_ATTR CONFIG_PAYLOAD_SELECTOR createStorefrontCartTransport CUSTOMER_COOKIE_NAME CUSTOMER_PRICING_KEY CUSTOMER_PRICING_NOTE_DEFAULT CUSTOMER_PRICING_PROMPT_DEFAULT CUSTOMER_TOKENS_KEY customerDisplayerRegistry decodePriceParam DEFAULT_CUSTOMER_SCOPES DEFAULT_IMAGE_WIDTHS displayerRegistry facetMatches facetValueVisible findVariantByOptions gql LISTING_PAYLOAD_ATTR LISTING_PAYLOAD_SELECTOR listingFacetKey LOCALE_COOKIE_NAME LOCALE_STORAGE_KEY LOCALIZATION_PAYLOAD_ATTR LOCALIZATION_PAYLOAD_SELECTOR LOCALIZATION_QUERY mediaIndexForVariant PAGE_GATES PAGE_GATES_DEFAULT_TTL_MS PAGE_GATES_KEY parseListingParams PRODUCT_PAYLOAD_ATTR PRODUCT_PAYLOAD_SELECTOR registerCartTransportFactory resolveCartTransport resolvePreferredOptions resolveReadableFilters SHOP_PAYLOAD_ATTR SHOP_PAYLOAD_SELECTOR SHOP_QUERY sizedImageUrl VOLUME_DISCOUNTS_KEY

Functions

addLines appendAccountPath applyVariantSelection bundleMemberToProduct computeBundlePricing computeCustomerPricingPreview computeVolumeTierPricing createCart createContextMoneyFormatter createCustomerSession createMoneyFormatter createObservable createProductRenderState createStorefront createStorefrontClient currentI18n customerPricingApplies defaultVolumeTierIndex deriveAccountPortalUrl discoverAccountUrl discoverApiEndpoints discoverAuthEndpoints evaluateGates fetchCustomer fetchLocalization fetchPageGates gatePathRuleMatches hasCustomerSessionHint initialSellingPlanId installStandardActions isBundleActive isCustomerPricingLive isCustomerPricingMember isSyntheticOption isSyntheticVariantTitle isVolumeDiscountLive memberSubtotal memberVariantsTruncated memoryTokenStorage normalizeGatePath normalizeProduct parseBundleMetaobject parseCustomerCookie parseCustomerPricingMetaobject parseLocaleCookie parsePageGateMetaobject parseVolumeDiscountMetaobject queryCart readTokens removeLines resolve resolveBundleMembers resolveCustomerPricingCopy resolveLiveBundles resolveLocalePersist resolvePath resolvePurchaseDefault resolveTierTemplate resolveVolumeTiers restoreCustomerSessionFromCookie richTextToHtml sanitizeI18nState selectCustomerPricing selectInitialVariant selectVolumeDiscount serializeCustomerCookie serializeJsonPayload storefrontApiUrl toShopData updateBuyerIdentity updateDiscountCodes updateLines updateNote

References

AnalyticsCart AnalyticsCartLine AnalyticsEventMap AnalyticsEventName CartLineUpdatePayload CartState CartStore CartUpdatePayload CartViewPayload CollectionViewPayload ConsentConfig createCartStore CustomEventPayload formatMoney MediaData MetafieldData PageViewPayload PayloadFor ProductData ProductOptionData ProductPayload ProductViewPayload ShopAnalytics StorefrontAnalytics StorefrontAnalyticsConfig StorefrontAnalyticsDestination StorefrontAnalyticsDestinationSetupContext StorefrontAnalyticsOptions VariablesOf VariantData

server

Type Aliases

CollectionListingData MetafieldsMap ProductJsonLdOptions RenderCollectionContext RenderContext RenderListContext RenderLocalePickersContext RenderShop

Functions

collectCustomerPricingNamespace collectMetafieldIdentifiers collectVolumeDiscountNamespace productJsonLd renderCollectionListing renderCustomerChrome renderListItems renderLocalePickers renderProductFragment

References

appendAccountPath CONFIG_PAYLOAD_ATTR CONFIG_PAYLOAD_SELECTOR createMoneyFormatter createProductRenderState CUSTOMER_COOKIE_NAME CustomerCookieData CustomerData CustomerPricingAdoptData discoverAccountUrl DisplayerConfig displayerRegistry fetchLocalization I18nState LISTING_PAYLOAD_ATTR LISTING_PAYLOAD_SELECTOR LOCALE_COOKIE_NAME LOCALIZATION_PAYLOAD_ATTR LOCALIZATION_PAYLOAD_SELECTOR LOCALIZATION_QUERY LocalizationData NormalizedProduct normalizeProduct parseCustomerCookie parseLocaleCookie PRODUCT_PAYLOAD_ATTR PRODUCT_PAYLOAD_SELECTOR ProductRenderState resolvePath restoreCustomerSessionFromCookie RestoredCustomerSession selectInitialVariant serializeJsonPayload SHOP_PAYLOAD_ATTR SHOP_PAYLOAD_SELECTOR SHOP_QUERY ShopData toShopData VolumeDiscountAdoptData

@storesynk/astro

index

Interfaces

StoresynkOptions

Type Aliases

GatesMiddlewareOptions I18nState ListingSearchState

Variables

parseListingParams

Functions

createGatesMiddleware default

runtime

Type Aliases

FetchOptions ListingQuery RequestLocaleSource ResolvedStoresynkOptions

Functions

getAccountUrl getAllProducts getClient getCollectionListing getCollectionProducts getConfig getCustomerPricing getCustomerSession getLocalization getProduct getProductHandles getProductMetafields getShop getVolumeDiscounts resolveRequestLocale

@storesynk/next

client

References

StoresynkRuntime

index

Interfaces

ProductMetadataOptions StoresynkCollectionProps StoresynkListProps StoresynkLocalePickerProps StoresynkProductJsonLdProps StoresynkProductProps StoresynkStaticProps StoresynkStoreProps

Type Aliases

I18nState ListingSearchState RequireGateOptions RestoredCustomerSession StoresynkConfig StoresynkUserConfig StoresynkWebhookHandlerOptions

Variables

getRequestCustomer getRequestLocale installServerCartTransport parseListingParams StoresynkServerCart

Functions

configureStoresynk createStoresynkWebhookHandler getConfig productMetadata requireGate StoresynkCollection StoresynkList StoresynkLocalePicker StoresynkProduct StoresynkProductJsonLd StoresynkRuntime StoresynkStatic StoresynkStore

runtime

Type Aliases

FetchOptions ListingQuery

Variables

numericShopifyId

Functions

getAccountUrl getAllProducts getClient getCollectionListing getCollectionProducts getCustomerPricing getLocalization getProduct getProductHandles getProductMetafields getShop getVolumeDiscounts

References

configureStoresynk getConfig StoresynkConfig StoresynkUserConfig

@storesynk/react

index

Interfaces

PreparedCollection PreparedFragment PreparedList PreparedProduct PreparedStore StoresynkCollectionProps StoresynkListProps StoresynkLocalePickerProps StoresynkProductJsonLdProps StoresynkProductProps StoresynkStaticProps StoresynkStoreProps

Type Aliases

StoresynkConfig StoresynkUserConfig

Variables

configureStoresynk StoresynkCollection StoresynkList StoresynkLocalePicker StoresynkProduct StoresynkProductJsonLd StoresynkRuntime StoresynkStatic StoresynkStore

server

Interfaces

ProductSeo ProductSeoOptions RenderCollectionOptions RenderListOptions RenderProductJsonLdOptions RenderProductOptions RenderStoreOptions

Type Aliases

CookieSource FetchOptions GateCheck GateCheckOptions I18nState ListingQuery ListingSearchState RenderLocalePickerOptions RequestScope RestoredCustomerSession

Variables

checkGate createRequestScope getAccountUrl getAllProducts getClient getCollectionListing getCollectionProducts getConfig getCustomerPricing getLocalization getProduct getProductHandles getProductMetafields getRequestCustomer getRequestLocale getShop getVolumeDiscounts parseListingParams productSeo renderCollection renderList renderLocalePicker renderProduct renderProductJsonLd renderStore stringifySlot

References

configureStoresynk PreparedCollection PreparedFragment PreparedList PreparedProduct PreparedStore StoresynkConfig StoresynkUserConfig

getClient

const getClient: () => StorefrontClient

Defined in: @storesynk/react/dist/runtime.d.ts:17

Returns

Section titled “Returns”

StorefrontClient

On this page

Overview
Returns

Storesynk is open development. Packages, engine and docs live in the storesynk GitHub org.

Getting started

What is Storesynk?Build with AI Try it in 2 minutes Connect your store Set up your project Core concepts Go live

Features

All features Bundles Mix & match Product add-ons Volume discounts Customer accounts Customer pricing Page gates Localization Analytics Back in stock Plans and billing

Guides

Troubleshooting

Troubleshooting The core diagnostic lens Nothing renders Add to cart & the cart Options & variants Subscriptions Metafields Images & media Search & product lists Collections & filtering Bundles Volume discounts Mix & match Product add-ons Customer accounts & pricing Money & formatting Markets & localization Setup & credentials Analytics & back in stock Server-side rendering & adoption

Reference