# Quickbutik Developers - [Quickbutik Developers](https://quickbutik.dev/index.md): Welcome! Here you'll find everything you need to create beautiful themes and powerful integrations for e-commerce stores. - [Build with AI](https://quickbutik.dev/build-with-ai.md): Use AI tools to accelerate your Quickbutik integration development with our OpenAPI specification - [Resources](https://quickbutik.dev/resources.md): Essential resources, tools, and references for Quickbutik developers - [Introduction](https://quickbutik.dev/theme-development/introduction.md): Build beautiful, dynamic storefronts with Quickbutik's powerful templating system - [Quickstart Tutorial](https://quickbutik.dev/theme-development/quickstart.md): Build your first custom Quickbutik theme template in 15 minutes - [Template Structure](https://quickbutik.dev/theme-development/template-structure.md): Understanding Quickbutik theme architecture and file organization - [Mustache Template Basics](https://quickbutik.dev/theme-development/mustache-basics.md): Master the fundamentals of Mustache templating for Quickbutik themes - [Objects and Attributes](https://quickbutik.dev/theme-development/objects-and-attributes.md): Understanding Mustache objects, attributes, and property access in Quickbutik themes - [Conditionals](https://quickbutik.dev/theme-development/conditionals.md): Master advanced conditional logic, boolean operations, and dynamic content display in Mustache templates - [Wrappers and Functions](https://quickbutik.dev/theme-development/wrappers-and-functions.md): Master helper functions, data wrappers, and content manipulation in Quickbutik themes - [Shop Object](https://quickbutik.dev/theme-development/global/shop.md): Access store settings, configuration, and global information - [User Object](https://quickbutik.dev/theme-development/global/user.md): Access customer account and authentication information - [Settings Object](https://quickbutik.dev/theme-development/global/settings.md): Access theme-specific customizable settings and configuration - [Basket Object](https://quickbutik.dev/theme-development/global/basket.md): Access shopping cart data, items, and checkout functionality - [Navigation Object](https://quickbutik.dev/theme-development/global/navigation.md): Build dynamic navigation menus and breadcrumbs using available link lists - [SEO Object](https://quickbutik.dev/theme-development/global/seo.md): Access basic SEO meta tags for search engine optimization - [Product Object](https://quickbutik.dev/theme-development/pages/product.md): Display individual product information, images, variants, and purchase options - [Category Object](https://quickbutik.dev/theme-development/pages/category.md): Display category pages with basic category information - [Order Object](https://quickbutik.dev/theme-development/pages/order.md): Display order confirmation, thank you pages, and order details - [Blog Object](https://quickbutik.dev/theme-development/pages/blog.md): Display blog posts and articles using the basic blog functionality - [Static Pages](https://quickbutik.dev/theme-development/pages/static.md): Display static content pages using the basic page object - [Quickbutik Kit](https://quickbutik.dev/kit/introduction.md): Build your own storefront on any stack with @quickbutik/kit, using your Quickbutik catalog, cart and hosted checkout. - [Quickstart](https://quickbutik.dev/kit/quickstart.md): A catalog, a cart and a hosted checkout in five minutes with @quickbutik/kit. - [Create a shop without an account](https://quickbutik.dev/kit/create-a-shop.md): One unauthenticated request gives you a real Quickbutik shop with a catalog, a cart and a hosted checkout. Build on it, then hand it over to the merchant by email. - [Installation](https://quickbutik.dev/kit/installation.md): Install @quickbutik/kit from npm or load it from a CDN, and choose the right entry point. - [Publishable keys](https://quickbutik.dev/kit/publishable-keys.md): The qb_pk_ key that drives a storefront: where to find it, what it can do, and how to keep the merchant token out of the browser. - [Vanilla JS setup](https://quickbutik.dev/kit/vanilla/setup.md): Use the framework-free @quickbutik/kit client with your own rendering, in the browser or on a server. - [Build a storefront in plain JavaScript](https://quickbutik.dev/kit/vanilla/storefront.md): Catalog, product page with a variant picker, cart, checkout and thank-you page, rendered by hand with the framework-free client. - [Server-side rendering](https://quickbutik.dev/kit/vanilla/server-side.md): Use @quickbutik/kit on Node, Hono, Express, Astro and Cloudflare Workers with per-request cookie storage. - [React setup](https://quickbutik.dev/kit/react/setup.md): Install the React layer of @quickbutik/kit, wrap your app in ShopkitProvider and decide where the client lives. - [Catalog and products](https://quickbutik.dev/kit/react/catalog-and-products.md): List and search products with React hooks, build product pages with ProductProvider and render a variant picker from headless components. - [Cart and checkout](https://quickbutik.dev/kit/react/cart-and-checkout.md): Build the cart, hand the shopper to the hosted Quickbutik checkout (or render it inline), and confirm the order on the thank-you page. - [Next.js App Router](https://quickbutik.dev/kit/react/nextjs.md): The reference architecture for a Quickbutik storefront on the Next.js App Router: server components for reads, server actions for writes, client hooks for the cart. - [Web components setup](https://quickbutik.dev/kit/web-components/setup.md): Use the kit's headless custom elements in any stack: with a bundler (Vite, Astro, Vue, Svelte, Nuxt) or with one script tag and no build step. - [Templates, bindings and actions](https://quickbutik.dev/kit/web-components/templates.md): How the kit's elements bind data into your markup: data-qb-* bindings, repeated templates, actions, reflected state and money formatting. - [Build a storefront with web components](https://quickbutik.dev/kit/web-components/storefront.md): Complete pages built from the kit's custom elements: catalog with search, product page with a variant picker, cart, checkout and the thank-you page. - [Scripting the elements](https://quickbutik.dev/kit/web-components/scripting.md): window.Quickbutik, the qb: event catalogue and recipes for driving the kit's elements from your own JavaScript. - [Checkout and the return leg](https://quickbutik.dev/kit/concepts/checkout.md): Hand the shopper to the hosted Quickbutik checkout, bring them back to your thank-you page and confirm the order. - [Embedded checkout](https://quickbutik.dev/kit/concepts/embedded-checkout.md): Render the hosted Quickbutik checkout inside your own page, with redirect payment methods and fallbacks handled for you. - [Storage and server rendering](https://quickbutik.dev/kit/concepts/storage-and-ssr.md): How the kit remembers the cart, and how a server and a browser agree on the same one. - [Images, money and product content](https://quickbutik.dev/kit/concepts/images.md): Render product images from the CDN, format prices from minor units and use variant images, content sections and related products. - [Currencies](https://quickbutik.dev/kit/concepts/currencies.md): Let shoppers browse, and optionally pay, in another currency: the shop's offered currencies, display and charge mode, switching, server rendering and the checkout. - [Customer accounts](https://quickbutik.dev/kit/concepts/customer-accounts.md): Let shoppers log in, register and reset a forgotten password on a headless storefront: customer-group prices, the customer club, sessions and renewal, and where to keep the session on a server. - [SEO and structured data](https://quickbutik.dev/kit/concepts/seo.md): Titles, canonicals, OpenGraph and schema.org JSON-LD for products, categories and the shop. - [Consent and analytics](https://quickbutik.dev/kit/concepts/consent-and-analytics.md): The cookie banner, Google Consent Mode, the merchant's GA4, GTM and Meta pixel, commerce events and the purchase. On by default, nothing to wire up. - [Campaign storefronts](https://quickbutik.dev/kit/concepts/campaign-storefronts.md): Sell into a campaign storefront (Säljsida) with its own prices, quantity limits and time window. - [Testing and going live](https://quickbutik.dev/kit/concepts/going-live.md): Test the full purchase loop without paying, build inside AI app builders, and ship to production. - [Troubleshooting](https://quickbutik.dev/kit/troubleshooting.md): Symptom, cause and fix for the problems headless Quickbutik storefronts run into most. - [Client](https://quickbutik.dev/kit/reference/client.md): createShopkitClient, every ShopkitConfig option, and what the client exposes. - [Products, categories & shop](https://quickbutik.dev/kit/reference/products.md): Read the catalog: products, search, categories and the shop's branding. - [Cart](https://quickbutik.dev/kit/reference/cart.md): The stateless Cart API, the remembered cart, and the shared CartStore. - [Checkout](https://quickbutik.dev/kit/reference/checkout.md): Start the hosted checkout, render it inline, and confirm the order on the thank-you page. - [Utilities](https://quickbutik.dev/kit/reference/utilities.md): Framework-free helpers: the variant matrix, images, money, currencies, SEO, storage, campaign refusals, consent and analytics. - [Errors & scopes](https://quickbutik.dev/kit/reference/errors.md): The error classes the kit throws, the scopes a publishable key can carry, customer-account errors and the campaign storefront refusals. - [Types](https://quickbutik.dev/kit/reference/types.md): The data shapes the kit returns: products, categories, the shop, carts, checkout sessions and confirmations. - [React](https://quickbutik.dev/kit/reference/react.md): Every provider, hook and headless component exported from @quickbutik/kit/react. - [Web components](https://quickbutik.dev/kit/reference/elements.md): Every qb-* element: attributes, properties, scope paths, reflected state and events, plus configure() and defineElements(). - [Script tag](https://quickbutik.dev/kit/reference/script-tag.md): Every data-* attribute of the script-tag build, the full window.Quickbutik API, and the Content Security Policy it needs. - [Introduction](https://quickbutik.dev/api-v1/introduction.md): Everything you need to start integrating with the Quickbutik API - [Authentication](https://quickbutik.dev/api-v1/authentication.md): Secure your API requests with Basic Authentication - [Quickstart Tutorial](https://quickbutik.dev/api-v1/quickstart-tutorial.md): Build your first Quickbutik integration in 15 minutes - [Order Synchronization Tutorial](https://quickbutik.dev/api-v1/guides/order-sync-tutorial.md): Build a complete order sync system with webhooks and automatic retry logic - [Inventory Management](https://quickbutik.dev/api-v1/guides/inventory-management.md): Keep your product stock levels synchronized across platforms - [Get preorders](https://quickbutik.dev/api-v1/settings/get-preorders.md) - [Webhooks](https://quickbutik.dev/webhooks/introduction.md): Get real-time notifications when events occur in your Quickbutik store - [Events](https://quickbutik.dev/webhooks/events.md) - [Webhook Setup](https://quickbutik.dev/webhooks/setup.md): Configure and troubleshoot your webhook endpoints - [Get preorder options](https://quickbutik.dev/api-v1/settings/get-preorder-options.md): Retrieve all preorder options configured for the store. These options can be assigned to products and variants to indicate pre-order availability and estimated delivery windows. - [Get scripts](https://quickbutik.dev/api-v1/scripts/get-scripts.md): List all storefront scripts or get a specific script by ID - [Create script](https://quickbutik.dev/api-v1/scripts/create-script.md): Create a new storefront script - [Update or create script](https://quickbutik.dev/api-v1/scripts/update-or-create-script.md): Update an existing script or create one with a specific ID - [Delete script](https://quickbutik.dev/api-v1/scripts/delete-script.md): Delete a storefront script - [Get orders](https://quickbutik.dev/api-v1/orders/get-orders.md): Retrieve a list of orders with optional filtering, pagination and sorting. - [Update orders](https://quickbutik.dev/api-v1/orders/update-orders.md): Update one or more existing orders. Each request object must include the `order_id` of the order to update, plus any fields you want to change - [Create orders](https://quickbutik.dev/api-v1/orders/create-orders.md): Create new order and add order content. Status for new orders will always be set to **unpaid** - [Get products](https://quickbutik.dev/api-v1/products/get-products.md): Fetch products in store with optional filtering. When no specific product_id or sku is provided, the following filters can be used to search and filter products. - [Update products](https://quickbutik.dev/api-v1/products/update-products.md): Update products in store. Product can be identified by product_id/variant_id or directly with SKU/Article Number if unique - [Create products](https://quickbutik.dev/api-v1/products/create-products.md): Create and add products to store - [Delete products](https://quickbutik.dev/api-v1/products/delete-products.md): Deletes a product from the store entirely. **NOTE:** This is non-reversible - [Count products](https://quickbutik.dev/api-v1/products/count-products.md): Fetches a count of the total number of products - [Get categories](https://quickbutik.dev/api-v1/categories/get-categories.md): Fetch store categories - [Create category](https://quickbutik.dev/api-v1/categories/create-category.md): Create a new product category - [Get payment methods](https://quickbutik.dev/api-v1/payment-methods/get-payment-methods.md): Fetch store payment methods - [Get shipping methods](https://quickbutik.dev/api-v1/shipping-methods/get-shipping-methods.md): Fetch store shipping methods - [Get metadata](https://quickbutik.dev/api-v1/metadata/get-metadata.md): Get metadata for selected scope and id - [Update metadata](https://quickbutik.dev/api-v1/metadata/update-metadata.md): Update metadata to selected scope. Delete when empty value - [Create metadata](https://quickbutik.dev/api-v1/metadata/create-metadata.md): Add metadata to selected scope ## OpenAPI Specs - [openapi](/openapi.yaml) ## Optional - [Quickbutik](https://quickbutik.com/sv) - [Support](https://quickbutik.com/sv/support) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.