Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
{
"$schema": "https://mintlify.com/docs.json",
"name": "Spree Commerce documentation",
"theme": "almond",
"colors": {
"primary": "#0077ff",
"light": "#4d9fff",
"dark": "#0060ce"
},
"fonts": {
"body": {
"family": "Geist"
},
"heading": {
"family": "Geist"
}
},
"styling": {
"eyebrows": "breadcrumbs",
"codeblocks": {
"theme": "night-owl"
}
},
"favicon": "/favicon.png",
"seo": {
"metatags": {
"og:locale": "en_US",
"twitter:site": "@spreecommerce"
}
},
"icons": {
"library": "lucide"
},
"redirects": [
{
"source": "/user/settings/payouts",
"destination": "/user/settings/marketplace"
},
{
"source": "/user/orders/order-states",
"destination": "/user/orders/orders"
},
{
"source": "/user/orders/order-adjustments",
"destination": "/user/orders/orders"
},
{
"source": "/developer/core-concepts/companies-and-catalogs",
"destination": "/developer/core-concepts/companies"
},
{
"source": "/developer/core-concepts/taxes-discounts-fees",
"destination": "/developer/core-concepts/order-totals"
},
{
"source": "/developer/storefront/images",
"destination": "/developer/core-concepts/media"
},
{
"source": "/developer/core-concepts/images-assets",
"destination": "/developer/core-concepts/media"
},
{
"source": "/developer/admin/permissions",
"destination": "/developer/customization/permissions"
},
{
"source": "/developer/customization/dashboard-plugins",
"destination": "/developer/dashboard/plugins/overview"
},
{
"source": "/developer/customization/event-subscribers",
"destination": "/developer/core-concepts/events"
},
{
"source": "/developer/customization/webhooks",
"destination": "/developer/core-concepts/webhooks"
},
{
"source": "/developer/core-concepts/i18n",
"destination": "/developer/core-concepts/translations"
},
{
"source": "/developer/customization/promotions",
"destination": "/developer/how-to/custom-promotion"
},
{
"source": "/developer/core-concepts/users",
"destination": "/developer/core-concepts/customers"
},
{
"source": "/developer/extending-spree/promotions",
"destination": "/developer/how-to/custom-promotion"
},
{
"source": "/developer/tutorial/seo",
"destination": "/developer/core-concepts/slugs"
},
{
"source": "/developer/tutorial/storefront",
"destination": "/v5/developer/storefront/rails/storefront"
},
{
"source": "/developer/tutorial/page-builder",
"destination": "/v5/developer/storefront/rails/sections"
},
{
"source": "/developer/storefront/storefront",
"destination": "/v5/developer/storefront/rails/storefront"
},
{
"source": "/developer/storefront/themes",
"destination": "/v5/developer/storefront/rails/themes"
},
{
"source": "/developer/storefront/sections",
"destination": "/v5/developer/storefront/rails/sections"
},
{
"source": "/developer/storefront/blocks",
"destination": "/v5/developer/storefront/rails/blocks"
},
{
"source": "/developer/storefront/pages",
"destination": "/v5/developer/storefront/rails/pages"
},
{
"source": "/developer/storefront/links",
"destination": "/v5/developer/storefront/rails/links"
},
{
"source": "/developer/storefront/helper-methods",
"destination": "/v5/developer/storefront/rails/helper-methods"
},
{
"source": "/developer/storefront/custom-css",
"destination": "/v5/developer/storefront/rails/custom-css"
},
{
"source": "/developer/storefront/custom-javascript",
"destination": "/v5/developer/storefront/rails/custom-javascript"
},
{
"source": "/api-reference/introduction",
"destination": "/api-reference/store-api/introduction"
},
{
"source": "/developer/tutorial/rich-text",
"destination": "/developer/tutorial/model-and-api"
},
{
"source": "/developer/tutorial/file-uploads",
"destination": "/v5/developer/tutorial/admin"
},
{
"source": "/developer/tutorial/store-api",
"destination": "/developer/tutorial/model-and-api"
},
{
"source": "/developer/multi-store/quickstart",
"destination": "/developer/multi-tenant/quickstart"
},
{
"source": "/developer/multi-store/setup",
"destination": "/developer/multi-tenant/quickstart"
},
{
"source": "/developer/multi-tenant/installation",
"destination": "/developer/multi-tenant/quickstart"
},
{
"source": "/developer/storefront/rails/blocks",
"destination": "/v5/developer/storefront/rails/blocks"
},
{
"source": "/developer/storefront/rails/custom-css",
"destination": "/v5/developer/storefront/rails/custom-css"
},
{
"source": "/developer/storefront/rails/custom-javascript",
"destination": "/v5/developer/storefront/rails/custom-javascript"
},
{
"source": "/developer/storefront/rails/helper-methods",
"destination": "/v5/developer/storefront/rails/helper-methods"
},
{
"source": "/developer/storefront/rails/links",
"destination": "/v5/developer/storefront/rails/links"
},
{
"source": "/developer/storefront/rails/pages",
"destination": "/v5/developer/storefront/rails/pages"
},
{
"source": "/developer/storefront/rails/sections",
"destination": "/v5/developer/storefront/rails/sections"
},
{
"source": "/developer/storefront/rails/storefront",
"destination": "/v5/developer/storefront/rails/storefront"
},
{
"source": "/developer/storefront/rails/themes",
"destination": "/v5/developer/storefront/rails/themes"
},
{
"source": "/developer/admin/admin",
"destination": "/v5/developer/admin/admin"
},
{
"source": "/developer/admin/authentication",
"destination": "/v5/developer/admin/authentication"
},
{
"source": "/developer/admin/components",
"destination": "/v5/developer/admin/components"
},
{
"source": "/developer/admin/custom-css",
"destination": "/v5/developer/admin/custom-css"
},
{
"source": "/developer/admin/custom-javascript",
"destination": "/v5/developer/admin/custom-javascript"
},
{
"source": "/developer/admin/extending-ui",
"destination": "/v5/developer/admin/extending-ui"
},
{
"source": "/developer/admin/form-builder",
"destination": "/v5/developer/admin/form-builder"
},
{
"source": "/developer/admin/helper-methods",
"destination": "/v5/developer/admin/helper-methods"
},
{
"source": "/developer/admin/navigation",
"destination": "/v5/developer/admin/navigation"
},
{
"source": "/developer/admin/tables",
"destination": "/v5/developer/admin/tables"
},
{
"source": "/developer/tutorial/admin",
"destination": "/v5/developer/tutorial/admin"
},
{
"source": "/developer/tutorial/api",
"destination": "/developer/tutorial/model-and-api"
},
{
"source": "/developer/tutorial/sdk",
"destination": "/developer/tutorial/storefront"
},
{
"source": "/developer/tutorial/extending-models",
"destination": "/v5/developer/tutorial/extending-models"
},
{
"source": "/developer/upgrades/2.0-to-2.1",
"destination": "/v5/developer/upgrades/2.0-to-2.1"
},
{
"source": "/developer/upgrades/2.1-to-2.2",
"destination": "/v5/developer/upgrades/2.1-to-2.2"
},
{
"source": "/developer/upgrades/2.2-to-2.3",
"destination": "/v5/developer/upgrades/2.2-to-2.3"
},
{
"source": "/developer/upgrades/2.3-to-2.4",
"destination": "/v5/developer/upgrades/2.3-to-2.4"
},
{
"source": "/developer/upgrades/3.0-to-3.1",
"destination": "/v5/developer/upgrades/3.0-to-3.1"
},
{
"source": "/developer/upgrades/3.1-to-3.2",
"destination": "/v5/developer/upgrades/3.1-to-3.2"
},
{
"source": "/developer/upgrades/3.2-to-3.3",
"destination": "/v5/developer/upgrades/3.2-to-3.3"
},
{
"source": "/developer/upgrades/3.3-to-3.4",
"destination": "/v5/developer/upgrades/3.3-to-3.4"
},
{
"source": "/developer/upgrades/3.4-to-3.5",
"destination": "/v5/developer/upgrades/3.4-to-3.5"
},
{
"source": "/developer/upgrades/3.5-to-3.6",
"destination": "/v5/developer/upgrades/3.5-to-3.6"
},
{
"source": "/developer/upgrades/3.6-to-3.7",
"destination": "/v5/developer/upgrades/3.6-to-3.7"
},
{
"source": "/developer/upgrades/3.7-to-4.0",
"destination": "/v5/developer/upgrades/3.7-to-4.0"
},
{
"source": "/developer/upgrades/4.0-to-4.1",
"destination": "/v5/developer/upgrades/4.0-to-4.1"
},
{
"source": "/developer/upgrades/4.1-to-4.2",
"destination": "/v5/developer/upgrades/4.1-to-4.2"
},
{
"source": "/developer/upgrades/4.2-to-4.3",
"destination": "/v5/developer/upgrades/4.2-to-4.3"
},
{
"source": "/developer/upgrades/4.3-to-4.4",
"destination": "/v5/developer/upgrades/4.3-to-4.4"
},
{
"source": "/developer/upgrades/4.4-to-4.5",
"destination": "/v5/developer/upgrades/4.4-to-4.5"
},
{
"source": "/developer/upgrades/4.5-to-4.6",
"destination": "/v5/developer/upgrades/4.5-to-4.6"
},
{
"source": "/developer/upgrades/4.6-to-4.7",
"destination": "/v5/developer/upgrades/4.6-to-4.7"
},
{
"source": "/developer/upgrades/4.x-to-4.8",
"destination": "/v5/developer/upgrades/4.x-to-4.8"
},
{
"source": "/developer/upgrades/4.8-to-4.9",
"destination": "/v5/developer/upgrades/4.8-to-4.9"
},
{
"source": "/developer/upgrades/4.9-to-4.10",
"destination": "/v5/developer/upgrades/4.9-to-4.10"
},
{
"source": "/developer/upgrades/4.10-to-5.0",
"destination": "/v5/developer/upgrades/4.10-to-5.0"
},
{
"source": "/developer/upgrades/5.0-to-5.1",
"destination": "/v5/developer/upgrades/5.0-to-5.1"
},
{
"source": "/developer/upgrades/5.1-to-5.2",
"destination": "/v5/developer/upgrades/5.1-to-5.2"
},
{
"source": "/developer/upgrades/5.2-to-5.3",
"destination": "/v5/developer/upgrades/5.2-to-5.3"
},
{
"source": "/developer/upgrades/5.3-to-5.4",
"destination": "/v5/developer/upgrades/5.3-to-5.4"
},
{
"source": "/developer/upgrades/5.4-to-5.5",
"destination": "/v5/developer/upgrades/5.4-to-5.5"
},
{
"source": "/developer/upgrades/5.5-to-5.6",
"destination": "/v5/developer/upgrades/5.5-to-5.6"
},
{
"source": "/developer/customization/authentication",
"destination": "/v5/developer/customization/authentication"
},
{
"source": "/developer/customization/routes",
"destination": "/v5/developer/customization/routes"
},
{
"source": "/developer/core-concepts/adjustments",
"destination": "/developer/core-concepts/fees"
},
{
"source": "/developer/core-concepts/shipments",
"destination": "/developer/core-concepts/fulfillments"
},
{
"source": "/developer/core-concepts/reports",
"destination": "/developer/core-concepts/reporting"
},
{
"source": "/developer/how-to/custom-report",
"destination": "/developer/how-to/extend-reporting"
},
{
"source": "/developer/multi-vendor/quickstart",
"destination": "/developer/how-to/build-a-marketplace"
},
{
"source": "/developer/multi-vendor/installation",
"destination": "/developer/how-to/build-a-marketplace"
},
{
"source": "/developer/advanced/adding_spree_to_rails_app",
"destination": "/v5/developer/advanced/adding_spree_to_rails_app"
},
{
"source": "/user/settings/checkout",
"destination": "/v5/user/settings/checkout"
},
{
"source": "/user/manage-products/product-properties",
"destination": "/v5/user/manage-products/product-properties"
},
{
"source": "/developer/deployment/telemetry",
"destination": "/developer/providers/observability"
},
{
"source": "/developer/multi-vendor",
"destination": "/developer/how-to/build-a-marketplace"
},
{
"source": "/user/promotions/gift-cards",
"destination": "/user/loyalty/gift-cards"
},
{
"source": "/user/loyalty/issue-gift-card",
"destination": "/user/loyalty/gift-cards"
},
{
"source": "/user/customers/issue-gift-card",
"destination": "/user/loyalty/gift-cards"
},
{
"source": "/user/customers/assign-store-credits",
"destination": "/user/loyalty/store-credits"
},
{
"source": "/user/customers/create-customer",
"destination": "/user/customers/customers"
},
{
"source": "/user/customers/searching-customers",
"destination": "/user/customers/customers"
},
{
"source": "/user/customers/exporting-customers",
"destination": "/user/customers/customers"
},
{
"source": "/user/customers/edit-customer",
"destination": "/user/customers/customer-profile"
},
{
"source": "/user/loyalty/store-credits-list",
"destination": "/user/loyalty/store-credits"
},
{
"source": "/user/manage-products/stock-levels",
"destination": "/user/inventory/stock-levels"
},
{
"source": "/user/manage-products/stock-transfers",
"destination": "/user/inventory/stock-transfers"
},
{
"source": "/user/manage-products/price-lists",
"destination": "/user/pricing/price-lists"
},
{
"source": "/user/manage-products/translations",
"destination": "/user/translations/translations"
},
{
"source": "/user/manage-products/product-taxonomies",
"destination": "/user/products/categories"
},
{
"source": "/user/returns/returns-processing",
"destination": "/user/orders/returns"
},
{
"source": "/user/vendors/vendor-management",
"destination": "/user/sellers/sellers"
},
{
"source": "/user/vendors/vendor-onboarding-manual",
"destination": "/user/sellers/onboarding"
},
{
"source": "/user/vendors/vendor-onboarding-shopify",
"destination": "/user/sellers/onboarding"
},
{
"source": "/user/vendors/vendor-onboarding-woocommerce",
"destination": "/user/sellers/onboarding"
},
{
"source": "/user/vendors/commission-rates",
"destination": "/user/sellers/commission-rates"
},
{
"source": "/user/vendors/vendor-payouts",
"destination": "/user/sellers/payouts"
},
{
"source": "/user/vendors/multi-vendor-checkout",
"destination": "/user/sellers/orders"
},
{
"source": "/use-case/b2b/b2b-admin-capabilities",
"destination": "/user/how-to/selling-to-businesses"
},
{
"source": "/use-case/b2b/b2b-buyer-capabilities",
"destination": "/user/how-to/selling-to-businesses"
},
{
"source": "/use-case/b2b/b2b-capabilities",
"destination": "/user/how-to/selling-to-businesses"
},
{
"source": "/use-case/b2b/b2b-commerce-model",
"destination": "/user/how-to/selling-to-businesses"
},
{
"source": "/use-case/digital-products/admin-capabilities",
"destination": "/developer/how-to/sell-digital-products"
},
{
"source": "/use-case/digital-products/capabilities",
"destination": "/developer/how-to/sell-digital-products"
},
{
"source": "/use-case/digital-products/model",
"destination": "/developer/how-to/sell-digital-products"
},
{
"source": "/use-case/marketplace/admin-dashboard",
"destination": "/user/sellers/sellers"
},
{
"source": "/use-case/marketplace/capabilities",
"destination": "/developer/how-to/build-a-marketplace"
},
{
"source": "/use-case/marketplace/customer-ux",
"destination": "/developer/how-to/build-a-marketplace"
},
{
"source": "/use-case/marketplace/model",
"destination": "/developer/how-to/build-a-marketplace"
},
{
"source": "/use-case/marketplace/vendor-dashboard",
"destination": "/user/sellers/sellers"
},
{
"source": "/use-case/multi-tenant/franchises-and-reseller-networks",
"destination": "/developer/multi-tenant/quickstart"
},
{
"source": "/use-case/multi-tenant/multi-brand-enterprise-model",
"destination": "/developer/multi-tenant/quickstart"
},
{
"source": "/use-case/multi-tenant/multi-tenant-capabilities",
"destination": "/developer/multi-tenant/quickstart"
},
{
"source": "/use-case/multi-tenant/multi-tenant-model",
"destination": "/developer/multi-tenant/quickstart"
},
{
"source": "/use-case/multi-tenant/super-admin-capabilities",
"destination": "/developer/multi-tenant/quickstart"
},
{
"source": "/use-case/multi-tenant/tenant-capabilities",
"destination": "/developer/multi-tenant/quickstart"
},
{
"source": "/use-case/multi-tenant/white-label-saas",
"destination": "/developer/multi-tenant/quickstart"
},
{
"source": "/use-case/overview",
"destination": "/"
},
{
"source": "/developer/tutorial/dashboard-plugin",
"destination": "/developer/tutorial/dashboard"
},
{
"source": "/user/settings/users",
"destination": "/user/settings/staff"
},
{
"source": "/user/settings/tax",
"destination": "/user/settings/taxes"
},
{
"source": "/user/settings/returns-configuration",
"destination": "/user/settings/returns-and-reasons"
},
{
"source": "/user/settings/metafields",
"destination": "/user/settings/custom-fields"
},
{
"source": "/user/settings/shipping-methods",
"destination": "/user/settings/delivery-profiles"
},
{
"source": "/user/settings/zones",
"destination": "/user/settings/delivery-profiles"
},
{
"source": "/user/manage-products/product-metafields",
"destination": "/user/products/custom-product-fields"
},
{
"source": "/user/manage-products/search-products",
"destination": "/user/products/products"
},
{
"source": "/user/manage-products/bulk-product-operations",
"destination": "/user/products/products"
},
{
"source": "/user/products/creating-products",
"destination": "/user/products/adding-products"
},
{
"source": "/user/products/editing-products",
"destination": "/user/products/adding-products"
},
{
"source": "/user/products/cloning-products",
"destination": "/user/products/adding-products"
},
{
"source": "/user/products/deleting-products",
"destination": "/user/products/adding-products"
},
{
"source": "/user/products/editing-multi-variant-products",
"destination": "/user/products/variants"
},
{
"source": "/user/manage-products/import-products",
"destination": "/user/products/import-and-export"
},
{
"source": "/user/manage-products/export-products",
"destination": "/user/products/import-and-export"
},
{
"source": "/user/manage-products/multi-currency-import-export",
"destination": "/user/products/import-and-export"
},
{
"source": "/user/manage-products/product-options",
"destination": "/user/products/options"
},
{
"source": "/user/manage-products/product-import-file-template",
"destination": "/user/products/import-template"
},
{
"source": "/user/manage-products/custom-product-fields",
"destination": "/user/products/custom-product-fields"
},
{
"source": "/user/orders/order-statuses",
"destination": "/user/orders/orders"
},
{
"source": "/user/orders/exporting-orders",
"destination": "/user/orders/orders"
},
{
"source": "/user/orders/searching-orders",
"destination": "/user/orders/orders"
},
{
"source": "/user/orders/discounts-fees-and-taxes",
"destination": "/user/orders/orders"
},
{
"source": "/user/orders/editing-orders",
"destination": "/user/orders/processing-orders"
},
{
"source": "/user/orders/cancelling-orders",
"destination": "/user/orders/processing-orders"
},
{
"source": "/user/orders/refunding-orders",
"destination": "/user/orders/processing-orders"
},
{
"source": "/user/orders/creating-orders",
"destination": "/user/orders/draft-orders"
},
{
"source": "/developer/agentic/admin-mcp",
"destination": "/developer/mcp/overview"
},
{
"source": "/developer/agentic/mcp",
"destination": "/developer/agentic/docs-mcp"
},
{
"source": "/user/sellers/managing-sellers",
"destination": "/user/sellers/sellers"
}
],
"contextual": {
"options": [
"copy",
"view",
"chatgpt",
"claude",
"mcp",
"cursor",
"vscode"
]
},
"navigation": {
"versions": [
{
"version": "v6.x",
"default": true,
"tabs": [
{
"tab": "Documentation",
"groups": [
{
"group": "Develop",
"pages": [
"index",
{
"group": "Getting Started",
"pages": [
"developer/getting-started/quickstart",
"developer/core-concepts/architecture"
],
"icon": "rocket"
},
{
"group": "Core Concepts",
"pages": [
{
"group": "Platform",
"pages": [
"developer/core-concepts/stores",
"developer/core-concepts/channels",
"developer/core-concepts/markets",
"developer/core-concepts/customers",
"developer/core-concepts/data-privacy",
"developer/core-concepts/companies",
"developer/core-concepts/sellers",
"developer/core-concepts/staff-roles"
]
},
{
"group": "Catalog",
"pages": [
"developer/core-concepts/products",
"developer/core-concepts/pricing",
"developer/core-concepts/catalogs",
"developer/core-concepts/inventory",
"developer/core-concepts/media",
"developer/core-concepts/search-filtering"
]
},
{
"group": "Cart & Checkout",
"pages": [
"developer/core-concepts/carts",
"developer/core-concepts/orders",
"developer/core-concepts/order-totals",
"developer/core-concepts/payments",
"developer/core-concepts/taxes",
"developer/core-concepts/discounts",
"developer/core-concepts/fees",
"developer/core-concepts/commissions",
"developer/core-concepts/promotions",
"developer/core-concepts/store-credits-gift-cards"
]
},
{
"group": "Fulfillment",
"pages": [
"developer/core-concepts/fulfillments",
"developer/core-concepts/delivery-setup",
"developer/core-concepts/freight",
"developer/core-concepts/returns-exchanges-claims",
"developer/core-concepts/addresses",
"developer/core-concepts/calculators"
]
},
{
"group": "Extensibility",
"pages": [
"developer/core-concepts/events",
"developer/core-concepts/webhooks",
"developer/core-concepts/translations",
"developer/core-concepts/slugs",
"developer/core-concepts/metafields",
"developer/core-concepts/external-references",
"developer/core-concepts/imports-exports",
"developer/core-concepts/reporting"
]
}
],
"icon": "book-open"
},
{
"group": "Agentic Development",
"pages": [
"developer/agentic/overview",
"developer/agentic/agent-skills",
"developer/agentic/docs-mcp",
"developer/agentic/llm-docs",
"developer/cli/admin-api"
],
"icon": "sparkles"
},
{
"group": "MCP Server",
"pages": [
"developer/mcp/overview",
"developer/mcp/quick-start",
"developer/mcp/tools",
"developer/mcp/permissions",
"developer/mcp/custom-tools"
],
"icon": "plug"
},
{
"group": "Tutorial",
"pages": [
"developer/tutorial/introduction",
"developer/tutorial/model-and-api",
"developer/tutorial/dashboard",
"developer/tutorial/storefront",
"developer/tutorial/events",
"developer/tutorial/testing"
],
"icon": "graduation-cap"
},
{
"group": "Admin Dashboard",
"pages": [
"developer/dashboard/overview",
"developer/dashboard/concepts",
{
"group": "Customization",
"pages": [
"developer/dashboard/customization/quickstart",
"developer/dashboard/customization/navigation",
"developer/dashboard/customization/routes",
"developer/dashboard/customization/slots",
"developer/dashboard/customization/tables",
"developer/dashboard/customization/translations",
"developer/dashboard/customization/theming",
"developer/dashboard/customization/permissions",
"developer/dashboard/customization/backend"
]
},
{
"group": "Recipes",
"pages": [
"developer/dashboard/recipes/attribute-end-to-end",
"developer/dashboard/recipes/custom-form-field",
"developer/dashboard/recipes/page-action-button",
"developer/dashboard/recipes/sidebar-widget"
]
},
{
"group": "Plugins",
"pages": [
"developer/dashboard/plugins/overview",
"developer/dashboard/plugins/scaffolding",
"developer/dashboard/plugins/publishing",
"developer/dashboard/plugins/distributing"
]
},
{
"group": "Admin SDK",
"pages": [
"developer/sdk/admin/quickstart",
"developer/sdk/admin/authentication",
"developer/sdk/admin/resources",
"developer/sdk/admin/querying-and-errors",
"developer/sdk/admin/extending"
]
},
{
"group": "Reference",
"pages": [
"developer/dashboard/public-api",
"developer/dashboard/slots-catalog",
"developer/dashboard/deployment"
]
}
],
"icon": "layout-dashboard"
},
{
"group": "Building a Storefront",
"pages": [
{
"group": "Store SDK",
"pages": [
"developer/sdk/quickstart",
"developer/sdk/authentication",
"developer/sdk/configuration",
"developer/sdk/extending"
]
},
{
"group": "Working with the Store API",
"pages": [
"developer/sdk/store/products",
"developer/sdk/store/cart-checkout",
"developer/sdk/store/payments",
"developer/sdk/store/markets",
"developer/sdk/store/account",
"developer/sdk/store/wishlists"
]
},
{
"group": "Next.js Storefront",
"pages": [
"developer/storefront/nextjs/quickstart",
"developer/storefront/nextjs/architecture",
"developer/storefront/nextjs/multi-region",
"developer/storefront/nextjs/customization",
"developer/storefront/nextjs/emails",
"developer/storefront/nextjs/wholesale",
"developer/storefront/nextjs/wallet-payments",
"developer/storefront/nextjs/testing",
"developer/storefront/nextjs/environment-variables",
"developer/storefront/nextjs/deployment"
]
}
],
"icon": "store"
},
{
"group": "Providers & Integrations",
"pages": [
"developer/providers/overview",
"integrations/integrations",
{
"group": "Connect Your Systems",
"pages": [
"developer/providers/erp",
"developer/providers/pim",
"developer/providers/dam"
]
},
{
"group": "Shipping & WMS",
"pages": [
"developer/providers/fulfillment",
"integrations/shipping/easypost",
"developer/how-to/custom-delivery-rate-provider"
]
},
{
"group": "Payments",
"pages": [
"developer/how-to/custom-payment-method",
"integrations/payments/stripe",
"integrations/payments/adyen",
"integrations/payments/paypal",
"integrations/payments/razorpay"
]
},
{
"group": "Marketplace",
"pages": [
"developer/providers/payouts",
"integrations/payments/stripe-connect"
]
},
{
"group": "Tax",
"pages": [
"integrations/tax/avalara"
]
},
{
"group": "Search",
"pages": [
"developer/how-to/custom-search-provider",
"integrations/search/meilisearch"
]
},
{
"group": "Identity & SSO",
"pages": [
"developer/providers/sso",
"developer/how-to/custom-api-authentication"
]
},
{
"group": "Observability",
"pages": [
"developer/providers/observability"
]
},
{
"group": "Marketing & Analytics",
"pages": [
"integrations/analytics/google-analytics",
"integrations/analytics/google-tag-manager",
"integrations/marketing/klaviyo"
]
},
{
"group": "Emails",
"pages": [
"developer/providers/emails",
"integrations/email/resend",
"integrations/email/postmark",
"integrations/email/sendgrid",
"integrations/email/mailgun",
"integrations/email/amazon-ses"
]
}
],
"icon": "plug"
},
{
"group": "Extending the Backend",
"pages": [
"developer/customization/quickstart",
"developer/customization/configuration",
"developer/customization/workflows",
"developer/customization/validations",
"developer/customization/checkout",
"developer/customization/dependencies",
"developer/customization/api",
"developer/customization/model-preferences",
"developer/customization/metadata",
"developer/customization/permissions",
"developer/customization/decorators",
"developer/customization/emails",
"developer/customization/email-variables"
],
"icon": "code"
},
{
"group": "Guides",
"pages": [
"developer/how-to/build-a-marketplace",
"developer/how-to/build-a-b2b-store",
"developer/how-to/sell-digital-products",
"developer/how-to/custom-digital-asset-provider",
{
"group": "Multi-Tenant Platform",
"pages": [
"developer/multi-tenant/quickstart",
"developer/multi-tenant/core-concepts",
"developer/multi-tenant/configuration"
]
},
"developer/how-to/custom-promotion",
"developer/how-to/extend-reporting",
"developer/how-to/custom-document-numbers",
"developer/how-to/custom-order-routing",
"developer/how-to/custom-stock-splitter",
"developer/how-to/maintenance-tasks"
],
"icon": "compass"
},
{
"group": "Deployment",
"pages": [
"developer/deployment/quickstart",
"developer/deployment/docker",
"developer/deployment/environment_variables",
{
"group": "AWS",
"pages": [
"developer/deployment/aws",
"developer/deployment/aws_ecs"
]
},
"developer/deployment/render",
"developer/deployment/assets",
"developer/deployment/emails",
"developer/deployment/cdn",
"developer/deployment/background_jobs",
"developer/deployment/caching",
"developer/deployment/database",
"developer/deployment/usage-data"
],
"icon": "server"
},
{
"group": "Operations",
"pages": [
"developer/create-spree-app/quickstart",
"developer/cli/quickstart",
{
"group": "Upgrading",
"pages": [
"developer/upgrades/quickstart",
"developer/upgrades/5.6-to-6.0",
"v5/developer/upgrades/5.5-to-5.6",
"v5/developer/upgrades/5.4-to-5.5",
"v5/developer/upgrades/5.3-to-5.4",
"v5/developer/upgrades/5.2-to-5.3",
"v5/developer/upgrades/5.1-to-5.2",
"v5/developer/upgrades/5.0-to-5.1"
]
},
{
"group": "Contributing",
"pages": [
"developer/contributing/quickstart",
"developer/contributing/developing-spree",
"developer/contributing/creating-an-extension"
]
},
{
"group": "Security",
"pages": [
"developer/security/security_policy",
"developer/security/pci_compliance"
]
}
],
"icon": "settings"
}
]
}
]
},
{
"tab": "API Reference",
"menu": [
{
"item": "Store API",
"icon": "store",
"description": "REST API for storefronts and custom integrations",
"groups": [
{
"group": "API basics",
"pages": [
"api-reference/store-api/introduction",
"api-reference/store-api/authentication",
"api-reference/store-api/errors",
"api-reference/store-api/idempotency",
"api-reference/store-api/rate-limitting",
"api-reference/store-api/querying",
"api-reference/store-api/relations",
"api-reference/store-api/metadata",
"api-reference/store-api/localization",
"api-reference/store-api/monetary-amounts",
"api-reference/store-api/migrating-from-storefront-api-v2"
]
},
{
"group": "Endpoints",
"openapi": {
"source": "api-reference/store.yaml",
"directory": "api-reference/store-api"
}
}
]
},
{
"item": "Admin API",
"icon": "shield",
"description": "REST API for pragmatically managing stores",
"groups": [
{
"group": "API basics",
"pages": [
"api-reference/admin-api/introduction",
"api-reference/admin-api/authentication",
"api-reference/admin-api/errors",
"api-reference/admin-api/querying",
"api-reference/admin-api/monetary-amounts",
"api-reference/admin-api/uploads",
"api-reference/admin-api/endpoints"
]
},
{
"group": "Endpoints",
"openapi": {
"source": "api-reference/admin.yaml",
"directory": "api-reference/admin-api"
}
}
]
},
{
"item": "Seller API",
"icon": "handshake",
"description": "REST API for the marketplace seller panel",
"groups": [
{
"group": "API basics",
"pages": [
"api-reference/seller-api/introduction",
"api-reference/seller-api/authentication",
"api-reference/seller-api/errors"
]
},
{
"group": "Endpoints",
"openapi": {
"source": "api-reference/seller.yaml",
"directory": "api-reference/seller-api"
}
}
]
},
{
"item": "Webhooks",
"icon": "webhook",
"description": "Event payloads and delivery reference",
"groups": [
{
"group": "Webhooks",
"pages": [
"api-reference/webhooks-events"
]
}
]
}
]
},
{
"tab": "User Guide",
"groups": [
{
"group": "Manage",
"pages": [
{
"group": "Introduction",
"icon": "book-open",
"pages": [
"user/what-is-spree-commerce",
"user/using-spree",
"user/user-quickstart-guide"
]
},
{
"group": "Products",
"icon": "package",
"pages": [
"user/products/products",
"user/products/adding-products",
"user/products/variants",
"user/products/options",
"user/products/media",
"user/products/categories",
"user/products/collections",
"user/products/custom-product-fields",
"user/products/import-and-export",
"user/products/import-template"
]
},
{
"group": "Inventory",
"icon": "warehouse",
"pages": [
"user/inventory/stock-levels",
"user/inventory/stock-transfers",
"user/inventory/purchase-orders",
"user/inventory/suppliers"
]
},
{
"group": "Pricing",
"icon": "tag",
"pages": [
"user/pricing/price-lists"
]
},
{
"group": "Catalogs",
"icon": "book-marked",
"pages": [
"user/catalogs/catalogs"
]
},
{
"group": "Translations",
"icon": "languages",
"pages": [
"user/translations/translations"
]
},
{
"group": "Orders",
"pages": [
"user/orders/orders",
"user/orders/processing-orders",
"user/orders/draft-orders",
"user/orders/returns",
"user/orders/exchanges",
"user/orders/claims"
],
"icon": "shopping-cart"
},
{
"group": "Customers",
"pages": [
"user/customers/customers",
"user/customers/customer-profile",
"user/customers/customer-groups",
"user/customers/companies"
],
"icon": "users"
},
{
"group": "Sellers",
"icon": "store",
"pages": [
"user/sellers/sellers",
"user/sellers/onboarding",
"user/sellers/seller-panel",
"user/sellers/products",
"user/sellers/orders",
"user/sellers/commission-rates",
"user/sellers/transfers",
"user/sellers/payouts"
]
},
{
"group": "Loyalty",
"pages": [
"user/loyalty/gift-cards",
"user/loyalty/store-credits"
],
"icon": "gift"
},
{
"group": "Promotions",
"pages": [
"user/promotions/create-a-promotion",
"user/promotions/promotion-rules",
"user/promotions/promotion-actions"
],
"icon": "ticket-percent"
},
{
"group": "Reports",
"icon": "chart-column",
"pages": [
"user/reports/reports"
]
},
{
"group": "AI Agents",
"icon": "bot",
"pages": [
"user/ai-agents/ai-agents",
"user/ai-agents/connect-claude",
"user/ai-agents/connect-chatgpt"
]
},
{
"group": "Settings",
"icon": "settings",
"pages": [
{
"group": "Store",
"icon": "store",
"pages": [
"user/settings/store-details",
"user/settings/emails",
"user/settings/policies",
"user/settings/sales-channels",
"user/settings/custom-fields",
"user/settings/integrations"
]
},
{
"group": "Selling",
"icon": "badge-dollar-sign",
"pages": [
"user/settings/markets",
"user/settings/payments",
"user/settings/taxes",
"user/settings/tax-categories",
"user/settings/tax-rates"
]
},
{
"group": "Shipping & delivery",
"icon": "truck",
"pages": [
"user/settings/delivery-profiles",
"user/settings/locations",
"user/settings/package-types",
"user/settings/product-types",
"user/settings/returns-and-reasons"
]
},
{
"group": "Marketplace",
"icon": "handshake",
"pages": [
"user/settings/marketplace",
"user/settings/seller-requirements"
]
},
{
"group": "Users & permissions",
"icon": "user-cog",
"pages": [
"user/settings/staff",
"user/settings/roles"
]
},
{
"group": "Developer",
"icon": "code",
"pages": [
"user/settings/api-keys",
"user/settings/webhooks",
"user/settings/allowed-origins",
"user/settings/imports"
]
}
]
},
{
"group": "How-to Guides",
"pages": [
"user/how-to/selling-to-businesses",
"user/how-to/multi-currency-pricing",
"user/how-to/multiple-languages",
"user/how-to/multi-region-pricing",
"user/how-to/volume-pricing",
"user/how-to/regional-volume",
"user/how-to/schedule-sale-pricing"
],
"icon": "compass"
},
{
"group": "Migration",
"pages": [
"user/migration/migrate-from-shopify"
],
"icon": "arrow-right-left"
},
{
"group": "Security",
"pages": [
"user/security"
],
"icon": "shield"
}
]
}
]
},
{
"tab": "Changelog",
"pages": [
"changelog"
]
}
]
},
{
"version": "v5.x",
"tabs": [
{
"tab": "Guides",
"menu": [
{
"item": "Getting Started",
"icon": "rocket",
"description": "Quickstart guide and core concepts",
"groups": [
{
"group": "Getting started",
"icon": "rocket",
"pages": [
"v5/developer/getting-started/quickstart"
]
},
{
"group": "Platform",
"icon": "settings",
"pages": [
"v5/developer/core-concepts/architecture",
"v5/developer/core-concepts/stores",
"v5/developer/core-concepts/channels",
"v5/developer/core-concepts/markets",
"v5/developer/core-concepts/customers",
"v5/developer/core-concepts/staff-roles"
]
},
{
"group": "Catalog",
"icon": "package",
"pages": [
"v5/developer/core-concepts/products",
"v5/developer/core-concepts/pricing",
"v5/developer/core-concepts/inventory",
"v5/developer/core-concepts/media",
"v5/developer/core-concepts/search-filtering"
]
},
{
"group": "Cart & Checkout",
"icon": "shopping-cart",
"pages": [
"v5/developer/core-concepts/orders",
"v5/developer/core-concepts/payments",
"v5/developer/core-concepts/taxes",
"v5/developer/core-concepts/promotions",
"v5/developer/core-concepts/store-credits-gift-cards"
]
},
{
"group": "Fulfillment",
"icon": "truck",
"pages": [
"v5/developer/core-concepts/shipments",
"v5/developer/core-concepts/addresses",
"v5/developer/core-concepts/adjustments",
"v5/developer/core-concepts/calculators"
]
},
{
"group": "Extensibility",
"icon": "plug",
"pages": [
"v5/developer/core-concepts/events",
"v5/developer/core-concepts/webhooks",
"v5/developer/core-concepts/translations",
"v5/developer/core-concepts/slugs",
"v5/developer/core-concepts/metafields",
"v5/developer/core-concepts/reports",
"v5/developer/core-concepts/imports-exports"
]
}
]
},
{
"item": "Building a Storefront",
"icon": "store",
"description": "Next.js, custom frontend, or Rails engine",
"groups": [
{
"group": "Next.js Storefront",
"pages": [
"v5/developer/storefront/nextjs/quickstart",
"v5/developer/storefront/nextjs/architecture",
"v5/developer/storefront/nextjs/multi-region",
"v5/developer/storefront/nextjs/customization",
"v5/developer/storefront/nextjs/emails",
"v5/developer/storefront/nextjs/wholesale",
"v5/developer/storefront/nextjs/wallet-payments",
"v5/developer/storefront/nextjs/testing",
"v5/developer/storefront/nextjs/environment-variables",
"v5/developer/storefront/nextjs/deployment"
]
}
]
},
{
"item": "Use Cases",
"icon": "book-open",
"description": "Multi-store/multi-tenant, and marketplace setups",
"groups": [
{
"group": "Multi-Tenant / Multi-Store",
"pages": [
"v5/developer/multi-tenant/quickstart",
"v5/developer/multi-tenant/core-concepts",
"v5/developer/multi-tenant/configuration"
]
},
{
"group": "Multi-Vendor Marketplace",
"pages": [
"v5/developer/multi-vendor/quickstart",
"v5/developer/multi-vendor/installation"
]
}
]
}
]
},
{
"tab": "Framework",
"menu": [
{
"item": "Extending",
"icon": "puzzle",
"description": "Customize admin panel, API, and business logic",
"groups": [
{
"group": "Tutorial",
"icon": "graduation-cap",
"pages": [
"v5/developer/tutorial/introduction",
"v5/developer/tutorial/model",
"v5/developer/tutorial/admin",
"v5/developer/tutorial/extending-models",
"v5/developer/tutorial/api",
"v5/developer/tutorial/events",
"v5/developer/tutorial/sdk",
"v5/developer/tutorial/testing"
]
},
{
"group": "Admin Panel",
"icon": "gauge",
"pages": [
"v5/developer/admin/admin",
"v5/developer/admin/extending-ui",
"v5/developer/admin/navigation",
"v5/developer/admin/tables",
"v5/developer/admin/form-builder",
"v5/developer/admin/components",
"v5/developer/admin/helper-methods",
"v5/developer/admin/authentication",
"v5/developer/admin/custom-javascript",
"v5/developer/admin/custom-css"
]
},
{
"group": "Customization Reference",
"icon": "wrench",
"pages": [
"v5/developer/customization/quickstart",
"v5/developer/customization/configuration",
"v5/developer/customization/authentication",
"v5/developer/customization/checkout",
"v5/developer/customization/permissions",
"v5/developer/customization/workflows",
"v5/developer/customization/dependencies",
"v5/developer/customization/decorators",
"v5/developer/customization/model-preferences",
"v5/developer/customization/metadata",
"v5/developer/customization/routes",
"v5/developer/customization/api"
]
}
]
},
{
"item": "How-to Guides",
"icon": "book-open",
"description": "Step-by-step guides for common tasks",
"groups": [
{
"group": "Order Routing",
"icon": "route",
"pages": [
"v5/developer/how-to/custom-order-routing"
]
},
{
"group": "Stock Splitters",
"icon": "boxes-stacked",
"pages": [
"v5/developer/how-to/custom-stock-splitter"
]
},
{
"group": "Payments",
"icon": "credit-card",
"pages": [
"v5/developer/how-to/custom-payment-method"
]
},
{
"group": "Promotions",
"icon": "tag",
"pages": [
"v5/developer/how-to/custom-promotion"
]
},
{
"group": "Reports",
"icon": "chart-bar",
"pages": [
"v5/developer/how-to/custom-report"
]
},
{
"group": "Search",
"icon": "search",
"pages": [
"v5/developer/how-to/custom-search-provider"
]
},
{
"group": "Authentication",
"icon": "key",
"pages": [
"v5/developer/how-to/custom-api-authentication"
]
}
]
},
{
"item": "Operations",
"icon": "server",
"description": "Deploy, upgrade, and maintain your store",
"groups": [
{
"group": "Deployment",
"icon": "server",
"pages": [
"v5/developer/deployment/quickstart",
"v5/developer/deployment/docker",
"v5/developer/deployment/environment_variables",
{
"group": "AWS",
"pages": [
"v5/developer/deployment/aws",
"v5/developer/deployment/aws_ecs"
]
},
"v5/developer/deployment/render",
"v5/developer/deployment/assets",
"v5/developer/deployment/emails",
"v5/developer/deployment/cdn",
"v5/developer/deployment/background_jobs",
"v5/developer/deployment/caching",
"v5/developer/deployment/database"
]
},
{
"group": "Upgrading",
"icon": "circle-arrow-up",
"pages": [
"v5/developer/upgrades/quickstart",
{
"group": "Upgrade Guides",
"pages": [
"v5/developer/upgrades/5.5-to-5.6",
"v5/developer/upgrades/5.4-to-5.5",
"v5/developer/upgrades/5.3-to-5.4",
"v5/developer/upgrades/5.2-to-5.3",
"v5/developer/upgrades/5.1-to-5.2",
"v5/developer/upgrades/5.0-to-5.1",
"v5/developer/upgrades/4.10-to-5.0",
"v5/developer/upgrades/4.9-to-4.10",
"v5/developer/upgrades/4.8-to-4.9",
"v5/developer/upgrades/4.x-to-4.8",
"v5/developer/upgrades/4.6-to-4.7",
"v5/developer/upgrades/4.5-to-4.6",
"v5/developer/upgrades/4.4-to-4.5",
"v5/developer/upgrades/4.3-to-4.4",
"v5/developer/upgrades/4.2-to-4.3",
"v5/developer/upgrades/4.1-to-4.2",
"v5/developer/upgrades/4.0-to-4.1",
"v5/developer/upgrades/3.7-to-4.0",
"v5/developer/upgrades/3.6-to-3.7",
"v5/developer/upgrades/3.5-to-3.6",
"v5/developer/upgrades/3.4-to-3.5",
"v5/developer/upgrades/3.3-to-3.4",
"v5/developer/upgrades/3.2-to-3.3",
"v5/developer/upgrades/3.1-to-3.2",
"v5/developer/upgrades/3.0-to-3.1",
"v5/developer/upgrades/2.3-to-2.4",
"v5/developer/upgrades/2.2-to-2.3",
"v5/developer/upgrades/2.1-to-2.2",
"v5/developer/upgrades/2.0-to-2.1"
]
}
]
},
{
"group": "Contributing",
"icon": "heart",
"pages": [
"v5/developer/contributing/quickstart",
"v5/developer/contributing/developing-spree",
"v5/developer/contributing/creating-an-extension"
]
},
{
"group": "Security",
"icon": "shield",
"pages": [
"v5/developer/security/security_policy",
"v5/developer/security/pci_compliance"
]
}
]
}
]
},
{
"tab": "SDK & Tools",
"menu": [
{
"item": "Store SDK",
"icon": "code",
"description": "TypeScript SDK for the Store API",
"groups": [
{
"group": "Getting Started",
"pages": [
"v5/developer/sdk/quickstart",
"v5/developer/sdk/authentication",
"v5/developer/sdk/configuration",
"v5/developer/sdk/extending"
]
},
{
"group": "Store API",
"pages": [
"v5/developer/sdk/store/products",
"v5/developer/sdk/store/cart-checkout",
"v5/developer/sdk/store/payments",
"v5/developer/sdk/store/markets",
"v5/developer/sdk/store/account",
"v5/developer/sdk/store/wishlists"
]
}
]
},
{
"item": "Admin SDK",
"icon": "shield-check",
"description": "TypeScript SDK for the Admin API",
"groups": [
{
"group": "Admin SDK",
"pages": [
"v5/developer/sdk/admin/quickstart",
"v5/developer/sdk/admin/authentication",
"v5/developer/sdk/admin/resources",
"v5/developer/sdk/admin/querying-and-errors",
"v5/developer/sdk/admin/extending"
]
}
]
},
{
"item": "CLI",
"icon": "square-terminal",
"description": "Command-line interface for Spree",
"groups": [
{
"group": "CLI",
"pages": [
"v5/developer/cli/quickstart",
"v5/developer/cli/admin-api"
]
}
]
},
{
"item": "create-spree-app",
"icon": "rocket",
"description": "Scaffold a new Spree project",
"groups": [
{
"group": "create-spree-app",
"pages": [
"v5/developer/create-spree-app/quickstart"
]
}
]
},
{
"item": "Agentic Development",
"icon": "bot",
"description": "Build Spree with AI coding agents",
"groups": [
{
"group": "Agentic Development",
"pages": [
"v5/developer/agentic/overview",
"v5/developer/agentic/agent-skills",
"v5/developer/agentic/docs-mcp",
"v5/developer/agentic/llm-docs"
]
}
]
}
]
},
{
"tab": "API Reference",
"menu": [
{
"item": "Store API",
"icon": "store",
"description": "REST API for storefronts and custom integrations",
"groups": [
{
"group": "API basics",
"pages": [
"api-reference/store-api/introduction",
"api-reference/store-api/authentication",
"api-reference/store-api/errors",
"api-reference/store-api/idempotency",
"api-reference/store-api/rate-limitting",
"api-reference/store-api/querying",
"api-reference/store-api/relations",
"api-reference/store-api/metadata",
"api-reference/store-api/localization",
"api-reference/store-api/monetary-amounts",
"api-reference/store-api/migrating-from-storefront-api-v2"
]
},
{
"group": "Endpoints",
"openapi": {
"source": "api-reference/store.yaml",
"directory": "api-reference/store-api"
}
}
]
},
{
"item": "Admin API",
"icon": "shield",
"description": "REST API for pragmatically managing stores",
"groups": [
{
"group": "API basics",
"pages": [
"api-reference/admin-api/introduction",
"api-reference/admin-api/authentication",
"api-reference/admin-api/errors",
"api-reference/admin-api/querying",
"api-reference/admin-api/monetary-amounts",
"api-reference/admin-api/uploads",
"api-reference/admin-api/endpoints"
]
},
{
"group": "Endpoints",
"openapi": {
"source": "api-reference/admin.yaml",
"directory": "api-reference/admin-api"
}
}
]
},
{
"item": "Webhooks",
"icon": "webhook",
"description": "Event payloads and delivery reference",
"groups": [
{
"group": "Webhooks",
"pages": [
"api-reference/webhooks-events"
]
}
]
},
{
"item": "Legacy API v2",
"icon": "clock",
"description": "Previous-generation Storefront and Platform APIs",
"groups": [
{
"group": "API basics",
"pages": [
"api-reference/v2/introduction",
"api-reference/v2/pagination",
"api-reference/v2/filtering-and-sorting",
"api-reference/v2/fetching-multiple-resources"
]
},
{
"group": "Tutorials",
"pages": [
"api-reference/tutorials/quick-checkout-with-stripe",
"api-reference/tutorials/adyen-integration-guide-for-android",
"api-reference/tutorials/adyen-integration-guide-for-ios"
]
},
{
"group": "Storefront API",
"pages": [
"api-reference/storefront/authentication"
],
"openapi": {
"source": "api-reference/storefront.yaml",
"directory": "api-reference/storefront"
}
},
{
"group": "Platform API",
"pages": [
"api-reference/platform/authentication"
],
"openapi": {
"source": "api-reference/platform.yaml",
"directory": "api-reference/platform"
}
}
]
}
]
},
{
"tab": "Integrations",
"groups": [
{
"group": "Integrations",
"pages": [
"integrations/integrations"
]
},
{
"group": "Payments",
"pages": [
"integrations/payments/stripe",
"integrations/payments/adyen",
"integrations/payments/paypal",
"integrations/payments/razorpay"
]
},
{
"group": "Tax",
"pages": [
"integrations/tax/avalara"
]
},
{
"group": "Search",
"pages": [
"integrations/search/meilisearch"
]
},
{
"group": "Analytics",
"pages": [
"integrations/analytics/google-analytics",
"integrations/analytics/google-tag-manager"
]
},
{
"group": "Marketing",
"pages": [
"integrations/marketing/klaviyo"
]
}
]
},
{
"tab": "User Guide",
"groups": [
{
"group": "Introduction",
"pages": [
"v5/user/what-is-spree-commerce",
"v5/user/using-spree",
"v5/user/user-quickstart-guide"
]
},
{
"group": "Migration",
"pages": [
"v5/user/migration/migrate-from-shopify"
]
},
{
"group": "How-to Guides",
"pages": [
"v5/user/how-to/multi-currency-pricing",
"v5/user/how-to/multiple-languages",
"v5/user/how-to/multi-region-pricing",
"v5/user/how-to/wholesale-pricing",
"v5/user/how-to/volume-pricing",
"v5/user/how-to/regional-wholesale",
"v5/user/how-to/regional-volume",
"v5/user/how-to/schedule-sale-pricing"
]
},
{
"group": "Products",
"pages": [
{
"group": "Create & Edit Products",
"pages": [
"v5/user/products/creating-products",
"v5/user/products/deleting-products",
"v5/user/products/editing-products",
"v5/user/products/editing-multi-variant-products",
"v5/user/products/cloning-products"
]
},
{
"group": "Manage Products",
"pages": [
"v5/user/manage-products/search-products",
"v5/user/manage-products/bulk-product-operations",
"v5/user/manage-products/price-lists",
"v5/user/manage-products/export-products",
"v5/user/manage-products/import-products",
"v5/user/manage-products/multi-currency-import-export",
"v5/user/manage-products/product-import-file-template",
"v5/user/manage-products/translations",
"v5/user/manage-products/stock-levels",
"v5/user/manage-products/stock-transfers",
"v5/user/manage-products/product-taxonomies",
"v5/user/manage-products/product-options",
"v5/user/manage-products/product-metafields"
]
}
]
},
{
"group": "Orders",
"pages": [
"v5/user/orders/order-states",
"v5/user/orders/processing-orders",
"v5/user/orders/creating-orders",
"v5/user/orders/editing-orders",
"v5/user/orders/order-adjustments",
"v5/user/orders/exporting-orders",
"v5/user/orders/cancelling-orders",
"v5/user/orders/refunding-orders",
"v5/user/orders/searching-orders"
]
},
{
"group": "Returns",
"pages": [
"v5/user/settings/returns-configuration",
"v5/user/returns/returns-processing"
]
},
{
"group": "Customers",
"pages": [
"v5/user/customers/create-customer",
"v5/user/customers/customer-profile",
"v5/user/customers/edit-customer",
"v5/user/customers/issue-gift-card",
"v5/user/customers/assign-store-credits",
"v5/user/customers/searching-customers",
"v5/user/customers/exporting-customers",
"v5/user/customers/customer-groups"
]
},
{
"group": "Promotions",
"pages": [
"v5/user/promotions/create-a-promotion",
"v5/user/promotions/promotion-rules",
"v5/user/promotions/promotion-actions",
"v5/user/promotions/gift-cards"
]
},
{
"group": "Vendors",
"pages": [
"v5/user/settings/marketplace",
"v5/user/vendors/vendor-onboarding-shopify",
"v5/user/vendors/vendor-onboarding-woocommerce",
"v5/user/vendors/vendor-onboarding-manual",
"v5/user/vendors/vendor-management",
"v5/user/vendors/commission-rates",
"v5/user/vendors/vendor-payouts",
"v5/user/vendors/multi-vendor-checkout"
]
},
{
"group": "Settings",
"pages": [
"v5/user/settings/store-details",
"v5/user/settings/sales-channels",
"v5/user/settings/users",
"v5/user/settings/emails",
"v5/user/settings/policies",
"v5/user/settings/payments",
"v5/user/settings/markets",
"v5/user/settings/zones",
"v5/user/settings/shipping-methods",
"v5/user/settings/tax",
"v5/user/settings/locations",
"v5/user/settings/metafields"
]
},
{
"group": "Security",
"pages": [
"v5/user/security"
]
}
]
}
]
}
],
"tabs": [
{
"tab": "Guides",
"menu": [
{
"item": "Getting Started",
"icon": "rocket",
"description": "Quickstart guide and core concepts",
"groups": [
{
"group": "Getting started",
"icon": "rocket",
"pages": [
"developer/getting-started/quickstart"
]
},
{
"group": "Platform",
"icon": "settings",
"pages": [
"developer/core-concepts/architecture",
"developer/core-concepts/stores",
"developer/core-concepts/channels",
"developer/core-concepts/markets",
"developer/core-concepts/customers",
"developer/core-concepts/data-privacy",
"developer/core-concepts/companies",
"developer/core-concepts/sellers",
"developer/core-concepts/staff-roles"
]
},
{
"group": "Catalog",
"icon": "package",
"pages": [
"developer/core-concepts/products",
"developer/core-concepts/pricing",
"developer/core-concepts/catalogs",
"developer/core-concepts/inventory",
"developer/core-concepts/media",
"developer/core-concepts/search-filtering"
]
},
{
"group": "Cart & Checkout",
"icon": "shopping-cart",
"pages": [
"developer/core-concepts/carts",
"developer/core-concepts/orders",
"developer/core-concepts/order-totals",
"developer/core-concepts/payments",
"developer/core-concepts/taxes",
"developer/core-concepts/discounts",
"developer/core-concepts/fees",
"developer/core-concepts/commissions",
"developer/core-concepts/promotions",
"developer/core-concepts/store-credits-gift-cards"
]
},
{
"group": "Fulfillment",
"icon": "truck",
"pages": [
"developer/core-concepts/fulfillments",
"developer/core-concepts/delivery-setup",
"developer/core-concepts/returns-exchanges-claims",
"developer/core-concepts/addresses",
"developer/core-concepts/calculators"
]
},
{
"group": "Extensibility",
"icon": "plug",
"pages": [
"developer/core-concepts/events",
"developer/core-concepts/webhooks",
"developer/core-concepts/translations",
"developer/core-concepts/slugs",
"developer/core-concepts/metafields",
"developer/core-concepts/external-references",
"developer/core-concepts/imports-exports",
"developer/core-concepts/reporting"
]
}
]
},
{
"item": "Building a Storefront",
"icon": "store",
"description": "Use Spree Storefront or build your own",
"groups": [
{
"group": "Next.js Storefront",
"pages": [
"developer/storefront/nextjs/quickstart",
"developer/storefront/nextjs/architecture",
"developer/storefront/nextjs/multi-region",
"developer/storefront/nextjs/customization",
"developer/storefront/nextjs/emails",
"developer/storefront/nextjs/wholesale",
"developer/storefront/nextjs/wallet-payments",
"developer/storefront/nextjs/testing",
"developer/storefront/nextjs/environment-variables",
"developer/storefront/nextjs/deployment"
]
}
]
},
{
"item": "Use Cases",
"icon": "book-open",
"description": "Multi-store/multi-tenant, and marketplace setups",
"groups": [
{
"group": "Multi-Tenant / Multi-Store",
"pages": [
"developer/multi-tenant/quickstart",
"developer/multi-tenant/core-concepts",
"developer/multi-tenant/configuration"
]
},
{
"group": "Multi-Vendor Marketplace",
"pages": [
"developer/multi-vendor/quickstart",
"developer/multi-vendor/installation"
]
}
]
}
]
},
{
"tab": "Framework",
"menu": [
{
"item": "Extending",
"icon": "puzzle",
"description": "Customize admin panel, API, and business logic",
"groups": [
{
"group": "Tutorial",
"icon": "graduation-cap",
"pages": [
"developer/tutorial/introduction",
"developer/tutorial/model-and-api",
"developer/tutorial/dashboard",
"developer/tutorial/storefront",
"developer/tutorial/events",
"developer/tutorial/testing"
]
},
{
"group": "Admin Panel",
"icon": "gauge",
"pages": [
"developer/admin/admin",
"developer/admin/extending-ui",
"developer/admin/navigation",
"developer/admin/tables",
"developer/admin/form-builder",
"developer/admin/components",
"developer/admin/helper-methods",
"developer/admin/authentication",
"developer/admin/custom-javascript",
"developer/admin/custom-css"
]
},
{
"group": "Customization Reference",
"icon": "wrench",
"pages": [
"developer/customization/quickstart",
"developer/customization/configuration",
"developer/customization/authentication",
"developer/customization/checkout",
"developer/customization/permissions",
"developer/customization/workflows",
"developer/customization/dependencies",
"developer/customization/decorators",
"developer/customization/model-preferences",
"developer/customization/metadata",
"developer/customization/routes",
"developer/customization/api"
]
}
]
},
{
"item": "How-to Guides",
"icon": "book-open",
"description": "Step-by-step guides for common tasks",
"groups": [
{
"group": "Order Routing",
"icon": "route",
"pages": [
"developer/how-to/custom-order-routing"
]
},
{
"group": "Stock Splitters",
"icon": "boxes-stacked",
"pages": [
"developer/how-to/custom-stock-splitter"
]
},
{
"group": "Payments",
"icon": "credit-card",
"pages": [
"developer/how-to/custom-payment-method"
]
},
{
"group": "Promotions",
"icon": "tag",
"pages": [
"developer/how-to/custom-promotion"
]
},
{
"group": "Reports",
"icon": "chart-bar",
"pages": [
"developer/how-to/extend-reporting"
]
},
{
"group": "Search",
"icon": "search",
"pages": [
"developer/how-to/custom-search-provider"
]
},
{
"group": "Authentication",
"icon": "key",
"pages": [
"developer/how-to/custom-api-authentication"
]
}
]
},
{
"item": "Dashboard",
"icon": "gauge",
"description": "React dashboard",
"hidden": true,
"groups": [
{
"group": "Overview",
"pages": [
"developer/dashboard/overview",
"developer/dashboard/concepts",
"developer/dashboard/public-api"
]
},
{
"group": "Customization",
"pages": [
"developer/dashboard/customization/quickstart",
"developer/dashboard/customization/navigation",
"developer/dashboard/customization/routes",
"developer/dashboard/customization/slots",
"developer/dashboard/customization/tables",
"developer/dashboard/customization/translations",
"developer/dashboard/customization/theming",
"developer/dashboard/customization/permissions",
"developer/dashboard/customization/backend"
]
},
{
"group": "Recipes",
"pages": [
"developer/dashboard/recipes/attribute-end-to-end",
"developer/dashboard/recipes/custom-form-field",
"developer/dashboard/recipes/page-action-button",
"developer/dashboard/recipes/sidebar-widget"
]
},
{
"group": "Plugins",
"pages": [
"developer/dashboard/plugins/overview",
"developer/dashboard/plugins/scaffolding",
"developer/dashboard/plugins/publishing",
"developer/dashboard/plugins/distributing"
]
},
{
"group": "Deployment",
"pages": [
"developer/dashboard/deployment"
]
},
{
"group": "Slots Catalog",
"pages": [
"developer/dashboard/slots-catalog"
]
}
]
},
{
"item": "Operations",
"icon": "server",
"description": "Deploy, upgrade, and maintain your store",
"groups": [
{
"group": "Deployment",
"icon": "server",
"pages": [
"developer/deployment/quickstart",
"developer/deployment/docker",
"developer/deployment/environment_variables",
{
"group": "AWS",
"pages": [
"developer/deployment/aws",
"developer/deployment/aws_ecs"
]
},
"developer/deployment/render",
"developer/deployment/assets",
"developer/deployment/emails",
"developer/deployment/cdn",
"developer/deployment/background_jobs",
"developer/deployment/caching",
"developer/deployment/database",
"developer/deployment/telemetry"
]
},
{
"group": "Upgrading",
"icon": "circle-arrow-up",
"pages": [
"developer/upgrades/quickstart",
{
"group": "Upgrade Guides",
"pages": [
"developer/upgrades/5.5-to-5.6",
"developer/upgrades/5.4-to-5.5",
"developer/upgrades/5.3-to-5.4",
"developer/upgrades/5.2-to-5.3",
"developer/upgrades/5.1-to-5.2",
"developer/upgrades/5.0-to-5.1",
"developer/upgrades/4.10-to-5.0",
"developer/upgrades/4.9-to-4.10",
"developer/upgrades/4.8-to-4.9",
"developer/upgrades/4.x-to-4.8",
"developer/upgrades/4.6-to-4.7",
"developer/upgrades/4.5-to-4.6",
"developer/upgrades/4.4-to-4.5",
"developer/upgrades/4.3-to-4.4",
"developer/upgrades/4.2-to-4.3",
"developer/upgrades/4.1-to-4.2",
"developer/upgrades/4.0-to-4.1",
"developer/upgrades/3.7-to-4.0",
"developer/upgrades/3.6-to-3.7",
"developer/upgrades/3.5-to-3.6",
"developer/upgrades/3.4-to-3.5",
"developer/upgrades/3.3-to-3.4",
"developer/upgrades/3.2-to-3.3",
"developer/upgrades/3.1-to-3.2",
"developer/upgrades/3.0-to-3.1",
"developer/upgrades/2.3-to-2.4",
"developer/upgrades/2.2-to-2.3",
"developer/upgrades/2.1-to-2.2",
"developer/upgrades/2.0-to-2.1"
]
}
]
},
{
"group": "Contributing",
"icon": "heart",
"pages": [
"developer/contributing/quickstart",
"developer/contributing/developing-spree",
"developer/contributing/creating-an-extension"
]
},
{
"group": "Security",
"icon": "shield",
"pages": [
"developer/security/security_policy",
"developer/security/pci_compliance"
]
}
]
}
]
},
{
"tab": "SDK & Tools",
"menu": [
{
"item": "Store SDK",
"icon": "code",
"description": "TypeScript SDK for the Store API",
"groups": [
{
"group": "Getting Started",
"pages": [
"developer/sdk/quickstart",
"developer/sdk/authentication",
"developer/sdk/configuration",
"developer/sdk/extending"
]
},
{
"group": "Store API",
"pages": [
"developer/sdk/store/products",
"developer/sdk/store/cart-checkout",
"developer/sdk/store/payments",
"developer/sdk/store/markets",
"developer/sdk/store/account",
"developer/sdk/store/wishlists"
]
}
]
},
{
"item": "Admin SDK",
"icon": "shield-check",
"description": "TypeScript SDK for the Admin API",
"groups": [
{
"group": "Admin SDK",
"pages": [
"developer/sdk/admin/quickstart",
"developer/sdk/admin/authentication",
"developer/sdk/admin/resources",
"developer/sdk/admin/querying-and-errors",
"developer/sdk/admin/extending"
]
}
]
},
{
"item": "CLI",
"icon": "square-terminal",
"description": "Command-line interface for Spree",
"groups": [
{
"group": "CLI",
"pages": [
"developer/cli/quickstart",
"developer/cli/admin-api"
]
}
]
},
{
"item": "create-spree-app",
"icon": "rocket",
"description": "Scaffold a new Spree project",
"groups": [
{
"group": "create-spree-app",
"pages": [
"developer/create-spree-app/quickstart"
]
}
]
},
{
"item": "Agentic Development",
"icon": "bot",
"description": "Build Spree with AI coding agents",
"groups": [
{
"group": "Agentic Development",
"pages": [
"developer/agentic/overview",
"developer/agentic/agent-skills",
"developer/agentic/docs-mcp",
"developer/agentic/llm-docs"
]
}
]
}
]
},
{
"tab": "API Reference",
"menu": [
{
"item": "Store API",
"icon": "store",
"description": "REST API for storefronts and custom integrations",
"groups": [
{
"group": "API basics",
"pages": [
"api-reference/store-api/introduction",
"api-reference/store-api/authentication",
"api-reference/store-api/errors",
"api-reference/store-api/idempotency",
"api-reference/store-api/rate-limitting",
"api-reference/store-api/querying",
"api-reference/store-api/relations",
"api-reference/store-api/metadata",
"api-reference/store-api/localization",
"api-reference/store-api/monetary-amounts",
"api-reference/store-api/migrating-from-storefront-api-v2"
]
},
{
"group": "Endpoints",
"openapi": {
"source": "api-reference/store.yaml",
"directory": "api-reference/store-api"
}
}
]
},
{
"item": "Admin API",
"icon": "shield",
"description": "REST API for pragmatically managing stores",
"groups": [
{
"group": "API basics",
"pages": [
"api-reference/admin-api/introduction",
"api-reference/admin-api/authentication",
"api-reference/admin-api/errors",
"api-reference/admin-api/querying",
"api-reference/admin-api/monetary-amounts",
"api-reference/admin-api/uploads",
"api-reference/admin-api/endpoints"
]
},
{
"group": "Endpoints",
"openapi": {
"source": "api-reference/admin.yaml",
"directory": "api-reference/admin-api"
}
}
]
},
{
"item": "Seller API",
"icon": "handshake",
"description": "REST API for the marketplace seller panel",
"groups": [
{
"group": "API basics",
"pages": [
"api-reference/seller-api/introduction",
"api-reference/seller-api/authentication",
"api-reference/seller-api/errors"
]
},
{
"group": "Endpoints",
"openapi": {
"source": "api-reference/seller.yaml",
"directory": "api-reference/seller-api"
}
}
]
},
{
"item": "Webhooks",
"icon": "webhook",
"description": "Event payloads and delivery reference",
"groups": [
{
"group": "Webhooks",
"pages": [
"api-reference/webhooks-events"
]
}
]
},
{
"item": "Legacy API v2",
"icon": "clock",
"description": "Previous-generation Storefront and Platform APIs",
"groups": [
{
"group": "API basics",
"pages": [
"api-reference/v2/introduction",
"api-reference/v2/pagination",
"api-reference/v2/filtering-and-sorting",
"api-reference/v2/fetching-multiple-resources"
]
},
{
"group": "Tutorials",
"pages": [
"api-reference/tutorials/quick-checkout-with-stripe",
"api-reference/tutorials/adyen-integration-guide-for-android",
"api-reference/tutorials/adyen-integration-guide-for-ios"
]
},
{
"group": "Storefront API",
"pages": [
"api-reference/storefront/authentication"
],
"openapi": {
"source": "api-reference/storefront.yaml",
"directory": "api-reference/storefront"
}
},
{
"group": "Platform API",
"pages": [
"api-reference/platform/authentication"
],
"openapi": {
"source": "api-reference/platform.yaml",
"directory": "api-reference/platform"
}
}
]
}
]
},
{
"tab": "Integrations",
"groups": [
{
"group": "Integrations",
"pages": [
"integrations/integrations"
]
},
{
"group": "Payments",
"pages": [
"integrations/payments/stripe",
"integrations/payments/adyen",
"integrations/payments/paypal",
"integrations/payments/razorpay"
]
},
{
"group": "Tax",
"pages": [
"integrations/tax/avalara"
]
},
{
"group": "Search",
"pages": [
"integrations/search/meilisearch"
]
},
{
"group": "Analytics",
"pages": [
"integrations/analytics/google-analytics",
"integrations/analytics/google-tag-manager"
]
},
{
"group": "Marketing",
"pages": [
"integrations/marketing/klaviyo"
]
}
]
},
{
"tab": "User Guide",
"groups": [
{
"group": "Introduction",
"pages": [
"user/what-is-spree-commerce",
"user/using-spree",
"user/user-quickstart-guide"
]
},
{
"group": "Migration",
"pages": [
"user/migration/migrate-from-shopify"
]
},
{
"group": "How-to Guides",
"pages": [
"user/how-to/selling-to-businesses",
"user/how-to/multi-currency-pricing",
"user/how-to/multiple-languages",
"user/how-to/multi-region-pricing",
"user/how-to/wholesale-pricing",
"user/how-to/volume-pricing",
"user/how-to/regional-wholesale",
"user/how-to/regional-volume",
"user/how-to/schedule-sale-pricing"
]
},
{
"group": "Products",
"icon": "package",
"pages": [
"user/products/products",
"user/products/adding-products",
"user/products/variants",
"user/products/options",
"user/products/media",
"user/products/categories",
"user/products/collections",
"user/products/custom-product-fields",
"user/products/import-and-export",
"user/products/import-template"
]
},
{
"group": "Inventory",
"icon": "warehouse",
"pages": [
"user/inventory/stock-levels",
"user/inventory/stock-transfers",
"user/inventory/purchase-orders",
"user/inventory/suppliers"
]
},
{
"group": "Pricing",
"icon": "tag",
"pages": [
"user/pricing/price-lists"
]
},
{
"group": "Catalogs",
"icon": "book-marked",
"pages": [
"user/catalogs/catalogs"
]
},
{
"group": "Translations",
"icon": "languages",
"pages": [
"user/translations/translations"
]
},
{
"group": "Orders",
"pages": [
"user/orders/orders",
"user/orders/processing-orders",
"user/orders/draft-orders",
"user/orders/returns",
"user/orders/exchanges",
"user/orders/claims"
]
},
{
"group": "Customers",
"pages": [
"user/customers/customers",
"user/customers/customer-profile",
"user/customers/customer-groups",
"user/customers/companies"
]
},
{
"group": "Sellers",
"icon": "store",
"pages": [
"user/sellers/sellers",
"user/sellers/onboarding",
"user/sellers/seller-panel",
"user/sellers/products",
"user/sellers/orders",
"user/sellers/commission-rates",
"user/sellers/transfers",
"user/sellers/payouts"
]
},
{
"group": "Loyalty",
"pages": [
"user/loyalty/gift-cards",
"user/loyalty/store-credits"
]
},
{
"group": "Promotions",
"pages": [
"user/promotions/create-a-promotion",
"user/promotions/promotion-rules",
"user/promotions/promotion-actions"
]
},
{
"group": "Reports",
"icon": "chart-column",
"pages": [
"user/reports/reports"
]
},
{
"group": "AI Agents",
"icon": "bot",
"pages": [
"user/ai-agents/ai-agents",
"user/ai-agents/connect-claude",
"user/ai-agents/connect-chatgpt"
]
},
{
"group": "Settings",
"pages": [
"user/settings/store-details",
"user/settings/sales-channels",
"user/settings/users",
"user/settings/emails",
"user/settings/policies",
"user/settings/payments",
"user/settings/markets",
"user/settings/zones",
"user/settings/shipping-methods",
"user/settings/tax",
"user/settings/locations",
"user/settings/metafields",
"user/settings/returns-configuration",
"user/settings/product-types",
"user/settings/package-types",
"user/settings/integrations",
"user/settings/api-keys",
"user/settings/webhooks",
"user/settings/allowed-origins"
]
},
{
"group": "Security",
"pages": [
"user/security"
]
}
]
}
]
},
"logo": {
"light": "/logo/logo_light.png",
"dark": "/logo/logo_dark.png"
},
"api": {
"examples": {
"languages": [
"javascript",
"curl"
]
},
"openapi": [
"api-reference/store.yaml",
"api-reference/storefront.yaml",
"api-reference/platform.yaml"
],
"mdx": {
"server": [
"http://localhost:3000"
]
}
},
"navbar": {
"links": [
{
"label": "16k",
"href": "https://github.com/spree/spree",
"icon": {
"library": "lucide",
"name": "github"
}
},
{
"label": "Join Discord",
"href": "https://discord.spreecommerce.org",
"icon": {
"library": "lucide",
"name": "discord"
}
}
],
"primary": {
"label": "Try Sandbox",
"href": "https://spree.sh",
"type": "button"
}
},
"footer": {
"socials": {
"github": "https://github.com/spree/spree",
"x": "https://x.com/spreecommerce"
}
},
"integrations": {
"ga4": {
"measurementId": "G-NCVLCVHL5Y"
}
}
}