{ "$schema": "https://mintlify.com/docs.json", "theme": "aspen", "name": "MercurJS Documentation", "description": "Mercur is an open-source AI-native marketplace framework built on MedusaJS v2. It provides block-based architecture for building multi-vendor marketplaces with seller management, commissions, order splitting, payouts, admin panel, and vendor portal. Code is copied directly into your project — full ownership, no black-box dependencies.", "logo": { "dark": "/logo.svg", "light": "/logo_dark.svg" }, "favicon": "/favicon.png", "colors": { "primary": "#090909", "light": "#ffffff", "dark": "#090909" }, "topbarLinks": [ { "name": "Contact us", "url": "https://www.mercurjs.com/contact" } ], "topbarCtaButton": { "name": "Learn more", "url": "https://www.mercurjs.com" }, "navigation": { "versions": [ { "version": "2.1.1", "default": true, "tabs": [ { "tab": "Welcome", "groups": [ { "group": "Welcome", "pages": [ "welcome" ] } ] }, { "tab": "Docs", "groups": [ { "group": "Getting started", "pages": [ "getting-started/introduction", "getting-started/concepts", "getting-started/installation" ] }, { "group": "Core Concepts", "pages": [ "core-concepts/seller", "core-concepts/seller-members", "core-concepts/subscriptions", "core-concepts/payout", "core-concepts/commission", "core-concepts/order-groups" ] }, { "group": "Developer Guide", "pages": [ "developer-guide/overview", "developer-guide/blocks", "developer-guide/registry", "developer-guide/api-client", "developer-guide/cli", "developer-guide/extending-panels", "developer-guide/custom-fields" ] }, { "group": "How-to Guides", "pages": [ "how-to-guides/stripe-connect-integration" ] }, { "group": "Migration", "pages": [ "migrations/overview", "migrations/from-2-0-to-2-1", "migrations/from-1-x-to-2-0" ] }, { "group": "AI Development", "pages": [ "ai-development/llms", "ai-development/mcp", "ai-development/skills" ] }, { "group": "Legal", "pages": [ "telemetry" ] } ] }, { "tab": "User Guide", "groups": [ { "group": "Admin Panel", "pages": [ "user-guides/admin/stores" ] }, { "group": "Vendor Panel", "pages": [ "user-guides/vendor/stores" ] } ] }, { "tab": "Changelog", "groups": [ { "group": "Changelog", "pages": [] } ] } ] }, { "version": "1.x", "tabs": [ { "tab": "Docs", "groups": [ { "group": "Quick start", "pages": [ "v1/introduction", "v1/get-started" ] }, { "group": "Components", "pages": [ "v1/components/backend", "v1/components/admin-panel", "v1/components/vendor-panel", "v1/components/storefront" ] }, { "group": "Core Concepts", "pages": [ "v1/core-concepts/seller", "v1/core-concepts/order-splitting", "v1/core-concepts/payouts", "v1/core-concepts/commission", "v1/core-concepts/marketplace-settings", "v1/core-concepts/requests", "v1/core-concepts/reviews", "v1/core-concepts/notifications" ] }, { "group": "Product", "pages": [ "v1/product/framework", "v1/product/core-commerce-modules", "v1/product/core-infrastructure-modules", { "group": "Mercur marketplace modules", "pages": [ { "group": "Core", "pages": [ { "group": "Attribute module", "pages": [ "v1/product/modules/b2c-core/attribute/attribute-concept", "v1/product/modules/b2c-core/attribute/attribute-links", "v1/product/modules/b2c-core/attribute/attributes-data-models-ref", "v1/product/modules/b2c-core/attribute/attributes-services" ] }, { "group": "Configuration module", "pages": [ "v1/product/modules/b2c-core/configuration/configuration-concept", "v1/product/modules/b2c-core/configuration/configuration-data-models-ref", "v1/product/modules/b2c-core/configuration/configuration-services" ] }, { "group": "Marketplace module", "pages": [ "v1/product/modules/b2c-core/marketplace/marketplace-concept", "v1/product/modules/b2c-core/marketplace/marketplace-links", "v1/product/modules/b2c-core/marketplace/marketplace-data-model-reference", "v1/product/modules/b2c-core/marketplace/marketplace-service" ] }, { "group": "Payout module", "pages": [ "v1/product/modules/b2c-core/payout/payout-concept", "v1/product/modules/b2c-core/payout/payout-links", "v1/product/modules/b2c-core/payout/payout-data-model-reference", "v1/product/modules/b2c-core/payout/payout-services" ] }, { "group": "Secondary Category Module", "pages": [ "v1/product/modules/b2c-core/secondary-categories/secondary-categories-concept", "v1/product/modules/b2c-core/secondary-categories/secondary-category-links", "v1/product/modules/b2c-core/secondary-categories/sec-cat-data-model-reference", "v1/product/modules/b2c-core/secondary-categories/secondary-category-services" ] }, { "group": "Seller module", "pages": [ "v1/product/modules/b2c-core/seller/seller-concept", "v1/product/modules/b2c-core/seller/seller-module-options", "v1/product/modules/b2c-core/seller/seller-links", "v1/product/modules/b2c-core/seller/seller-data-model-reference", "v1/product/modules/b2c-core/seller/seller-services" ] }, { "group": "Split Order Payment Module", "pages": [ "v1/product/modules/b2c-core/split-order-payment/split-order-payment-concept", "v1/product/modules/b2c-core/split-order-payment/split-order-links", "v1/product/modules/b2c-core/split-order-payment/split-order-data-model-reference", "v1/product/modules/b2c-core/split-order-payment/split-order-services" ] }, { "group": "Taxcode module", "pages": [ "v1/product/modules/b2c-core/taxcode/taxcode-concept", "v1/product/modules/b2c-core/taxcode/taxcode-links", "v1/product/modules/b2c-core/taxcode/taxcode-data-model-reference", "v1/product/modules/b2c-core/taxcode/taxcode-services" ] }, { "group": "Wishlist module", "pages": [ "v1/product/modules/b2c-core/wishlist/wishlist-concept", "v1/product/modules/b2c-core/wishlist/wishlist-links", "v1/product/modules/b2c-core/wishlist/wishlist-data-model-reference", "v1/product/modules/b2c-core/wishlist/wishlist-services" ] } ] }, { "group": "Commission", "pages": [ { "group": "Commission module", "pages": [ "v1/product/modules/commission/commission/commission-concept", "v1/product/modules/commission/commission/commission-data-model-reference", "v1/product/modules/commission/commission/commission-services" ] } ] }, { "group": "Requests", "pages": [ { "group": "Request module", "pages": [ "v1/product/modules/requests/requests/requests-concept", "v1/product/modules/requests/requests/requests-links", "v1/product/modules/requests/requests/request-data-model-reference", "v1/product/modules/requests/requests/requests-services" ] }, { "group": "Order Return Request module", "pages": [ "v1/product/modules/requests/order-return-request/order-return-request", "v1/product/modules/requests/order-return-request/order-return-request-links", "v1/product/modules/requests/order-return-request/order-return-request-data-model-reference", "v1/product/modules/requests/order-return-request/order-return-request-services" ] } ] }, { "group": "Reviews", "pages": [ { "group": "Reviews module", "pages": [ "v1/product/modules/reviews/reviews/reviews-concept", "v1/product/modules/reviews/reviews/review-links", "v1/product/modules/reviews/reviews/review-data-model-reference", "v1/product/modules/reviews/reviews/review-service" ] } ] } ] }, { "group": "Workflows", "pages": [ { "group": "Core", "pages": [ "v1/docs/product/workflows/core/price-list-workflows", "v1/docs/product/workflows/core/attribute", "v1/docs/product/workflows/core/campaign-workflows", "v1/docs/product/workflows/core/cart-workflows", "v1/docs/product/workflows/core/configuration-workflows", "v1/docs/product/workflows/core/customer-groups-workflows", "v1/docs/product/workflows/core/fulfillment-set-workflows", "v1/docs/product/workflows/core/order-workflows", "v1/docs/product/workflows/core/order-set-workflows", "v1/docs/product/workflows/core/payout-workflows", "v1/docs/product/workflows/core/product-workflows", "v1/docs/product/workflows/core/promotions-workflows", "v1/docs/product/workflows/core/seller-workflows", "v1/docs/product/workflows/core/split-order-payment", "v1/docs/product/workflows/core/wishlist-workflows", "v1/docs/product/workflows/core/common-workflows", "v1/docs/product/workflows/core/hooks" ] }, { "group": "Commission", "pages": [ "v1/docs/product/workflows/commission/commission-workflows" ] }, { "group": "Requests", "pages": [ "v1/docs/product/workflows/requests/requests", "v1/docs/product/workflows/requests/order-return-request-workflows" ] }, { "group": "Reviews", "pages": [ "v1/docs/product/workflows/reviews/review-workflows" ] } ] }, "v1/docs/product/js-sdk", "v1/docs/product/api", { "group": "Events", "pages": [ "v1/docs/product/events/core-events", "v1/docs/product/events/request-events", "v1/docs/product/events/reviews-events" ] }, { "group": "Scheduled Jobs", "pages": [ "v1/docs/product/scheduled-jobs/core-scheduled-jobs" ] }, { "group": "Subscribers", "pages": [ "v1/docs/product/subscribers/core", "v1/docs/product/subscribers/commission", "v1/docs/product/subscribers/requests", "v1/docs/product/subscribers/reviews" ] } ] }, { "group": "Integrations", "pages": [ "v1/integrations/algolia", "v1/integrations/resend", "v1/integrations/stripe" ] }, { "group": "Deployment", "pages": [ "v1/medusa-cloud" ] }, { "group": "Development", "pages": [ "v1/development/set-up" ] }, { "group": "Help", "pages": [ "v1/help/llm", "v1/help/mcp", "v1/help/support" ] } ] }, { "tab": "API Reference", "groups": [ { "group": "API Documentation", "openapi": "v1/api-reference/combined.oas.json" } ] }, { "tab": "Changelog", "groups": [ { "group": "Changelog", "pages": [] } ] } ] } ] }, "redirects": [ { "source": "/v2/welcome", "destination": "/welcome" }, { "source": "/v2/:slug*", "destination": "/:slug*" }, { "source": "/introduction", "destination": "/getting-started/introduction" }, { "source": "/get-started", "destination": "/getting-started/installation" }, { "source": "/installation", "destination": "/getting-started/installation" }, { "source": "/cli-installation", "destination": "/getting-started/installation" }, { "source": "/core-concepts/order-splitting", "destination": "/core-concepts/order-groups" }, { "source": "/core-concepts/payouts", "destination": "/core-concepts/payout" }, { "source": "/core-concepts/marketplace-settings", "destination": "/v1/core-concepts/marketplace-settings" }, { "source": "/core-concepts/requests", "destination": "/v1/core-concepts/requests" }, { "source": "/core-concepts/reviews", "destination": "/v1/core-concepts/reviews" }, { "source": "/core-concepts/notifications", "destination": "/v1/core-concepts/notifications" }, { "source": "/components/:slug*", "destination": "/v1/components/:slug*" }, { "source": "/product/:slug*", "destination": "/v1/product/:slug*" }, { "source": "/docs/:slug*", "destination": "/v1/docs/:slug*" }, { "source": "/development/:slug*", "destination": "/v1/development/:slug*" }, { "source": "/integrations/:slug*", "destination": "/v1/integrations/:slug*" }, { "source": "/essentials/:slug*", "destination": "/v1/essentials/:slug*" }, { "source": "/help/:slug*", "destination": "/v1/help/:slug*" }, { "source": "/api-reference/:slug*", "destination": "/v1/api-reference/:slug*" }, { "source": "/snippets/:slug*", "destination": "/v1/snippets/:slug*" }, { "source": "/try-the-api", "destination": "/v1/try-the-api" }, { "source": "/medusa-cloud", "destination": "/v1/medusa-cloud" } ], "footer": { "socials": { "github": "https://github.com/mercurjs/mercur", "linkedin": "https://www.linkedin.com/company/mercurjs/", "discord": "https://discord.gg/NTWNa49S" } }, "contextual": { "options": [ "copy", "view", "chatgpt", "claude", { "title": "Request a feature", "description": "Join the discussion on GitHub to request a new feature", "icon": "plus", "href": "https://github.com/mercurjs/mercur/discussions/categories/ideas" } ] }, "fonts": { "heading": { "family": "Sora", "weight": 400 }, "body": { "family": "Poppins", "weight": 400 } }, "background": { "color": { "dark": "#090909" } } }