CookiezyCookiezy
ProductPlatformsDocsPricingBlogContact
  1. Home/
  2. Docs/
  3. Shopify Adapter Setup

Documentation last updated May 27, 2026

Docs navigation

Overview

DocsDeveloper-first documentation for installing, configuring, and verifying Cookiezy across every supported adapter.Getting StartedCheck readiness, generate the right package, then ship the core flow.InstallationInstallation follows the same core pattern everywhere: generate the issued package, register the hostname, install the adapter, and validate runtime verification before launch.ConfigConfiguration keeps locale, policy, categories, layout, and licensing context in sync.

Reference

APIDeveloper-facing runtime methods, browser events, and verification-aware integration notes.

Adapters

Webflow Adapter SetupTechnical Webflow setup guide for Cookiezy: what you receive after purchase, where each file goes, and how to validate the runtime on a published Webflow site.Shopify Adapter SetupTechnical Shopify setup guide for Cookiezy: download Platform Core, deploy the theme app extension, expose the Theme Editor fields, and validate storefront consent behavior before publish.Wix Adapter SetupTechnical Wix setup guide for Cookiezy: install the private or unlisted Wix app, connect the correct Cookiezy account, publish the app-hosted runtime, and keep custom code only as a fallback.Hugo Adapter SetupTechnical Hugo setup guide for Cookiezy: generate the dedicated Hugo package, copy the issued config scaffold, align locale routes, and validate banner plus cookie audit behavior.Headless Adapter SetupTechnical headless setup guide for Cookiezy: boot the plain adapter, wire runtime verification, and validate the audit, settings, and restricted-mode recovery flow in custom frontends.WordPress Adapter SetupTechnical WordPress setup guide for Cookiezy: upload the plugin ZIP, configure licensing-aware settings, and validate shortcode-based settings and audit behavior.React Adapter SetupTechnical React setup guide for Cookiezy: load the plain adapter from the app shell, gate optional services with consent state, and validate SPA behavior.Next.js Adapter SetupTechnical Next.js setup guide for Cookiezy: load the plain adapter from the root layout, keep policy routing localized, and validate consent gating across App Router pages.Strapi Adapter SetupTechnical Strapi setup guide for Cookiezy: keep the runtime on the frontend, use Strapi as a configuration bridge, and map locale-aware policy URLs through the shared core model.DatoCMS Adapter SetupTechnical DatoCMS setup guide for Cookiezy: keep the visitor-facing runtime in the frontend app, use Platform Core for runtime assets, and use the standalone DatoCMS plugin only for editor-side configuration and generated frontend config preview.
Adapter versioningShopify adapter

Shopify adapter release status

Current Shopify storefront lane version and rollout notes for the extension shipped inside Platform Core.

Current version

0.1.23

Delivery lane

Included in Platform Core

Compatibility notes

Shopify storefront rollout still ships through Platform Core while the standalone app lane remains separate.

Key rollout changes

1. Use the theme app extension from Platform Core.

2. Treat the embedded app lane as separate admin surface, not the primary storefront installer.

3. Validate the embed block in a development store before live rollout.

Overview

Shopify adapter: post-purchase rollout

Use this guide after payment to move from generated ZIP to storefront verification. The Shopify runtime layer lives in the theme app extension. The optional embedded app is a separate admin and billing lane for larger productized rollouts.

  • • Download `cookiezy-platform-core.zip` from `/en/downloads`.
  • • For Shopify use `packages/adapters/shopify/theme-app-extension/` from that package.
  • • Start with a Shopify development store and extension-only app before touching the live theme.
  • • Register the exact storefront hostname in billing before enabling the Cookiezy embed block.
  • • Validate homepage, product, collection, cart, and policy page behavior in a clean session.
Developer documentation screenshot for the Cookiezy Shopify adapter showing the theme app extension and storefront embed flow.
Shopify technical reference: Platform Core package, embed block, and storefront verification path.
Step 1

Download Platform Core and keep the Shopify files intact

Shopify is currently delivered inside Platform Core rather than as a standalone ZIP. Keep the file names intact because the Liquid block and loader reference them directly.

Code snippet

packages/adapters/shopify/theme-app-extension/assets/cookie-consent-shopify-loader.js
packages/adapters/shopify/theme-app-extension/assets/cookie-consent.js
packages/adapters/shopify/theme-app-extension/assets/cookie-consent-ui.js
packages/adapters/shopify/theme-app-extension/assets/cookie-consent-scanner.js
packages/adapters/shopify/theme-app-extension/assets/cookie-consent.css
packages/adapters/shopify/theme-app-extension/assets/shopify-customer-privacy-bridge.js
packages/adapters/shopify/theme-app-extension/blocks/cookiezy-embed.liquid
packages/adapters/shopify/theme-app-extension/locales/en.default.json
packages/adapters/shopify/theme-app-extension/locales/en.default.schema.json
Step 2

Use a development store and extension-only app for the first smoke test

The lowest-friction first test is a Shopify development store plus an extension-only app. Generate a theme app extension, copy the Cookiezy Shopify files into that extension workspace, then preview from there.

  • • Create a Shopify development store in Partner Dashboard.
  • • Create an extension-only app for the first storefront smoke test.
  • • Generate a theme app extension and copy the full `theme-app-extension/` directory contents into it.
  • • Remove demo scaffold leftovers before testing so only the Cookiezy block remains.
Step 3

Expose the Theme Editor settings that merchants actually need

The embed block should expose the production values directly in Theme Editor so merchants or delivery teams can finish setup without editing Liquid by hand.

  • • Cookie policy URL
  • • Cookiezy Site Key
  • • License verification URL
  • • Billing / portal URL
  • • Banner layout
  • • Theme CSS class
Step 4

Register the exact storefront hostname before you publish

Cookiezy licensing checks the exact storefront hostname at runtime. Register the host that the storefront actually uses, not just the one that feels equivalent in Shopify admin.

  • • `my-shop.myshopify.com` and a custom storefront domain are different hostnames.
  • • If you test on the custom domain, register the custom domain.
  • • If you test on the `myshopify.com` host, register that exact hostname.
  • • After setup, confirm `/api/licensing/verify` returns `allowed: true` for the storefront hostname.
Step 5

Deploy the extension and validate storefront behavior

Deploy the theme app extension, enable `cookiezy-embed` in the active theme, then test in theme preview or a clean session before publishing live theme changes.

  • • Confirm Theme Editor shows all expected settings before save.
  • • Homepage shows the banner on first visit.
  • • Product, collection, and cart pages do not leak optional tracking before consent.
  • • Reject optional blocks analytics and marketing categories.
  • • The policy page audit renders and reflects the current state after re-scan.
Troubleshooting

Quick checks when Shopify consent does not behave as expected

Most Shopify rollout issues come from config visibility, exact hostname mismatches, or stale assets rather than from the core consent runtime itself.

  • • If `verify_url` or `billing_url` do not appear in Theme Editor, check the extension schema and locale files.
  • • If the storefront falls into restricted mode, inspect `window.CookiezyConfig` and confirm `siteKey`, `verifyUrl`, and `billingUrl` are populated.
  • • If licensing still fails, verify that the exact storefront hostname is registered in Cookiezy billing.
  • • If you updated the package, make sure the theme app extension assets were redeployed and the active theme uses the new embed build.
Cookiezy

Lightweight consent platform for modern websites.

Product

FeaturesPlatformsPricingDocsBlogContact

Legal

Cookie PolicyPrivacy PolicyTerms

Language

English
EnglishenSlovenščinaslHrvatskihrItalianoit

Privacy controls

© 2026 Cookiezy. All rights reserved.