Spree Commerce is an API-first, open-source eCommerce platform built for fast growing businesses and enterprises.Spree allows you to build B2B eCommerce, multi-store, multi-region, multi-vendor marketplace, and multi-tenant commerce - and you can combine them to match your exact business model.If SaaS solutions don’t give you the control and flexibility your business needs, Spree is the answer.Spree is trusted by thousands of businesses around the world, including GoDaddy, Huckberry, Craftsman, DieHard, Kenmore, Paccar, Maisonette, Goop, Garmentory, and Blue Bottle Coffee.
This Spree user documentation is intended for business owners and site administrators of Spree e-commerce sites. Everything you need to know to configure and manage your Spree store can be found here.If you are a developer, you may find the Developer Guides to be of benefit to you, though we strongly urge you to read through both sets of guides.BTW Give Spree a GitHub Star, why don’t ya?Thank you for supporting Spree open-source!
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Spree Commerce documentation","colors":{"primary":"#0077ff","light":"#4d9fff","dark":"#0060ce"},"logo":{"light":"https://mintcdn.com/spreecommerce/LxcAXa2TB_svesfi/logo/logo_light.png?fit=max\u0026auto=format\u0026n=LxcAXa2TB_svesfi\u0026q=85\u0026s=fccc5873d5c7a3eeb4e644f96d694ba9","dark":"https://mintcdn.com/spreecommerce/LxcAXa2TB_svesfi/logo/logo_dark.png?fit=max\u0026auto=format\u0026n=LxcAXa2TB_svesfi\u0026q=85\u0026s=3aeefb84d53af450ad04b7283e4d661b"},"favicon":"https://mintcdn.com/spreecommerce/OgdQHBPQ0RbaKyDN/favicon.png?fit=max\u0026auto=format\u0026n=OgdQHBPQ0RbaKyDN\u0026q=85\u0026s=dc14ac5e60560349252428b1dde69c74","api":{"openapi":["api-reference/store.yaml","api-reference/storefront.yaml","api-reference/platform.yaml"],"examples":{"languages":["javascript","curl"]},"mdx":{"server":["http://localhost:3000"]}},"navbar":{"links":[{"icon":{"name":"github","library":"lucide"},"href":"https://github.com/spree/spree","label":"16k"},{"icon":{"name":"discord","library":"lucide"},"href":"https://discord.spreecommerce.org","label":"Join Discord"}]},"footer":{"socials":{"github":"https://github.com/spree/spree","x":"https://x.com/spreecommerce"}},"seo":{"metatags":{"og:locale":"en_US","twitter:site":"@spreecommerce"}},"fonts":{"heading":{"family":"Geist"},"body":{"family":"Geist"}},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","codeblocks":{"theme":"night-owl"},"latex":true},"integrations":{"ga4":{"measurementId":"G-NCVLCVHL5Y"}},"contextual":{"options":["copy","view","chatgpt","claude","mcp","cursor","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"spreecommerce","hasAudioNarration":false,"actualSubdomain":"spreecommerce","customDomains":["spreecommerce.org"],"gitSource":{"type":"github","owner":"spree","repo":"spree","deployBranch":"main","contentDirectory":"docs","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adfbbe8e55c0c9c0ccda2a6","collectionId":"609e6f33-0e32-4480-b257-6ef8b8e4ddf2","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adfbbe8e55c0c9c0ccda2a6"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adfbbe8e55c0c9c0ccda2a6","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API Reference","count":1119},{"language":"default","tag":"Endpoints","count":784},{"language":"default","tag":"Admin API","count":544},{"language":"default","tag":"Legacy API v2","count":313},{"language":"default","tag":"Platform API","count":231},{"language":"default","tag":"Documentation","count":171},{"language":"default","tag":"Develop","count":171},{"language":"default","tag":"User Guide","count":153},{"language":"default","tag":"Seller API","count":138},{"language":"default","tag":"Store API","count":129}]},"assistantConfig":{"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"deflection":{"enabled":true,"email":"hello@spreecommerce.org","showHelpButton":true}},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":":root{--spree-accent:#0077ff;--spree-accent-strong:#0060ce;--spree-sand-50:#fcfaf7;--spree-sand-100:#f7f5f2;--spree-sand-150:#e9e5dd;--spree-sand-200:#e2dfd8;--spree-dark-sand-500:#32302e;--spree-dark-sand-600:#272626;--spree-dark-sand-700:#1e1c1b;--spree-dark-sand-800:#191818;--spree-neutral-100:#eaeaea;--spree-neutral-200:#d5d5d5;--spree-neutral-400:#999999;--spree-neutral-600:#666666;--spree-neutral-700:#4d4d4d;--spree-neutral-900:#1a1a1a;--spree-ink:#1a1a1a;--spree-heading:#061932;--spree-ink-muted:#666666;--spree-border:#e2dfd8;--spree-sidebar-hover:rgb(0 0 0 / 0.04);--spree-sidebar-active:rgb(0 0 0 / 0.06);--spree-sidebar-radius:0.625rem;--spree-guide:#d8d4cb}.dark{--spree-sidebar-hover:rgb(255 255 255 / 0.06);--spree-sidebar-active:rgb(255 255 255 / 0.10);--spree-border:#3f3e3c;--spree-guide:#3f3e3c}html:not(.dark) body{background:var(--spree-sand-50)}html.dark body{background:var(--spree-dark-sand-800)}html:not(.dark) h1,html:not(.dark) h2,html:not(.dark) h3,html:not(.dark) h4{color:var(--spree-heading)}.nav-logo{height:32px}#sidebar-content .sidebar-group-header{display:none}#sidebar-content a,#sidebar-content button:not([class*=\"group/search\"]){border-radius:var(--spree-sidebar-radius)!important;padding-top:.3125rem!important;padding-bottom:.3125rem!important}#sidebar-content ul.sidebar-group>li>a,#sidebar-content ul.sidebar-group>li>button{font-weight:500;padding-top:.5rem!important;padding-bottom:.5rem!important}#sidebar-content ul.sidebar-group>li+li{margin-top:.25rem}#sidebar-content li[data-group-tag]>ul{margin-top:.125rem;margin-bottom:.375rem;position:relative}#sidebar-content a:hover,#sidebar-content button:not([class*=\"group/search\"]):hover{background-color:var(--spree-sidebar-hover)!important}#sidebar-content li[data-group-tag][data-active=true]>a,#sidebar-content li[data-group-tag][data-active=true]>button{background-color:var(--spree-sidebar-active)!important;color:var(--spree-neutral-900)!important;font-weight:600!important}.dark #sidebar-content a[class*=\"bg-primary-light/10\"],.dark #sidebar-content a[class*=\"bg-primary/10\"],.dark #sidebar-content li[data-group-tag][data-active=true]>a,.dark #sidebar-content li[data-group-tag][data-active=true]>button{color:#fff!important}#sidebar-content a[class*=\"bg-primary-light/10\"],#sidebar-content a[class*=\"bg-primary/10\"]{background-color:transparent!important;color:var(--spree-neutral-900)!important;font-weight:600!important;text-shadow:none!important}#sidebar-content a[class*=\"bg-primary-light/10\"]:hover,#sidebar-content a[class*=\"bg-primary/10\"]:hover{background-color:var(--spree-sidebar-hover)!important}#sidebar-content ul:not(.sidebar-group)>li>a,#sidebar-content ul:not(.sidebar-group)>li>button{padding-left:.5rem!important;margin-left:2.25rem;margin-right:.25rem;width:calc(100% - 2.5rem)!important}#sidebar-content ul:not(.sidebar-group) ul:not(.sidebar-group)>li>a,#sidebar-content ul:not(.sidebar-group) ul:not(.sidebar-group)>li>button{padding-left:.5rem!important;margin-left:3.75rem;width:calc(100% - 4rem)!important}#sidebar-content li[data-group-tag]>ul::before{content:\"\";position:absolute;left:1.75rem;top:0;bottom:0;width:1px;background-color:var(--spree-guide)}#sidebar-content li[data-group-tag] li[data-group-tag]>ul::before{left:3.25rem}#sidebar-content a svg[class*=bg-gray-],#sidebar-content button svg[class*=bg-gray-]{background-color:currentColor!important;opacity:.6}#sidebar-content a:hover svg[class*=bg-gray-],#sidebar-content button:hover svg[class*=bg-gray-],#sidebar-content li[data-group-tag][data-active=true]>button svg[class*=bg-gray-]{opacity:1}#content-container{border-color:var(--spree-border)!important}.dark #content-container{border-color:#3f3e3c!important}@media (min-width:1024px){#content-container{padding-left:3rem!important;padding-right:3rem!important}#content-container>.flex.flex-row-reverse{padding-left:0!important;column-gap:2.5rem!important}}#content-container .flex.flex-row-reverse>.max-w-xl{max-width:52rem}#almond-background-color{background-color:transparent!important}#navbar{background-color:var(--spree-sand-50)}.dark #navbar{background-color:var(--spree-dark-sand-800)}#navbar.is-custom{border-bottom:1px solid var(--spree-border)}.dark #navbar.is-custom{border-bottom-color:#3f3e3c}#navbar>.absolute.inset-0{display:none}.home-band{background:#fff}.dark .home-band{background:var(--spree-dark-sand-700)}.home-band-end{border-bottom:1px solid rgb(233 229 221/.8)}.dark .home-band-end{border-bottom-color:#3f3e3c}#content-container .link{border-bottom:0!important;color:var(--spree-accent)!important;text-decoration:none!important}#content-container .link:hover{color:var(--spree-accent-strong)!important}.dark #content-container .link{color:#4d9fff!important}.dark #content-container .link:hover{color:#7fb8ff!important}:has(>.changelog-header){max-width:56rem;margin:0 auto;padding:4rem 1.25rem 6rem}.changelog-header h1{font-size:2.25rem;font-weight:600;letter-spacing:-.02em;margin-bottom:.75rem}.changelog-header>[data-as=p],.changelog-header>p{color:var(--spree-ink-muted);font-size:1.0625rem;margin-bottom:1.25rem}.changelog-header .changelog-rss{display:inline-flex;align-items:center;gap:.5rem;margin-bottom:3.5rem;padding:.375rem .875rem;border:1px solid var(--spree-border);border-radius:9999px;font-size:.875rem;font-weight:500;text-decoration:none}.changelog-header .changelog-rss:hover{border-color:var(--spree-accent)}:has(>.changelog-header) [data-as=p],:has(>.changelog-header) p{display:block!important;margin:0 0 1rem;line-height:1.7}:has(>.changelog-header) ul{list-style:disc;padding-left:1.25rem;margin:0 0 1rem}:has(>.changelog-header) li{margin:.25rem 0;line-height:1.65}:has(>.changelog-header) li::marker{color:var(--spree-neutral-400)}:has(>.changelog-header) a{color:var(--spree-accent)}:has(>.changelog-header) a:hover{color:var(--spree-accent-strong)}.dark :has(>.changelog-header) a{color:#4d9fff}table{border:1px solid #d0d7de!important;border-radius:.5rem!important;border-collapse:separate!important;border-spacing:0!important;overflow:hidden!important;width:100%}table thead{background-color:#f3f4f6!important}table th{font-weight:500!important;text-align:left;color:#4b5563!important;padding:.625rem .875rem!important;border-bottom:1px solid #d0d7de!important}table td+td,table th+th{border-left:1px solid #e8ebee!important}table td{padding:.75rem .875rem!important;border-bottom:1px solid #e8ebee!important;vertical-align:middle}table tbody tr:last-child td{border-bottom:0!important}.dark table{border-color:#3d444d!important}.dark table thead{background-color:#21262d!important}.dark table th{color:#9198a1!important;border-bottom-color:#3d444d!important}.dark table td+td,.dark table th+th{border-left-color:#2a3038!important}.dark table td{border-bottom-color:#2a3038!important}"}],"page":{"pagePath":"user/what-is-spree-commerce","slug":"/user/what-is-spree-commerce","pageMetadata":{"title":"What is Spree Commerce","description":"What is Spree Commerce? What can I build with Spree?","href":"/user/what-is-spree-commerce"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"What is Spree Commerce? What can I build with Spree?\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components},{Heading,Icon,OptimizedImage}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Icon)_missingMdxReference(`Icon`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);return _jsxs(_Fragment,{children:[_jsx(OptimizedImage,{alt:`Spree Commerce - Open Source e-commerce platform`,classname:`block dark:hidden`,src:`https://raw.githubusercontent.com/spree/spree/e4ee6636d9a31c73761b0c76662d15b0f9899ecb/docs/images/Spree%20Commerce%20open-source%20eCommerce%20platform%20API%20headless%20Next.js.webp`}),`\n`,_jsx(Heading,{level:`2`,id:`about-spree-commerce`,children:`About Spree Commerce`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.a,{href:`https://spreecommerce.org/`,children:`Spree Commerce`}),` is an API-first, `,_jsx(_components.a,{href:`https://github.com/spree/spree`,children:`open-source eCommerce platform`}),` built for fast growing businesses and enterprises.`]}),`\n`,_jsxs(_components.p,{children:[`Spree allows you to build `,_jsx(_components.a,{href:`https://spreecommerce.org/use-cases/headless-b2b-ecommerce/`,children:`B2B eCommerce`}),`, `,_jsx(_components.a,{href:`https://spreecommerce.org/multi-store-ecommerce/`,children:`multi-store`}),`, `,_jsx(_components.a,{href:`https://spreecommerce.org/multi-region-ecommerce/`,children:`multi-region`}),`, `,_jsx(_components.a,{href:`https://spreecommerce.org/marketplace-ecommerce/`,children:`multi-vendor marketplace`}),`, and `,_jsx(_components.a,{href:`https://spreecommerce.org/multi-tenant-white-label-ecommerce/`,children:`multi-tenant commerce`}),` - and you can combine them to match your exact business model.`]}),`\n`,_jsx(_components.p,{children:`If SaaS solutions don’t give you the control and flexibility your business needs, Spree is the answer.`}),`\n`,_jsx(_components.p,{children:`Spree is trusted by thousands of businesses around the world, including GoDaddy, Huckberry, Craftsman, DieHard, Kenmore, Paccar, Maisonette, Goop, Garmentory, and Blue Bottle Coffee.`}),`\n`,_jsx(Heading,{level:`2`,id:`looking-for-developer-documentation`,children:`Looking for Developer Documentation?`}),`\n`,_jsx(_components.p,{children:`This Spree user documentation is intended for business owners and site administrators of Spree e-commerce sites. Everything you need to know to configure and manage your Spree store can be found here.`}),`\n`,_jsxs(_components.p,{children:[`If you are a developer, you may find the `,_jsx(_components.a,{href:`/developer`,children:`Developer Guides`}),` to be of benefit to you, though we strongly urge you to read through both sets of guides.`]}),`\n`,_jsxs(_components.p,{children:[`BTW Give Spree a `,_jsx(_components.a,{href:`https://github.com/spree/spree`,children:`GitHub Star`}),_jsx(Icon,{icon:`star`,iconType:`solid`,color:`#FFD43B`}),`, why don’t ya?`]}),`\n`,_jsxs(_components.p,{children:[`Thank you for supporting Spree open-source! `,_jsx(Icon,{icon:`heart`,iconType:`solid`,color:`#FF0000`})]}),`\n`,_jsx(Heading,{level:`2`,id:`join-spree-discord`,children:`Join Spree Discord`}),`\n`,_jsxs(_components.p,{children:[`To join the Spree Community and over 6000+ Spree users and developers, please join our `,_jsx(_components.a,{href:`https://discord.spreecommerce.org/`,children:`Discord`})]}),`\n`,_jsx(Heading,{level:`2`,id:`contacting-us`,children:`Contacting us`}),`\n`,_jsxs(_components.p,{children:[`If you’d like to get in touch to share your feedback, request features, or start a new project, please fill out the `,_jsx(_components.a,{href:`https://spreecommerce.org/get-started/`,children:`Contact form`})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":{"theme":"night-owl"},"config":{},"pageMetadata":{"title":"What is Spree Commerce","description":"What is Spree Commerce? What can I build with Spree?","href":"/user/what-is-spree-commerce"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"About Spree Commerce","slug":"about-spree-commerce","depth":2,"children":[]},{"title":"Looking for Developer Documentation?","slug":"looking-for-developer-documentation","depth":2,"children":[]},{"title":"Join Spree Discord","slug":"join-spree-discord","depth":2,"children":[]},{"title":"Contacting us","slug":"contacting-us","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"spreecommerce","siteName":"Spree Commerce documentation","title":"What is Spree Commerce - Spree Commerce documentation","navMaps":{"firstHrefInVersion":{"v6.x":{"href":"/user/what-is-spree-commerce","matchLevel":0},"v5.x":{"href":"/v5/user/what-is-spree-commerce","matchLevel":1,"canonicalOverride":true}},"firstHrefInLanguage":{}},"lastModified":"2026-09-17T16:04:25.019Z","originalFileLocation":"user/what-is-spree-commerce.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"What is Spree Commerce? What can I build with Spree?\">\u003cmeta data-mint-head name=\"application-name\" content=\"Spree Commerce documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"What is Spree Commerce - Spree Commerce documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"What is Spree Commerce? What can I build with Spree?\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Spree Commerce documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://spreecommerce.org/docs/user/what-is-spree-commerce\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://spreecommerce.mintlify.app/_mintlify/api/og/v2?division=Introduction\u0026amp;title=What+is+Spree+Commerce\u0026amp;description=What+is+Spree+Commerce%3F+What+can+I+build+with+Spree%3F\u0026amp;theme=69587fd3cce8800216628a20\u0026amp;signature=4ec70ed7bde22d3b53900be46e04143528560db187feb6d1f3b38e15a063db1a\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"What is Spree Commerce - Spree Commerce documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"What is Spree Commerce? What can I build with Spree?\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://spreecommerce.mintlify.app/_mintlify/api/og/v2?division=Introduction\u0026amp;title=What+is+Spree+Commerce\u0026amp;description=What+is+Spree+Commerce%3F+What+can+I+build+with+Spree%3F\u0026amp;theme=69587fd3cce8800216628a20\u0026amp;signature=4ec70ed7bde22d3b53900be46e04143528560db187feb6d1f3b38e15a063db1a\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Spree Commerce documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0077ff\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003clink data-mint-head rel=\"canonical\" href=\"https://spreecommerce.org/docs/user/what-is-spree-commerce\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/user/what-is-spree-commerce.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://spreecommerce.org/#organization\",\"name\":\"Spree Commerce documentation\",\"url\":\"https://spreecommerce.org\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/spreecommerce/LxcAXa2TB_svesfi/logo/logo_light.png?fit=max\u0026auto=format\u0026n=LxcAXa2TB_svesfi\u0026q=85\u0026s=fccc5873d5c7a3eeb4e644f96d694ba9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://spreecommerce.org/docs#website\",\"name\":\"Spree Commerce documentation\",\"url\":\"https://spreecommerce.org/docs\",\"publisher\":{\"@id\":\"https://spreecommerce.org/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://spreecommerce.org/docs/user/what-is-spree-commerce#webpage\",\"url\":\"https://spreecommerce.org/docs/user/what-is-spree-commerce\",\"name\":\"What is Spree Commerce\",\"description\":\"What is Spree Commerce? What can I build with Spree?\",\"dateModified\":\"2026-09-17T16:04:25.019Z\",\"isPartOf\":{\"@id\":\"https://spreecommerce.org/docs#website\"},\"breadcrumb\":{\"@id\":\"https://spreecommerce.org/docs/user/what-is-spree-commerce#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://spreecommerce.org/docs/user/what-is-spree-commerce#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Spree Commerce documentation\",\"item\":\"https://spreecommerce.org/docs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"What is Spree Commerce\",\"item\":\"https://spreecommerce.org/docs/user/what-is-spree-commerce\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://spreecommerce.org/docs/user/what-is-spree-commerce#article\",\"headline\":\"What is Spree Commerce\",\"name\":\"What is Spree Commerce\",\"description\":\"What is Spree Commerce? What can I build with Spree?\",\"url\":\"https://spreecommerce.org/docs/user/what-is-spree-commerce\",\"mainEntityOfPage\":{\"@id\":\"https://spreecommerce.org/docs/user/what-is-spree-commerce#webpage\"},\"dateModified\":\"2026-09-17T16:04:25.019Z\",\"publisher\":{\"@id\":\"https://spreecommerce.org/#organization\"},\"isPartOf\":{\"@id\":\"https://spreecommerce.org/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Spree Commerce documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Spree Commerce documentation","nav":{"global":null,"versions":[{"version":"v6.x","default":true,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/developer/getting-started/quickstart"}]},{"tab":"API Reference","menu":[{"item":"Store API","icon":"store","description":"REST API for storefronts and custom integrations","pages":[{"title":"Store API","href":"/api-reference/store-api/introduction"}]},{"item":"Admin API","icon":"shield","description":"REST API for pragmatically managing stores","pages":[{"title":"Admin API","href":"/api-reference/admin-api/introduction"}]},{"item":"Seller API","icon":"shop","description":"REST API for the marketplace seller panel","pages":[{"title":"Seller API","href":"/api-reference/seller-api/introduction"}]},{"item":"Webhooks","icon":"webhook","description":"Event payloads and delivery reference","pages":[{"title":"Webhooks","href":"/api-reference/webhooks-events"}]}],"pages":[{"title":"API Reference","href":"/api-reference/store-api/introduction"}]},{"tab":"User Guide","groups":[{"group":"Manage","pages":[{"group":"Introduction","icon":"book-open","pages":[{"title":"What is Spree Commerce","href":"/user/what-is-spree-commerce"},{"title":"Using Spree Commerce","description":"How do I start using Spree for my project? Should I pick the free open-source Community Edition? What is the pricing for the Enterprise Edition?","href":"/user/using-spree"},{"title":"User Quickstart","href":"/user/user-quickstart-guide"}]},{"group":"Products","icon":"package","pages":[{"title":"Products","href":"/user/products/products"},{"title":"Adding Products","href":"/user/products/adding-products"},{"title":"Variants","href":"/user/products/variants"},{"title":"Options","href":"/user/products/options"},{"title":"Media","href":"/user/products/media"},{"title":"Categories","href":"/user/products/categories"},{"title":"Collections","href":"/user/products/collections"},{"title":"Custom Product Fields","href":"/user/products/custom-product-fields"},{"title":"Import \u0026 Export","href":"/user/products/import-and-export"},{"title":"Import Template","href":"/user/products/import-template"}]},{"group":"Inventory","icon":"warehouse","pages":[{"title":"Inventory","href":"/user/inventory/stock-levels"},{"title":"Stock Transfers","href":"/user/inventory/stock-transfers"},{"title":"Purchase Orders","href":"/user/inventory/purchase-orders"},{"title":"Suppliers","href":"/user/inventory/suppliers"}]},{"group":"Pricing","icon":"tag","pages":[{"title":"Price Lists","href":"/user/pricing/price-lists"}]},{"group":"Catalogs","icon":"book-marked","pages":[{"title":"Catalogs","href":"/user/catalogs/catalogs"}]},{"group":"Translations","icon":"languages","pages":[{"title":"Translations","href":"/user/translations/translations"}]},{"group":"Orders","icon":"shopping-cart","pages":[{"title":"Orders","href":"/user/orders/orders"},{"title":"Processing Orders","href":"/user/orders/processing-orders"},{"title":"Draft Orders","href":"/user/orders/draft-orders"},{"title":"Returns","href":"/user/orders/returns"},{"title":"Exchanges","href":"/user/orders/exchanges"},{"title":"Claims","href":"/user/orders/claims"}]},{"group":"Customers","icon":"users","pages":[{"title":"Customers","href":"/user/customers/customers"},{"title":"Customer Profiles","href":"/user/customers/customer-profile"},{"title":"Groups","href":"/user/customers/customer-groups"},{"title":"Companies","href":"/user/customers/companies"}]},{"group":"Sellers","icon":"store","pages":[{"title":"Sellers","href":"/user/sellers/sellers"},{"title":"Onboarding","href":"/user/sellers/onboarding"},{"title":"Managing Sellers","href":"/user/sellers/managing-sellers"},{"title":"Seller Products","href":"/user/sellers/products"},{"title":"Marketplace Orders","href":"/user/sellers/orders"},{"title":"Commission Rates","href":"/user/sellers/commission-rates"},{"title":"Payouts","href":"/user/sellers/payouts"}]},{"group":"Loyalty","icon":"gift","pages":[{"title":"Gift Cards","href":"/user/loyalty/gift-cards"},{"title":"Store Credits","href":"/user/loyalty/store-credits"}]},{"group":"Promotions","icon":"ticket-percent","pages":[{"title":"Create a Promotion","href":"/user/promotions/create-a-promotion"},{"title":"Promotion Rules","href":"/user/promotions/promotion-rules"},{"title":"Promotion Actions","href":"/user/promotions/promotion-actions"}]},{"group":"Reports","icon":"chart-column","pages":[{"title":"Reports","href":"/user/reports/reports"}]},{"group":"AI Agents","icon":"bot","pages":[{"title":"AI Agents","href":"/user/ai-agents/ai-agents"},{"title":"Connect Claude","href":"/user/ai-agents/connect-claude"},{"title":"Connect ChatGPT","href":"/user/ai-agents/connect-chatgpt"}]},{"group":"Settings","icon":"settings","pages":[{"group":"Store","icon":"store","pages":[{"title":"Store Details","href":"/user/settings/store-details"},{"title":"Emails","href":"/user/settings/emails"},{"title":"Policies","href":"/user/settings/policies"},{"title":"Sales Channels","href":"/user/settings/sales-channels"},{"title":"Custom Fields","href":"/user/settings/custom-fields"},{"title":"Integrations","href":"/user/settings/integrations"}]},{"group":"Selling","icon":"badge-dollar-sign","pages":[{"title":"Markets","href":"/user/settings/markets"},{"title":"Payment Methods","href":"/user/settings/payments"},{"title":"Taxes","href":"/user/settings/taxes"},{"title":"Tax Categories","href":"/user/settings/tax-categories"},{"title":"Tax Rates","href":"/user/settings/tax-rates"}]},{"group":"Shipping \u0026 delivery","icon":"truck","pages":[{"title":"Delivery Profiles","href":"/user/settings/delivery-profiles"},{"title":"Stock Locations","href":"/user/settings/locations"},{"title":"Package Types","href":"/user/settings/package-types"},{"title":"Product Types","href":"/user/settings/product-types"},{"title":"Returns \u0026 Reasons","href":"/user/settings/returns-and-reasons"}]},{"group":"Marketplace","icon":"handshake","pages":[{"title":"Marketplace","href":"/user/settings/marketplace"},{"title":"Seller Requirements","href":"/user/settings/seller-requirements"}]},{"group":"Users \u0026 permissions","icon":"user-cog","pages":[{"title":"Staff","href":"/user/settings/staff"},{"title":"Roles","href":"/user/settings/roles"}]},{"group":"Developer","icon":"code","pages":[{"title":"API Keys","href":"/user/settings/api-keys"},{"title":"Webhooks","href":"/user/settings/webhooks"},{"title":"Allowed Origins","href":"/user/settings/allowed-origins"},{"title":"Imports","href":"/user/settings/imports"}]}]},{"group":"How-to Guides","icon":"compass","pages":[{"title":"Sell to Businesses","href":"/user/how-to/selling-to-businesses"},{"title":"Set Up Multi-Currency Pricing","href":"/user/how-to/multi-currency-pricing"},{"title":"Set Up Multiple Languages","href":"/user/how-to/multiple-languages"},{"title":"Set Up Multi-Region Pricing","href":"/user/how-to/multi-region-pricing"},{"title":"Set Up Volume Pricing","href":"/user/how-to/volume-pricing"},{"title":"Set Up Regional Volume Pricing","href":"/user/how-to/regional-volume"},{"title":"Schedule a Sale","href":"/user/how-to/schedule-sale-pricing"}]},{"group":"Migration","icon":"arrow-right-left","pages":[{"title":"Migrate from Shopify","href":"/user/migration/migrate-from-shopify"}]},{"group":"Security","icon":"shield","pages":[{"title":"Enterprise Edition Security Overview","sidebarTitle":"Enterprise Edition Security Overview","href":"/user/security"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},{"version":"v5.x","pages":[{"title":"v5.x","href":"/v5/user/what-is-spree-commerce"}]}]},"title":"What is Spree Commerce - Spree Commerce documentation","buildId":"dpl_GvhK4qVXq51DpfYJLCtPpYNN4YHN","deploymentId":"dpl_GvhK4qVXq51DpfYJLCtPpYNN4YHN","dynamics":["a74be98ba7"],"chunks":["zoom-image-lightbox-uyuQJRFs.js","lightbox-handle-r17bVUz3.js"]}
