@mercurjs/docs 2.2.1 → 2.3.0-canary.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/content/home.mdx +107 -0
- package/content/learn/architecture.mdx +168 -83
- package/content/learn/introduction.mdx +161 -56
- package/content/learn/migration-to-2-0.mdx +187 -0
- package/content/learn/why-mercur.mdx +91 -0
- package/content/platform/attribute/concepts/attribute-types.mdx +59 -0
- package/content/platform/attribute/concepts/global-vs-inline.mdx +50 -0
- package/content/platform/attribute/concepts/variant-axes.mdx +61 -0
- package/content/platform/attribute/guides/attach-attributes-to-a-product.mdx +69 -0
- package/content/platform/attribute/guides/create-a-variant-axis.mdx +83 -0
- package/content/platform/attribute/guides/create-an-attribute.mdx +81 -0
- package/content/platform/attribute/overview.mdx +87 -0
- package/content/platform/attribute/reference/data-models.mdx +56 -0
- package/content/platform/attribute/reference/events.mdx +41 -0
- package/content/platform/attribute/reference/links.mdx +45 -0
- package/content/platform/attribute/reference/service.mdx +49 -0
- package/content/platform/attribute/reference/workflows.mdx +45 -0
- package/content/platform/catalog/concepts/master-products.mdx +54 -0
- package/content/platform/catalog/concepts/product-seller-allowlist.mdx +48 -0
- package/content/platform/catalog/concepts/status-lifecycle.mdx +58 -0
- package/content/platform/catalog/concepts/variants-categories-collections.mdx +49 -0
- package/content/platform/catalog/guides/allowlist-stores.mdx +59 -0
- package/content/platform/catalog/guides/create-a-master-product.mdx +70 -0
- package/content/platform/catalog/guides/publish-or-reject-a-product.mdx +79 -0
- package/content/platform/catalog/overview.mdx +90 -0
- package/content/platform/catalog/reference/data-models.mdx +66 -0
- package/content/platform/catalog/reference/events.mdx +41 -0
- package/content/platform/catalog/reference/links.mdx +44 -0
- package/content/platform/catalog/reference/service.mdx +52 -0
- package/content/platform/catalog/reference/workflows.mdx +40 -0
- package/content/platform/commission/concepts/order-commission-lines.mdx +65 -0
- package/content/platform/commission/concepts/rule-matching.mdx +86 -0
- package/content/platform/commission/concepts/rules-and-rates.mdx +84 -0
- package/content/platform/commission/guides/batch-update-rules.mdx +58 -0
- package/content/platform/commission/guides/create-a-rate.mdx +72 -0
- package/content/platform/commission/guides/refresh-order-commission-lines.mdx +55 -0
- package/content/platform/commission/overview.mdx +86 -0
- package/content/platform/commission/reference/data-models.mdx +75 -0
- package/content/platform/commission/reference/events.mdx +58 -0
- package/content/platform/commission/reference/links.mdx +45 -0
- package/content/platform/commission/reference/service.mdx +51 -0
- package/content/platform/commission/reference/workflows.mdx +40 -0
- package/content/platform/offer/concepts/pricing-and-inventory.mdx +72 -0
- package/content/platform/offer/concepts/shipping.mdx +48 -0
- package/content/platform/offer/concepts/what-is-an-offer.mdx +65 -0
- package/content/platform/offer/guides/bulk-create-offers.mdx +84 -0
- package/content/platform/offer/guides/create-an-offer.mdx +83 -0
- package/content/platform/offer/guides/manage-offer-inventory.mdx +53 -0
- package/content/platform/offer/overview.mdx +84 -0
- package/content/platform/offer/reference/data-models.mdx +56 -0
- package/content/platform/offer/reference/events.mdx +39 -0
- package/content/platform/offer/reference/links.mdx +60 -0
- package/content/platform/offer/reference/service.mdx +53 -0
- package/content/platform/offer/reference/workflows.mdx +38 -0
- package/content/platform/order-group/concepts/computed-totals.mdx +59 -0
- package/content/platform/order-group/concepts/order-splitting.mdx +61 -0
- package/content/platform/order-group/concepts/the-order-group.mdx +64 -0
- package/content/platform/order-group/guides/list-order-groups.mdx +67 -0
- package/content/platform/order-group/guides/retrieve-an-order-group.mdx +63 -0
- package/content/platform/order-group/guides/split-a-cart.mdx +58 -0
- package/content/platform/order-group/overview.mdx +83 -0
- package/content/platform/order-group/reference/data-models.mdx +40 -0
- package/content/platform/order-group/reference/events.mdx +37 -0
- package/content/platform/order-group/reference/links.mdx +45 -0
- package/content/platform/order-group/reference/service.mdx +50 -0
- package/content/platform/order-group/reference/workflows.mdx +39 -0
- package/content/platform/payout/concepts/account-lifecycle.mdx +75 -0
- package/content/platform/payout/concepts/accounts-and-onboarding.mdx +70 -0
- package/content/platform/payout/concepts/payout-pipeline.mdx +99 -0
- package/content/platform/payout/guides/create-a-payout-account.mdx +59 -0
- package/content/platform/payout/guides/process-a-provider-webhook.mdx +74 -0
- package/content/platform/payout/guides/start-provider-onboarding.mdx +50 -0
- package/content/platform/payout/overview.mdx +86 -0
- package/content/platform/payout/reference/data-models.mdx +61 -0
- package/content/platform/payout/reference/events.mdx +48 -0
- package/content/platform/payout/reference/links.mdx +36 -0
- package/content/platform/payout/reference/service.mdx +53 -0
- package/content/platform/payout/reference/workflows.mdx +32 -0
- package/content/platform/product-edit/concepts/change-actions.mdx +66 -0
- package/content/platform/product-edit/concepts/change-pipeline.mdx +69 -0
- package/content/platform/product-edit/concepts/status-and-auto-confirm.mdx +66 -0
- package/content/platform/product-edit/guides/confirm-or-decline-a-change.mdx +76 -0
- package/content/platform/product-edit/guides/edit-a-product.mdx +74 -0
- package/content/platform/product-edit/guides/request-a-revision.mdx +54 -0
- package/content/platform/product-edit/overview.mdx +85 -0
- package/content/platform/product-edit/reference/data-models.mdx +65 -0
- package/content/platform/product-edit/reference/events.mdx +47 -0
- package/content/platform/product-edit/reference/links.mdx +39 -0
- package/content/platform/product-edit/reference/service.mdx +43 -0
- package/content/platform/product-edit/reference/workflows.mdx +49 -0
- package/content/platform/review/concepts/product-vs-seller-reviews.mdx +63 -0
- package/content/platform/review/concepts/ratings-and-moderation.mdx +64 -0
- package/content/platform/review/concepts/the-review-model.mdx +56 -0
- package/content/platform/review/guides/compute-aggregate-ratings.mdx +57 -0
- package/content/platform/review/guides/create-a-review.mdx +55 -0
- package/content/platform/review/guides/moderate-a-review.mdx +58 -0
- package/content/platform/review/guides/respond-to-a-review.mdx +61 -0
- package/content/platform/review/overview.mdx +87 -0
- package/content/platform/review/reference/data-models.mdx +36 -0
- package/content/platform/review/reference/events.mdx +61 -0
- package/content/platform/review/reference/links.mdx +43 -0
- package/content/platform/review/reference/service.mdx +54 -0
- package/content/platform/review/reference/workflows.mdx +31 -0
- package/content/platform/store/concepts/lifecycle.mdx +62 -0
- package/content/platform/store/concepts/store-entity.mdx +53 -0
- package/content/platform/store/concepts/team.mdx +50 -0
- package/content/platform/store/guides/create-a-store.mdx +55 -0
- package/content/platform/store/guides/manage-the-team.mdx +55 -0
- package/content/platform/store/guides/moderate-a-store.mdx +59 -0
- package/content/platform/store/overview.mdx +86 -0
- package/content/platform/store/reference/data-models.mdx +89 -0
- package/content/platform/store/reference/events.mdx +43 -0
- package/content/platform/store/reference/links.mdx +71 -0
- package/content/platform/store/reference/service.mdx +51 -0
- package/content/platform/store/reference/workflows.mdx +35 -0
- package/content/references/api/admin/commission-rates/create-commission-rate.mdx +1 -1
- package/content/references/api/admin/commission-rates/list-commission-rates.mdx +2 -2
- package/content/references/api/admin/commission-rates/update-commission-rate.mdx +1 -1
- package/content/references/api/admin/offers/batch-create-offers.mdx +3 -3
- package/content/references/api/admin/order-groups/list-order-groups.mdx +1 -1
- package/content/references/api/admin/product-attributes/create-attribute-value.mdx +2 -2
- package/content/references/api/admin/product-attributes/create-product-attribute.mdx +1 -1
- package/content/references/api/admin/product-attributes/update-product-attribute.mdx +1 -1
- package/content/references/api/admin/product-changes/confirm-product-change.mdx +1 -1
- package/content/references/api/admin/products/batch-product-attributes.mdx +1 -1
- package/content/references/api/admin/products/create-product.mdx +1 -1
- package/content/references/api/admin/products/preview-product.mdx +1 -1
- package/content/references/api/admin.mdx +4 -5
- package/content/references/api/conventions.mdx +9 -7
- package/content/references/api/store/carts/add-line-item.mdx +1 -1
- package/content/references/api/store/offers/list-offers.mdx +1 -1
- package/content/references/api/store/order-groups/list-order-groups.mdx +1 -1
- package/content/references/api/store.mdx +4 -13
- package/content/references/api/vendor/members/accept-member-invite.mdx +1 -1
- package/content/references/api/vendor/offers/batch-create-offers.mdx +4 -0
- package/content/references/api/vendor/offers/batch-offer-inventory-items.mdx +2 -0
- package/content/references/api/vendor/offers/create-offer.mdx +13 -1
- package/content/references/api/vendor/offers/list-offers.mdx +4 -0
- package/content/references/api/vendor/offers/retrieve-offer.mdx +4 -0
- package/content/references/api/vendor/offers/update-offer.mdx +12 -0
- package/content/references/api/vendor/payout-accounts/create-onboarding.mdx +1 -1
- package/content/references/api/vendor/products/batch-product-attributes.mdx +1 -1
- package/content/references/api/vendor/products/create-product-variant.mdx +1 -1
- package/content/references/api/vendor/products/create-product.mdx +1 -1
- package/content/references/api/vendor/products/delete-product.mdx +1 -1
- package/content/references/api/vendor/products/update-product.mdx +1 -1
- package/content/references/api/vendor/sellers/create-seller.mdx +2 -2
- package/content/references/api/vendor/sellers/list-sellers.mdx +1 -1
- package/content/references/api/vendor.mdx +6 -5
- package/content/references/configuration.mdx +16 -33
- package/content/references/overview.mdx +34 -52
- package/content/references/panel-extensions/create-page.mdx +194 -0
- package/content/references/panel-extensions/custom-fields.mdx +256 -0
- package/content/references/panel-extensions/overview.mdx +102 -0
- package/content/references/panel-extensions/widgets.mdx +212 -0
- package/content/resources/ai/mcp.mdx +2 -2
- package/content/resources/ai/overview.mdx +21 -16
- package/content/resources/ai/skills.mdx +67 -0
- package/content/resources/best-practices/api-routes.mdx +55 -43
- package/content/resources/best-practices/custom-fields.mdx +116 -92
- package/content/resources/best-practices/frontend.mdx +62 -50
- package/content/resources/best-practices/module-links.mdx +48 -34
- package/content/resources/best-practices/modules.mdx +53 -27
- package/content/resources/best-practices/overview.mdx +45 -17
- package/content/resources/best-practices/subscribers-and-jobs.mdx +37 -24
- package/content/resources/best-practices/types.mdx +38 -23
- package/content/resources/best-practices/workflows.mdx +33 -21
- package/content/resources/customization/custom-fields.mdx +15 -15
- package/content/resources/customization/extend-a-workflow.mdx +7 -4
- package/content/resources/customization/extending-panels.mdx +55 -52
- package/content/resources/deployment/medusa-cloud.mdx +21 -20
- package/content/resources/deployment/self-host.mdx +123 -0
- package/content/resources/integrations/overview.mdx +38 -0
- package/content/resources/integrations/stripe-connect.mdx +39 -38
- package/content/resources/tutorials/add-a-block.mdx +25 -18
- package/content/resources/tutorials/add-a-widget.mdx +32 -23
- package/content/resources/tutorials/add-order-detail-button.mdx +33 -20
- package/content/resources/tutorials/attributes-and-variant-axes.mdx +28 -27
- package/content/resources/tutorials/build-a-block.mdx +26 -15
- package/content/resources/tutorials/custom-api-route.mdx +32 -20
- package/content/resources/tutorials/custom-panel-page.mdx +21 -12
- package/content/resources/tutorials/customize-navigation.mdx +30 -23
- package/content/resources/tutorials/extend-forms-and-tables.mdx +36 -28
- package/content/resources/tutorials/extend-onboarding.mdx +38 -35
- package/content/resources/tutorials/master-products-and-offers.mdx +28 -23
- package/content/telemetry.mdx +3 -3
- package/content/user-guide/admin/attributes/how-tos/create-an-attribute.mdx +64 -0
- package/content/user-guide/admin/attributes/how-tos/manage-possible-values.mdx +40 -0
- package/content/user-guide/admin/attributes/overview.mdx +22 -0
- package/content/user-guide/admin/commissions/how-tos/create-a-commission-rule.mdx +63 -0
- package/content/user-guide/admin/commissions/how-tos/edit-the-global-commission.mdx +48 -0
- package/content/user-guide/admin/commissions/how-tos/manage-a-commission-rule.mdx +45 -0
- package/content/user-guide/admin/commissions/overview.mdx +25 -0
- package/content/user-guide/admin/overview.mdx +20 -12
- package/content/user-guide/admin/product-requests/how-tos/review-a-new-product.mdx +58 -0
- package/content/user-guide/admin/product-requests/how-tos/review-a-product-edit.mdx +48 -0
- package/content/user-guide/admin/product-requests/overview.mdx +25 -0
- package/content/user-guide/vendor/offers/how-tos/create-an-offer.mdx +59 -0
- package/content/user-guide/vendor/offers/how-tos/update-prices-and-stock.mdx +40 -0
- package/content/user-guide/vendor/offers/overview.mdx +22 -0
- package/content/user-guide/vendor/onboarding.mdx +79 -0
- package/content/user-guide/vendor/orders/how-tos/fulfill-an-order.mdx +49 -0
- package/content/user-guide/vendor/orders/how-tos/mark-an-order-as-delivered.mdx +33 -0
- package/content/user-guide/vendor/orders/how-tos/process-a-return.mdx +42 -0
- package/content/user-guide/vendor/orders/how-tos/refund-an-order.mdx +38 -0
- package/content/user-guide/vendor/orders/how-tos/ship-an-order.mdx +40 -0
- package/content/user-guide/vendor/orders/overview.mdx +31 -0
- package/content/user-guide/vendor/overview.mdx +23 -12
- package/content/user-guide/vendor/products/how-tos/edit-a-product.mdx +44 -0
- package/content/user-guide/vendor/products/how-tos/submit-a-product.mdx +63 -0
- package/content/user-guide/vendor/products/overview.mdx +22 -0
- package/llms.txt +176 -142
- package/package.json +1 -1
- package/content/learn/concepts.mdx +0 -84
- package/content/learn/installation.mdx +0 -117
- package/content/learn/mirakl-alternative.mdx +0 -86
- package/content/migration/from-1-x-to-2-0.mdx +0 -152
- package/content/migration/from-2-0-to-2-1.mdx +0 -105
- package/content/migration/overview.mdx +0 -58
- package/content/references/api/store/search/search.mdx +0 -136
- package/content/references/modules/commission.mdx +0 -106
- package/content/references/modules/custom-fields.mdx +0 -45
- package/content/references/modules/media.mdx +0 -55
- package/content/references/modules/offer.mdx +0 -64
- package/content/references/modules/payout.mdx +0 -121
- package/content/references/modules/product-attribute.mdx +0 -111
- package/content/references/modules/product-edit.mdx +0 -80
- package/content/references/modules/search.mdx +0 -112
- package/content/references/modules/seller.mdx +0 -175
- package/content/references/panel-extension-api.mdx +0 -337
- package/content/references/workflows/cart/add-seller-shipping-method-to-cart.mdx +0 -48
- package/content/references/workflows/cart/complete-cart-with-split-orders.mdx +0 -36
- package/content/references/workflows/cart/list-seller-shipping-options-for-cart.mdx +0 -39
- package/content/references/workflows/cart/update-cart-seller-promotions.mdx +0 -42
- package/content/references/workflows/commission/batch-commission-rules.mdx +0 -49
- package/content/references/workflows/commission/create-commission-rates.mdx +0 -41
- package/content/references/workflows/commission/delete-commission-rates.mdx +0 -34
- package/content/references/workflows/commission/refresh-order-commission-lines.mdx +0 -30
- package/content/references/workflows/commission/update-commission-rates.mdx +0 -35
- package/content/references/workflows/media/set-category-images.mdx +0 -41
- package/content/references/workflows/media/set-collection-images.mdx +0 -41
- package/content/references/workflows/member/accept-member-invite.mdx +0 -33
- package/content/references/workflows/member/add-seller-member.mdx +0 -30
- package/content/references/workflows/member/create-member-invites.mdx +0 -34
- package/content/references/workflows/member/delete-member-invite.mdx +0 -24
- package/content/references/workflows/member/remove-seller-member.mdx +0 -28
- package/content/references/workflows/member/resend-member-invite.mdx +0 -28
- package/content/references/workflows/member/update-member-role.mdx +0 -28
- package/content/references/workflows/member/update-member.mdx +0 -35
- package/content/references/workflows/offer/batch-offer-inventory-items.mdx +0 -62
- package/content/references/workflows/offer/create-offers.mdx +0 -65
- package/content/references/workflows/offer/delete-offers.mdx +0 -35
- package/content/references/workflows/offer/update-offers.mdx +0 -53
- package/content/references/workflows/order/cancel-order-fulfillment.mdx +0 -34
- package/content/references/workflows/order/confirm-claim-request.mdx +0 -25
- package/content/references/workflows/order/confirm-exchange-request.mdx +0 -25
- package/content/references/workflows/order/confirm-order-edit-request.mdx +0 -25
- package/content/references/workflows/order/confirm-return-receive.mdx +0 -25
- package/content/references/workflows/order/create-order-fulfillment.mdx +0 -45
- package/content/references/workflows/order-group/get-order-group-detail.mdx +0 -29
- package/content/references/workflows/order-group/get-order-groups-list.mdx +0 -38
- package/content/references/workflows/overview.mdx +0 -72
- package/content/references/workflows/payout/create-onboarding.mdx +0 -36
- package/content/references/workflows/payout/create-payout-account.mdx +0 -33
- package/content/references/workflows/payout/create-payout.mdx +0 -30
- package/content/references/workflows/payout/process-payout-for-webhook.mdx +0 -34
- package/content/references/workflows/product/confirm-products.mdx +0 -48
- package/content/references/workflows/product/create-products.mdx +0 -63
- package/content/references/workflows/product/link-sellers-to-product-category.mdx +0 -40
- package/content/references/workflows/product/link-sellers-to-product.mdx +0 -40
- package/content/references/workflows/product/reject-product.mdx +0 -48
- package/content/references/workflows/product/request-product-change.mdx +0 -48
- package/content/references/workflows/product-attribute/add-product-attributes-to-product.mdx +0 -49
- package/content/references/workflows/product-attribute/create-and-link-product-attributes-to-product.mdx +0 -46
- package/content/references/workflows/product-attribute/create-product-attribute-values.mdx +0 -43
- package/content/references/workflows/product-attribute/create-product-attributes.mdx +0 -56
- package/content/references/workflows/product-attribute/delete-product-attribute-values.mdx +0 -30
- package/content/references/workflows/product-attribute/delete-product-attributes.mdx +0 -30
- package/content/references/workflows/product-attribute/remove-product-attributes-from-product.mdx +0 -29
- package/content/references/workflows/product-attribute/update-product-attribute-values.mdx +0 -44
- package/content/references/workflows/product-attribute/update-product-attributes-on-product.mdx +0 -41
- package/content/references/workflows/product-attribute/update-product-attributes.mdx +0 -48
- package/content/references/workflows/product-attribute/upsert-product-attribute-values.mdx +0 -43
- package/content/references/workflows/product-edit/auto-confirm-product-change.mdx +0 -39
- package/content/references/workflows/product-edit/cancel-product-change.mdx +0 -49
- package/content/references/workflows/product-edit/confirm-product-change.mdx +0 -57
- package/content/references/workflows/product-edit/create-product-change.mdx +0 -72
- package/content/references/workflows/product-edit/reject-product-change.mdx +0 -54
- package/content/references/workflows/product-edit/stage-product-change.mdx +0 -75
- package/content/references/workflows/seller/approve-seller.mdx +0 -36
- package/content/references/workflows/seller/create-seller-account.mdx +0 -59
- package/content/references/workflows/seller/create-seller-defaults.mdx +0 -22
- package/content/references/workflows/seller/create-sellers.mdx +0 -65
- package/content/references/workflows/seller/delete-seller-professional-details.mdx +0 -37
- package/content/references/workflows/seller/delete-sellers.mdx +0 -24
- package/content/references/workflows/seller/invite-seller.mdx +0 -28
- package/content/references/workflows/seller/suspend-seller.mdx +0 -37
- package/content/references/workflows/seller/terminate-seller.mdx +0 -37
- package/content/references/workflows/seller/unsuspend-seller.mdx +0 -36
- package/content/references/workflows/seller/unterminate-seller.mdx +0 -36
- package/content/references/workflows/seller/update-seller-address.mdx +0 -55
- package/content/references/workflows/seller/update-seller-payment-details.mdx +0 -52
- package/content/references/workflows/seller/update-seller-professional-details.mdx +0 -48
- package/content/references/workflows/seller/update-sellers.mdx +0 -57
- package/content/resources/ai/llms.mdx +0 -74
- package/content/resources/integrations/notifications.mdx +0 -39
- package/content/resources/integrations/search.mdx +0 -122
- package/content/resources/tutorials/configure-commissions.mdx +0 -127
- package/content/resources/tutorials/first-marketplace.mdx +0 -45
- package/content/resources/tutorials/handle-product-requests.mdx +0 -80
- package/content/resources/tutorials/import-export-products.mdx +0 -96
- package/content/resources/tutorials/seller-payouts-stripe.mdx +0 -89
- package/content/resources/tutorials/store-setup-checklist.mdx +0 -214
- package/content/tools/api-client.mdx +0 -155
- package/content/tools/cli.mdx +0 -196
- package/content/tools/dashboard-sdk.mdx +0 -35
package/llms.txt
CHANGED
|
@@ -7,14 +7,12 @@ package (`node_modules/@mercurjs/docs/`).
|
|
|
7
7
|
|
|
8
8
|
## Learn — concepts and getting started
|
|
9
9
|
|
|
10
|
-
- [
|
|
10
|
+
- [Architecture](content/learn/architecture.mdx) — How the Mercur enterprise marketplace platform is built: its layers, building blocks, and how the pieces fit together.
|
|
11
11
|
- [Product Attributes](content/learn/attributes.mdx) — Typed, filterable product attributes on top of Medusa's native product options — including variant axes shared across the catalog.
|
|
12
12
|
- [Blocks](content/learn/blocks.mdx) — Self-contained pieces of marketplace functionality that get copied into your project as source code.
|
|
13
13
|
- [Commission](content/learn/commissions.mdx) — How marketplace commissions work in Mercur — rates, rules, the matching algorithm, and commission lines.
|
|
14
|
-
- [
|
|
15
|
-
- [
|
|
16
|
-
- [Introduction](content/learn/introduction.mdx) — Mercur is an open-source marketplace platform built on MedusaJS with a block-based architecture.
|
|
17
|
-
- [Mercur - an open-source Mirakl alternative](content/learn/mirakl-alternative.mdx) — How Mercur compares to Mirakl and other marketplace platforms: open-source, self-hosted, no GMV fees, full code ownership.
|
|
14
|
+
- [Overview](content/learn/introduction.mdx) — Set up Mercur, tour the operator and seller panels, and see how a multi-vendor order flows.
|
|
15
|
+
- [Migration to 2.0](content/learn/migration-to-2-0.mdx) — Port an existing Mercur 1.x project to 2.x, the latest release.
|
|
18
16
|
- [Offers](content/learn/offers.mdx) — An offer is a seller's sellable listing against a master product — their own SKU, price, inventory, and shipping.
|
|
19
17
|
- [Order Groups](content/learn/order-groups.mdx) — How multi-seller checkout creates order groups — the container that ties a single cart to multiple seller orders.
|
|
20
18
|
- [Payout](content/learn/payouts.mdx) — How seller payouts work in Mercur — accounts, onboarding, payment capture, and the transfer pipeline.
|
|
@@ -23,55 +21,44 @@ package (`node_modules/@mercurjs/docs/`).
|
|
|
23
21
|
- [Registry](content/learn/registry.mdx) — Create, build, and host your own block registry.
|
|
24
22
|
- [Seller Members](content/learn/seller-members.mdx) — Multi-user seller accounts — member data, team management, store switching, and access rules.
|
|
25
23
|
- [Seller](content/learn/sellers.mdx) — The central marketplace actor — seller profile, lifecycle, registration flows, and business rules.
|
|
24
|
+
- [Why Mercur](content/learn/why-mercur.mdx) — Why teams choose Mercur to run an enterprise marketplace: governance, ownership, and composability without a closed platform.
|
|
26
25
|
|
|
27
26
|
## Resources — tutorials, integrations, deployment
|
|
28
27
|
|
|
29
|
-
- [LLMs](content/resources/ai/llms.mdx) — Feed Mercur documentation directly to LLMs for accurate, context-aware assistance.
|
|
30
28
|
- [MCP Server](content/resources/ai/mcp.mdx) — Connect your AI environment to Mercur documentation via Model Context Protocol.
|
|
31
29
|
- [Building with AI](content/resources/ai/overview.mdx) — Mercur ships version-matched docs inside your project so AI coding agents build from accurate APIs instead of stale training data.
|
|
32
|
-
- [
|
|
33
|
-
- [
|
|
34
|
-
- [
|
|
35
|
-
- [
|
|
36
|
-
- [Modules](content/resources/best-practices/
|
|
37
|
-
- [
|
|
38
|
-
- [
|
|
39
|
-
- [
|
|
40
|
-
- [
|
|
30
|
+
- [Skills](content/resources/ai/skills.mdx) — Agent skills for building on Mercur: the bundled-docs contract plus the official Medusa agent skills.
|
|
31
|
+
- [How to Create an API Route](content/resources/best-practices/api-routes.mdx) — Write API routes as thin HTTP adapters that type both sides, validate with Zod, and scope reads through middlewares and queryConfig.
|
|
32
|
+
- [How to Add a Custom Field](content/resources/best-practices/custom-fields.mdx) — Attach extra data to a built-in entity across the full stack: declare it in core, render it in the panels, pull in linked data, and type it end-to-end.
|
|
33
|
+
- [Frontend Patterns](content/resources/best-practices/frontend.mdx) — Build Admin and Vendor panel UI with the shared design system: @medusajs/ui, custom-field extensions, and new pages, with the correct imports.
|
|
34
|
+
- [How to Link Two Modules](content/resources/best-practices/module-links.mdx) — Relate modules without coupling them using defineLink, the link-direction rule, built-in link steps, and cross-link filtering.
|
|
35
|
+
- [How to Create a Custom Module](content/resources/best-practices/modules.mdx) — Keep a module thin: it owns one domain's data and its CRUD, with no orchestration, events, or cross-module calls.
|
|
36
|
+
- [How-to Guides](content/resources/best-practices/overview.mdx) — How to build with Mercur: the layered architecture, the non-negotiable rules, and where each piece of logic belongs.
|
|
37
|
+
- [How to React to Events and Schedule Jobs](content/resources/best-practices/subscribers-and-jobs.mdx) — Run work outside the request cycle: react to events with subscribers, run periodic work with scheduled jobs, and always mutate through workflows.
|
|
38
|
+
- [How to Use Shared Types](content/resources/best-practices/types.mdx) — Type the panels against your own backend extensions by augmenting framework DTOs with declaration merging.
|
|
39
|
+
- [How to Create a Workflow](content/resources/best-practices/workflows.mdx) — Coordinate a business operation across modules as workflow steps, each with automatic rollback, reusing built-in steps and reading through the query engine.
|
|
41
40
|
- [Custom Fields](content/resources/customization/custom-fields.mdx) — Extend any Medusa entity with additional fields without modifying core code.
|
|
42
|
-
- [Extend a
|
|
43
|
-
- [
|
|
44
|
-
- [Medusa Cloud
|
|
45
|
-
- [
|
|
46
|
-
- [
|
|
47
|
-
- [Stripe Connect
|
|
48
|
-
- [
|
|
49
|
-
- [Add a
|
|
50
|
-
- [
|
|
51
|
-
- [
|
|
52
|
-
- [Build
|
|
53
|
-
- [
|
|
54
|
-
- [
|
|
55
|
-
- [
|
|
56
|
-
- [
|
|
57
|
-
- [
|
|
58
|
-
- [
|
|
59
|
-
- [Build your first marketplace](content/resources/tutorials/first-marketplace.mdx) — Go end-to-end: create a project, approve a seller, list a product, place a split order, and watch a payout settle.
|
|
60
|
-
- [Handle product requests](content/resources/tutorials/handle-product-requests.mdx) — Walk a vendor's product submission and a follow-up edit through the operator review pipeline — confirm, decline, or send back.
|
|
61
|
-
- [Import and export products via CSV](content/resources/tutorials/import-export-products.mdx) — Install the product-import-export block and give vendors CSV import and export drawers on their product list.
|
|
62
|
-
- [Work with master products and offers](content/resources/tutorials/master-products-and-offers.mdx) — Two sellers compete on one catalog entry: publish a master product, create competing offers, and read per-offer prices from the Store API.
|
|
63
|
-
- [Set up seller payouts](content/resources/tutorials/seller-payouts-stripe.mdx) — Take a seller from zero to paid: Stripe Connect onboarding, an order through fulfillment, capture, and the automated payout.
|
|
64
|
-
- [Build a store-setup checklist](content/resources/tutorials/store-setup-checklist.mdx) — Render an onboarding progress checklist on the vendor store-setup surface with a seller.setup widget — the seller is handed to you as data, no fetching required.
|
|
65
|
-
|
|
66
|
-
## Tools — CLI, API client, dashboard SDK
|
|
67
|
-
|
|
68
|
-
- [API Client](content/tools/api-client.mdx) — Type-safe client for consuming Mercur APIs.
|
|
69
|
-
- [CLI](content/tools/cli.mdx) — Install blocks, scaffold projects, and generate types from the command line.
|
|
70
|
-
- [Dashboard SDK](content/tools/dashboard-sdk.mdx) — The Vite plugin that powers admin and vendor panel extension — file-based routing, virtual modules, and block resolution.
|
|
41
|
+
- [How to Extend a Workflow](content/resources/customization/extend-a-workflow.mdx) — Inject custom logic into an existing Mercur workflow through hooks, without rewriting it.
|
|
42
|
+
- [How to Extend the Panels](content/resources/customization/extending-panels.mdx) — Add pages, widgets, navigation overrides, and form and table fields to the admin and vendor panels without forking.
|
|
43
|
+
- [Medusa Cloud](content/resources/deployment/medusa-cloud.mdx) — Deploy the Mercur backend, admin panel, and vendor panel on Medusa Cloud.
|
|
44
|
+
- [Self-host Mercur](content/resources/deployment/self-host.mdx) — Deploy a Mercur marketplace to your own infrastructure: the API, the panels, and the databases behind them.
|
|
45
|
+
- [Integrations](content/resources/integrations/overview.mdx) — Extend Mercur with third-party providers and installable blocks.
|
|
46
|
+
- [Stripe Connect](content/resources/integrations/stripe-connect.mdx) — Set up Stripe Connect for marketplace payments and seller payouts, from Stripe Dashboard configuration to the full end-to-end payment lifecycle.
|
|
47
|
+
- [How to Add a Block](content/resources/tutorials/add-a-block.mdx) — Install the reviews block end-to-end and follow it live across the admin, vendor, and storefront surfaces.
|
|
48
|
+
- [How to Add a Widget](content/resources/tutorials/add-a-widget.mdx) — Render your own React component in a named zone on a built-in panel page without forking it.
|
|
49
|
+
- [How to Add an Action Button](content/resources/tutorials/add-order-detail-button.mdx) — Add a Copy link button to the vendor order detail page with a widget, without forking or overriding the page.
|
|
50
|
+
- [How to Create Variant-Axis Attributes](content/resources/tutorials/attributes-and-variant-axes.mdx) — Build an attribute catalog with a filterable attribute, a global variant axis, and an inline product-scoped axis.
|
|
51
|
+
- [How to Build a Block](content/resources/tutorials/build-a-block.mdx) — Author a reusable feature as a block covering backend, panel UI, and docs, then build it into a registry and install it into any Mercur project.
|
|
52
|
+
- [How to Add a Custom API Route](content/resources/tutorials/custom-api-route.mdx) — Add a backend endpoint, regenerate the route map, and call it from a panel page with full type safety.
|
|
53
|
+
- [How to Create a Custom Page](content/resources/tutorials/custom-panel-page.mdx) — Add a page to the vendor portal or admin panel with file-based routing and let the dashboard SDK wire it into the sidebar.
|
|
54
|
+
- [How to Customize Navigation](content/resources/tutorials/customize-navigation.mdx) — Reorder, hide, relabel, and re-parent the panel's built-in sidebar items from a single _navigation.ts file.
|
|
55
|
+
- [How to Extend Forms and Tables](content/resources/tutorials/extend-forms-and-tables.mdx) — Add validated fields, detail-section displays, and list columns to a built-in model from a single file with defineCustomFieldsConfig.
|
|
56
|
+
- [How to Extend Onboarding](content/resources/tutorials/extend-onboarding.mdx) — Add a field to the vendor store-setup surface, carry it through additional_data, and persist it from a workflow hook without forking core.
|
|
57
|
+
- [How to Create Master Products and Offers](content/resources/tutorials/master-products-and-offers.mdx) — Publish one master product, add two competing seller offers, and read per-offer prices from the Store API.
|
|
71
58
|
|
|
72
59
|
## References — modules, HTTP API, configuration
|
|
73
60
|
|
|
74
|
-
- [Admin API](content/references/api/admin.mdx) — Operator routes under /admin/*
|
|
61
|
+
- [Admin API](content/references/api/admin.mdx) — Operator routes under /admin/* for sellers, commissions, payouts, master catalog, and marketplace-wide orders.
|
|
75
62
|
- [Batch Commission Rules](content/references/api/admin/commission-rates/batch-commission-rules.mdx) — Create, update, and delete a commission rate's rules in one request.
|
|
76
63
|
- [Create Commission Rate](content/references/api/admin/commission-rates/create-commission-rate.mdx) — Create a commission rate.
|
|
77
64
|
- [Delete Commission Rate](content/references/api/admin/commission-rates/delete-commission-rate.mdx) — Delete a commission rate.
|
|
@@ -137,8 +124,8 @@ package (`node_modules/@mercurjs/docs/`).
|
|
|
137
124
|
- [Upsert Payment Details](content/references/api/admin/sellers/upsert-payment-details.mdx) — Create or update a seller's bank payment details.
|
|
138
125
|
- [Upsert Professional Details](content/references/api/admin/sellers/upsert-professional-details.mdx) — Create or update a seller's legal and tax details.
|
|
139
126
|
- [Upsert Seller Address](content/references/api/admin/sellers/upsert-seller-address.mdx) — Create or update a seller's address.
|
|
140
|
-
- [API conventions](content/references/api/conventions.mdx) — Authentication, seller scoping, pagination, field selection, and webhooks
|
|
141
|
-
- [Store API](content/references/api/store.mdx) — Storefront routes under /store/*
|
|
127
|
+
- [API conventions](content/references/api/conventions.mdx) — Authentication, seller scoping, pagination, field selection, and webhooks shared by every Mercur API surface.
|
|
128
|
+
- [Store API](content/references/api/store.mdx) — Storefront routes under /store/* for discovery, multi-vendor carts, checkout, and order groups.
|
|
142
129
|
- [Add Line Item](content/references/api/store/carts/add-line-item.mdx) — Add a seller offer to the cart as a line item.
|
|
143
130
|
- [Add Shipping Method](content/references/api/store/carts/add-shipping-methods.mdx) — Add a seller shipping option to the cart.
|
|
144
131
|
- [Apply Promotions](content/references/api/store/carts/apply-promotions.mdx) — Apply promotion codes to the cart.
|
|
@@ -153,11 +140,10 @@ package (`node_modules/@mercurjs/docs/`).
|
|
|
153
140
|
- [Retrieve Product Category](content/references/api/store/product-categories/retrieve-product-category.mdx) — Retrieve an active, public product category by ID.
|
|
154
141
|
- [List Products](content/references/api/store/products/list-products.mdx) — Retrieve published products from visible sellers.
|
|
155
142
|
- [Retrieve Product](content/references/api/store/products/retrieve-product.mdx) — Retrieve a published product by ID.
|
|
156
|
-
- [Search](content/references/api/store/search/search.mdx) — Query the search index across products and offers.
|
|
157
143
|
- [List Sellers](content/references/api/store/sellers/list-sellers.mdx) — Retrieve open sellers visible on the storefront.
|
|
158
144
|
- [Retrieve Seller](content/references/api/store/sellers/retrieve-seller.mdx) — Retrieve an open seller by ID.
|
|
159
145
|
- [List Shipping Options](content/references/api/store/shipping-options/list-shipping-options.mdx) — Retrieve available shipping options for a cart, grouped by seller.
|
|
160
|
-
- [Vendor API](content/references/api/vendor.mdx) — Seller-scoped routes under /vendor/*
|
|
146
|
+
- [Vendor API](content/references/api/vendor.mdx) — Seller-scoped routes under /vendor/* where every request operates on the authenticated member's selected seller.
|
|
161
147
|
- [Accept Member Invite](content/references/api/vendor/members/accept-member-invite.mdx) — Accept a seller team invite using its token.
|
|
162
148
|
- [Retrieve Current Member](content/references/api/vendor/members/retrieve-current-member.mdx) — Retrieve the authenticated member's profile for the active seller.
|
|
163
149
|
- [Update Current Member](content/references/api/vendor/members/update-current-member.mdx) — Update the authenticated member's profile.
|
|
@@ -217,106 +203,154 @@ package (`node_modules/@mercurjs/docs/`).
|
|
|
217
203
|
- [Upsert Professional Details](content/references/api/vendor/sellers/upsert-professional-details.mdx) — Create or update the seller's business registration details.
|
|
218
204
|
- [Upsert Seller Address](content/references/api/vendor/sellers/upsert-seller-address.mdx) — Create or update the seller's address.
|
|
219
205
|
- [Configuration](content/references/configuration.mdx) — withMercur() options, environment variables, and provider configuration.
|
|
220
|
-
- [
|
|
221
|
-
- [
|
|
222
|
-
- [
|
|
223
|
-
- [
|
|
224
|
-
- [
|
|
225
|
-
- [Product Attribute module](content/references/modules/product-attribute.mdx) — Data models, links, and service methods for the Product Attribute module.
|
|
226
|
-
- [Product Edit module](content/references/modules/product-edit.mdx) — Data models and lifecycle for product change requests on master products.
|
|
227
|
-
- [Search module](content/references/modules/search.mdx) — The provider-agnostic search module, its document shapes, and the provider contract.
|
|
228
|
-
- [Seller module](content/references/modules/seller.mdx) — Data models, links, and service methods for the Seller module.
|
|
229
|
-
- [References](content/references/overview.mdx) — Technical references for Mercur's modules, HTTP APIs, workflows, and configuration.
|
|
230
|
-
- [Panel Extension API](content/references/panel-extension-api.mdx) — The file-based helpers for extending the admin and vendor panels — defineWidgetConfig, defineNavigationConfig, defineCustomFieldsConfig, createFormHelper — and the exact props passed to every component you supply.
|
|
231
|
-
- [addSellerShippingMethodToCartWorkflow](content/references/workflows/cart/add-seller-shipping-method-to-cart.mdx) — Add shipping methods to a cart, replacing only the same seller's existing methods.
|
|
232
|
-
- [completeCartWithSplitOrdersWorkflow](content/references/workflows/cart/complete-cart-with-split-orders.mdx) — Complete a multi-seller cart by splitting it into per-seller orders under an order group.
|
|
233
|
-
- [listSellerShippingOptionsForCartWorkflow](content/references/workflows/cart/list-seller-shipping-options-for-cart.mdx) — List available shipping options for a cart, grouped by seller.
|
|
234
|
-
- [updateCartSellerPromotionsWorkflow](content/references/workflows/cart/update-cart-seller-promotions.mdx) — Apply, remove, or replace promotion codes on a cart with seller-scoped adjustments.
|
|
235
|
-
- [batchCommissionRulesWorkflow](content/references/workflows/commission/batch-commission-rules.mdx) — Create, update, and delete a commission rate's rules in one call.
|
|
236
|
-
- [createCommissionRatesWorkflow](content/references/workflows/commission/create-commission-rates.mdx) — Create one or more commission rates.
|
|
237
|
-
- [deleteCommissionRatesWorkflow](content/references/workflows/commission/delete-commission-rates.mdx) — Soft-delete commission rates after validating they can be removed.
|
|
238
|
-
- [refreshOrderCommissionLinesWorkflow](content/references/workflows/commission/refresh-order-commission-lines.mdx) — Recompute the commission lines for one or more orders.
|
|
239
|
-
- [updateCommissionRatesWorkflow](content/references/workflows/commission/update-commission-rates.mdx) — Update one or more commission rates.
|
|
240
|
-
- [setCategoryImagesWorkflow](content/references/workflows/media/set-category-images.mdx) — Replace a category's media gallery and icon, enforcing single thumbnail/banner.
|
|
241
|
-
- [setCollectionImagesWorkflow](content/references/workflows/media/set-collection-images.mdx) — Replace a collection's media gallery and icon, enforcing single thumbnail/banner.
|
|
242
|
-
- [acceptMemberInviteWorkflow](content/references/workflows/member/accept-member-invite.mdx) — Redeem an invite token and join a seller's team.
|
|
243
|
-
- [addSellerMemberWorkflow](content/references/workflows/member/add-seller-member.mdx) — Attach an existing member to a seller with a role.
|
|
244
|
-
- [createMemberInvitesWorkflow](content/references/workflows/member/create-member-invites.mdx) — Create tokenized member invitations for sellers.
|
|
245
|
-
- [deleteMemberInviteWorkflow](content/references/workflows/member/delete-member-invite.mdx) — Delete a pending member invite.
|
|
246
|
-
- [removeSellerMemberWorkflow](content/references/workflows/member/remove-seller-member.mdx) — Remove a member from a seller's team.
|
|
247
|
-
- [resendMemberInviteWorkflow](content/references/workflows/member/resend-member-invite.mdx) — Re-issue a member invite with a fresh token.
|
|
248
|
-
- [updateMemberRoleWorkflow](content/references/workflows/member/update-member-role.mdx) — Change a team member's role.
|
|
249
|
-
- [updateMemberWorkflow](content/references/workflows/member/update-member.mdx) — Update member profile fields matching a selector.
|
|
250
|
-
- [batchOfferInventoryItemsWorkflow](content/references/workflows/offer/batch-offer-inventory-items.mdx) — Create, update, and delete an offer's inventory-item links in one call.
|
|
251
|
-
- [createOffersWorkflow](content/references/workflows/offer/create-offers.mdx) — Create seller offers with inventory items and offer-scoped prices.
|
|
252
|
-
- [deleteOffersWorkflow](content/references/workflows/offer/delete-offers.mdx) — Delete one or more offers.
|
|
253
|
-
- [updateOffersWorkflow](content/references/workflows/offer/update-offers.mdx) — Update offer rows and rewrite their price ladders with replace semantics.
|
|
254
|
-
- [getOrderGroupDetailWorkflow](content/references/workflows/order-group/get-order-group-detail.mdx) — Retrieve one order group with per-order aggregated payment and fulfillment statuses.
|
|
255
|
-
- [getOrderGroupsListWorkflow](content/references/workflows/order-group/get-order-groups-list.mdx) — List order groups with pagination and per-order aggregated statuses.
|
|
256
|
-
- [cancelOrderFulfillmentWorkflow](content/references/workflows/order/cancel-order-fulfillment.mdx) — Cancel an unshipped fulfillment and restore reservations and stock.
|
|
257
|
-
- [confirmClaimRequestWorkflow](content/references/workflows/order/confirm-claim-request.mdx) — Confirm a claim request and fix reservations for offer bundles.
|
|
258
|
-
- [confirmExchangeRequestWorkflow](content/references/workflows/order/confirm-exchange-request.mdx) — Confirm an exchange request and fix reservations for offer bundles.
|
|
259
|
-
- [confirmOrderEditRequestWorkflow](content/references/workflows/order/confirm-order-edit-request.mdx) — Confirm an order edit and reconcile offer-bundle reservations.
|
|
260
|
-
- [confirmReturnReceiveWorkflow](content/references/workflows/order/confirm-return-receive.mdx) — Confirm a return receival, offer-aware restock included.
|
|
261
|
-
- [createOrderFulfillmentWorkflow](content/references/workflows/order/create-order-fulfillment.mdx) — Create a fulfillment for order items, offer-bundle aware.
|
|
262
|
-
- [Workflows](content/references/workflows/overview.mdx) — Every workflow exported by @mercurjs/core, grouped by domain.
|
|
263
|
-
- [createOnboardingWorkflow](content/references/workflows/payout/create-onboarding.mdx) — Start a provider onboarding session for a payout account.
|
|
264
|
-
- [createPayoutAccountWorkflow](content/references/workflows/payout/create-payout-account.mdx) — Create a payout account for a seller through the registered payout provider.
|
|
265
|
-
- [createPayoutWorkflow](content/references/workflows/payout/create-payout.mdx) — Issue a payout to a seller through the registered provider.
|
|
266
|
-
- [processPayoutForWebhookWorkflow](content/references/workflows/payout/process-payout-for-webhook.mdx) — Apply a payout provider webhook event to the matching account or payout.
|
|
267
|
-
- [addProductAttributesToProductWorkflow](content/references/workflows/product-attribute/add-product-attributes-to-product.mdx) — Attach existing or inline attributes (and their values) to a product.
|
|
268
|
-
- [createAndLinkProductAttributesToProductWorkflow](content/references/workflows/product-attribute/create-and-link-product-attributes-to-product.mdx) — Batch attach, detach, and update attribute selections on a product.
|
|
269
|
-
- [createProductAttributeValuesWorkflow](content/references/workflows/product-attribute/create-product-attribute-values.mdx) — Add values to an attribute, mirroring them onto its product option.
|
|
270
|
-
- [createProductAttributesWorkflow](content/references/workflows/product-attribute/create-product-attributes.mdx) — Create catalog attributes with values, mirror options, and category links.
|
|
271
|
-
- [deleteProductAttributeValuesWorkflow](content/references/workflows/product-attribute/delete-product-attribute-values.mdx) — Delete attribute values and shrink the mirror option accordingly.
|
|
272
|
-
- [deleteProductAttributesWorkflow](content/references/workflows/product-attribute/delete-product-attributes.mdx) — Delete attributes and their mirror product options.
|
|
273
|
-
- [removeProductAttributesFromProductWorkflow](content/references/workflows/product-attribute/remove-product-attributes-from-product.mdx) — Detach attributes from a product, deleting product-scoped ones.
|
|
274
|
-
- [updateProductAttributeValuesWorkflow](content/references/workflows/product-attribute/update-product-attribute-values.mdx) — Update attribute values matching a selector and re-sync the mirror option.
|
|
275
|
-
- [updateProductAttributesOnProductWorkflow](content/references/workflows/product-attribute/update-product-attributes-on-product.mdx) — Mutate a product's per-attribute value selections.
|
|
276
|
-
- [updateProductAttributesWorkflow](content/references/workflows/product-attribute/update-product-attributes.mdx) — Update attributes matching a selector and sync mirror option titles.
|
|
277
|
-
- [upsertProductAttributeValuesWorkflow](content/references/workflows/product-attribute/upsert-product-attribute-values.mdx) — Create or update attribute values in one call, keyed by id presence.
|
|
278
|
-
- [autoConfirmProductChangeWorkflow](content/references/workflows/product-edit/auto-confirm-product-change.mdx) — Conditionally confirm a ProductChange based on the product_request feature flag.
|
|
279
|
-
- [cancelProductChangeWorkflow](content/references/workflows/product-edit/cancel-product-change.mdx) — Cancel a pending ProductChange so its staged actions are never applied.
|
|
280
|
-
- [confirmProductChangeWorkflow](content/references/workflows/product-edit/confirm-product-change.mdx) — Confirm pending ProductChanges and apply their staged actions to the master product.
|
|
281
|
-
- [createProductChangeWorkflow](content/references/workflows/product-edit/create-product-change.mdx) — Create ProductChange records after validating no pending change exists per product.
|
|
282
|
-
- [rejectProductChangeWorkflow](content/references/workflows/product-edit/reject-product-change.mdx) — Decline a pending ProductChange with an optional reason for the vendor.
|
|
283
|
-
- [stageProductChangeWorkflow](content/references/workflows/product-edit/stage-product-change.mdx) — Stage a pending ProductChange with its actions and optionally auto-confirm it.
|
|
284
|
-
- [confirmProductsWorkflow](content/references/workflows/product/confirm-products.mdx) — Approve proposed products and publish them to the catalog.
|
|
285
|
-
- [createProductsWorkflow](content/references/workflows/product/create-products.mdx) — Create master catalog products with seller eligibility and creator attribution.
|
|
286
|
-
- [linkSellersToProductCategoryWorkflow](content/references/workflows/product/link-sellers-to-product-category.mdx) — Add or remove seller eligibility links on a product category.
|
|
287
|
-
- [linkSellersToProductWorkflow](content/references/workflows/product/link-sellers-to-product.mdx) — Add or remove seller eligibility links on a master product.
|
|
288
|
-
- [rejectProductWorkflow](content/references/workflows/product/reject-product.mdx) — Reject a proposed product submission with an optional message to the vendor.
|
|
289
|
-
- [requestProductChangeWorkflow](content/references/workflows/product/request-product-change.mdx) — Ask a vendor to revise a proposed product submission without changing its status.
|
|
290
|
-
- [approveSellerWorkflow](content/references/workflows/seller/approve-seller.mdx) — Approve a pending seller and open its store.
|
|
291
|
-
- [createSellerAccountWorkflow](content/references/workflows/seller/create-seller-account.mdx) — Create a seller with its owner member during self-registration.
|
|
292
|
-
- [createSellerDefaultsWorkflow](content/references/workflows/seller/create-seller-defaults.mdx) — Ensure the default seller roles exist.
|
|
293
|
-
- [createSellersWorkflow](content/references/workflows/seller/create-sellers.mdx) — Create one or more sellers and invite their first member.
|
|
294
|
-
- [deleteSellerProfessionalDetailsWorkflow](content/references/workflows/seller/delete-seller-professional-details.mdx) — Remove a seller's professional details.
|
|
295
|
-
- [deleteSellersWorkflow](content/references/workflows/seller/delete-sellers.mdx) — Delete sellers by id.
|
|
296
|
-
- [inviteSellerWorkflow](content/references/workflows/seller/invite-seller.mdx) — Send a marketplace invitation email to a prospective seller.
|
|
297
|
-
- [suspendSellerWorkflow](content/references/workflows/seller/suspend-seller.mdx) — Suspend a seller with an optional reason.
|
|
298
|
-
- [terminateSellerWorkflow](content/references/workflows/seller/terminate-seller.mdx) — Terminate a seller with an optional reason.
|
|
299
|
-
- [unsuspendSellerWorkflow](content/references/workflows/seller/unsuspend-seller.mdx) — Lift a seller suspension.
|
|
300
|
-
- [unterminateSellerWorkflow](content/references/workflows/seller/unterminate-seller.mdx) — Revert a terminated seller back to suspended.
|
|
301
|
-
- [updateSellerAddressWorkflow](content/references/workflows/seller/update-seller-address.mdx) — Upsert a seller's address.
|
|
302
|
-
- [updateSellerPaymentDetailsWorkflow](content/references/workflows/seller/update-seller-payment-details.mdx) — Upsert a seller's bank payment details.
|
|
303
|
-
- [updateSellerProfessionalDetailsWorkflow](content/references/workflows/seller/update-seller-professional-details.mdx) — Upsert a seller's professional (business) details.
|
|
304
|
-
- [updateSellersWorkflow](content/references/workflows/seller/update-sellers.mdx) — Update sellers matching a selector.
|
|
206
|
+
- [Reference](content/references/overview.mdx) — Technical reference for Mercur's HTTP APIs, panel extensions, and configuration.
|
|
207
|
+
- [Create a new page](content/references/panel-extensions/create-page.mdx) — Add a page to the admin or vendor panel with file-based routing, then register it in the sidebar.
|
|
208
|
+
- [Custom Fields](content/references/panel-extensions/custom-fields.mdx) — Add fields, detail rows, section actions, and list columns to a built-in model.
|
|
209
|
+
- [Panel extensions](content/references/panel-extensions/overview.mdx) — Customize the admin and vendor panels with pages, widgets, custom fields, and navigation, without forking them.
|
|
210
|
+
- [Widgets](content/references/panel-extensions/widgets.mdx) — Render a React component in a fixed slot on a built-in admin or vendor page.
|
|
305
211
|
|
|
306
212
|
## User Guide — admin and vendor panels
|
|
307
213
|
|
|
308
|
-
- [
|
|
214
|
+
- [Create a Product Attribute](content/user-guide/admin/attributes/how-tos/create-an-attribute.mdx) — Add a new attribute and choose how it stores its value.
|
|
215
|
+
- [Manage an Attribute's Possible Values](content/user-guide/admin/attributes/how-tos/manage-possible-values.mdx) — Add or reorder the values sellers can choose from for a select attribute.
|
|
216
|
+
- [Product Attributes](content/user-guide/admin/attributes/overview.mdx) — Create the typed attributes sellers use to describe products and customers use to filter them.
|
|
217
|
+
- [Create a Commission Rule](content/user-guide/admin/commissions/how-tos/create-a-commission-rule.mdx) — Override the global commission for a specific store, product type, or category.
|
|
218
|
+
- [Edit the Global Commission](content/user-guide/admin/commissions/how-tos/edit-the-global-commission.mdx) — Change the default fee your marketplace takes on every sale.
|
|
219
|
+
- [Manage a Commission Rule](content/user-guide/admin/commissions/how-tos/manage-a-commission-rule.mdx) — Edit, enable, disable, or delete an existing commission rule.
|
|
220
|
+
- [Commissions](content/user-guide/admin/commissions/overview.mdx) — Set the fee your marketplace takes on each seller's sales.
|
|
221
|
+
- [Admin Panel](content/user-guide/admin/overview.mdx) — What marketplace operators do in the Admin Panel, with no technical knowledge required.
|
|
222
|
+
- [Review a New Product Request](content/user-guide/admin/product-requests/how-tos/review-a-new-product.mdx) — Confirm, request changes to, or reject a product a seller submitted.
|
|
223
|
+
- [Review a Product Update Request](content/user-guide/admin/product-requests/how-tos/review-a-product-edit.mdx) — Approve or reject the changes a seller made to a published product.
|
|
224
|
+
- [Product Requests](content/user-guide/admin/product-requests/overview.mdx) — Review, approve, or reject the products and edits sellers submit.
|
|
309
225
|
- [Stores in Mercur Admin Panel](content/user-guide/admin/stores.mdx)
|
|
310
|
-
- [
|
|
226
|
+
- [Create an Offer](content/user-guide/vendor/offers/how-tos/create-an-offer.mdx) — List one or more catalog products for sale with your SKU, price, and stock.
|
|
227
|
+
- [Update Offer Prices and Stock](content/user-guide/vendor/offers/how-tos/update-prices-and-stock.mdx) — Change an existing offer's prices or inventory without recreating it.
|
|
228
|
+
- [Offers](content/user-guide/vendor/offers/overview.mdx) — List a product for sale with your SKU, price, and stock.
|
|
229
|
+
- [Complete Your Onboarding](content/user-guide/vendor/onboarding.mdx) — Set up your store step by step when you first join the marketplace.
|
|
230
|
+
- [Fulfill an Order](content/user-guide/vendor/orders/how-tos/fulfill-an-order.mdx) — Prepare the items in an order to be sent to the customer.
|
|
231
|
+
- [Mark an Order as Delivered](content/user-guide/vendor/orders/how-tos/mark-an-order-as-delivered.mdx) — Record that the customer has received a shipped order.
|
|
232
|
+
- [Process a Return](content/user-guide/vendor/orders/how-tos/process-a-return.mdx) — Create a return for an order and receive the items back into stock.
|
|
233
|
+
- [Refund an Order](content/user-guide/vendor/orders/how-tos/refund-an-order.mdx) — Return money to the customer for a captured payment.
|
|
234
|
+
- [Ship an Order](content/user-guide/vendor/orders/how-tos/ship-an-order.mdx) — Mark fulfilled items as shipped and add tracking for the customer.
|
|
235
|
+
- [Orders](content/user-guide/vendor/orders/overview.mdx) — Fulfill, ship, refund, and handle returns for the orders you receive.
|
|
236
|
+
- [Vendor Panel](content/user-guide/vendor/overview.mdx) — What sellers do in the Vendor Panel, with no technical knowledge required.
|
|
237
|
+
- [Edit a Product](content/user-guide/vendor/products/how-tos/edit-a-product.mdx) — Change a published product and track the update request.
|
|
238
|
+
- [Submit a Product](content/user-guide/vendor/products/how-tos/submit-a-product.mdx) — Create a new product and send it to the marketplace for approval.
|
|
239
|
+
- [Products](content/user-guide/vendor/products/overview.mdx) — Submit products to the shared marketplace catalog and track their approval.
|
|
311
240
|
- [Store in Mercur Vendor Panel](content/user-guide/vendor/stores.mdx)
|
|
312
241
|
|
|
313
|
-
## Migration
|
|
314
|
-
|
|
315
|
-
- [From 1.x to 2.0](content/migration/from-1-x-to-2-0.mdx) — What changed and how to port your existing Mercur 1.x code to 2.0.
|
|
316
|
-
- [From 2.0 to 2.1](content/migration/from-2-0-to-2-1.mdx) — What changed in Mercur 2.1 and how to upgrade an existing 2.0.x project.
|
|
317
|
-
- [Migration Overview](content/migration/overview.mdx) — Understand what changes between Mercur 1.x and 2.0 and how to migrate your project.
|
|
318
|
-
|
|
319
242
|
## Other
|
|
320
243
|
|
|
321
244
|
- [Official Blocks](content/blocks.mdx) — Modular blocks from the official Mercur registry — install only what you need.
|
|
245
|
+
- [Mercur Documentation](content/home.mdx) — The open-source enterprise marketplace platform built on Medusa.
|
|
246
|
+
- [Attribute types](content/platform/attribute/concepts/attribute-types.mdx) — The five attribute types and the values they hold.
|
|
247
|
+
- [Global vs inline & filtering](content/platform/attribute/concepts/global-vs-inline.mdx) — Catalog-wide attributes, product-scoped attributes, and storefront filtering.
|
|
248
|
+
- [Variant axes](content/platform/attribute/concepts/variant-axes.mdx) — How is_variant_axis mirrors a native ProductOption and generates variants.
|
|
249
|
+
- [Attach attributes to a product](content/platform/attribute/guides/attach-attributes-to-a-product.mdx) — Attach, detach, and update a product's attributes in one batch call.
|
|
250
|
+
- [Create a variant axis](content/platform/attribute/guides/create-a-variant-axis.mdx) — Generate product variants from a multi_select axis attribute.
|
|
251
|
+
- [Create an attribute](content/platform/attribute/guides/create-an-attribute.mdx) — Create a typed catalog attribute with createProductAttributesWorkflow.
|
|
252
|
+
- [Attribute](content/platform/attribute/overview.mdx) — An operator-managed, typed attribute catalog for describing and filtering the shared product catalog.
|
|
253
|
+
- [Data models](content/platform/attribute/reference/data-models.mdx) — The data models owned by the Attribute (Product Attribute) domain.
|
|
254
|
+
- [Event reference](content/platform/attribute/reference/events.mdx) — Events emitted by the Attribute domain, for subscribers and side effects.
|
|
255
|
+
- [Links to other modules](content/platform/attribute/reference/links.mdx) — How the Attribute (Product Attribute) domain links to products, categories, and options.
|
|
256
|
+
- [Service reference](content/platform/attribute/reference/service.mdx) — The Product Attribute module service, with methods for working with records directly.
|
|
257
|
+
- [Workflows](content/platform/attribute/reference/workflows.mdx) — Attribute catalog and product-attachment workflows.
|
|
258
|
+
- [Master products](content/platform/catalog/concepts/master-products.mdx) — The shared catalog, why products aren't seller-owned, and submission attribution.
|
|
259
|
+
- [The store allowlist](content/platform/catalog/concepts/product-seller-allowlist.mdx) — The product_seller link that controls which stores may sell a master product.
|
|
260
|
+
- [Status lifecycle](content/platform/catalog/concepts/status-lifecycle.mdx) — How a master product moves from draft to proposed, published, or rejected.
|
|
261
|
+
- [Variants, categories & collections](content/platform/catalog/concepts/variants-categories-collections.mdx) — The native Medusa Product structure the shared catalog is built on.
|
|
262
|
+
- [Allowlist stores](content/platform/catalog/guides/allowlist-stores.mdx) — Grant and revoke a store's right to sell a master product from server code.
|
|
263
|
+
- [Create a master product](content/platform/catalog/guides/create-a-master-product.mdx) — Create a master product programmatically with createProductsWorkflow.
|
|
264
|
+
- [Publish or reject a product](content/platform/catalog/guides/publish-or-reject-a-product.mdx) — Move a proposed master product to published or rejected from server code.
|
|
265
|
+
- [Catalog](content/platform/catalog/overview.mdx) — Master products, variants, categories, and the store allowlist that governs who may sell what.
|
|
266
|
+
- [Data models](content/platform/catalog/reference/data-models.mdx) — The Medusa Product models the catalog is built on, plus Mercur's marketplace layer.
|
|
267
|
+
- [Event reference](content/platform/catalog/reference/events.mdx) — Events emitted by the Catalog domain, for subscribers and side effects.
|
|
268
|
+
- [Links to other modules](content/platform/catalog/reference/links.mdx) — How the catalog links to sellers, offers, attributes, and media.
|
|
269
|
+
- [Service reference](content/platform/catalog/reference/service.mdx) — Medusa's Product module service: methods for working with records directly.
|
|
270
|
+
- [Workflows](content/platform/catalog/reference/workflows.mdx) — Mercur's product create, review, and allowlist workflows.
|
|
271
|
+
- [Order commission lines](content/platform/commission/concepts/order-commission-lines.mdx) — Per-order commission lines, how they're computed, and BigNumber precision.
|
|
272
|
+
- [Rule matching](content/platform/commission/concepts/rule-matching.mdx) — The five dimensions, most-specific-wins resolution, tie-breaks, and shipping.
|
|
273
|
+
- [Rules & rates](content/platform/commission/concepts/rules-and-rates.mdx) — The commission rate, its fixed and percentage forms, and per-currency amounts.
|
|
274
|
+
- [Batch-update commission rules](content/platform/commission/guides/batch-update-rules.mdx) — Create, update, and delete a rate's rules in a single call.
|
|
275
|
+
- [Create a commission rate](content/platform/commission/guides/create-a-rate.mdx) — Create a commission rate programmatically with createCommissionRatesWorkflow.
|
|
276
|
+
- [Refresh order commission lines](content/platform/commission/guides/refresh-order-commission-lines.mdx) — Recompute an order's commission lines after it changes.
|
|
277
|
+
- [Commission](content/platform/commission/overview.mdx) — Configure how the marketplace takes its cut of every seller order.
|
|
278
|
+
- [Data models](content/platform/commission/reference/data-models.mdx) — The data models owned by the Commission domain.
|
|
279
|
+
- [Event reference](content/platform/commission/reference/events.mdx) — How the Commission domain stays in sync with order changes.
|
|
280
|
+
- [Links to other modules](content/platform/commission/reference/links.mdx) — How the Commission domain connects to the catalog, sellers, and orders.
|
|
281
|
+
- [Service reference](content/platform/commission/reference/service.mdx) — The Commission module service and its methods for working with records directly.
|
|
282
|
+
- [Workflows](content/platform/commission/reference/workflows.mdx) — Commission rate, rule, and order-line workflows.
|
|
283
|
+
- [Pricing & inventory](content/platform/offer/concepts/pricing-and-inventory.mdx) — Offer-scoped prices on the shared price set, and inventory linked to the offer.
|
|
284
|
+
- [Shipping](content/platform/offer/concepts/shipping.mdx) — How an offer carries its own shipping profile.
|
|
285
|
+
- [What is an offer](content/platform/offer/concepts/what-is-an-offer.mdx) — The offer record, how it points at a master product variant, and its SKU.
|
|
286
|
+
- [Bulk-create offers](content/platform/offer/guides/bulk-create-offers.mdx) — List many offers against the master catalog in a single workflow run.
|
|
287
|
+
- [Create an offer](content/platform/offer/guides/create-an-offer.mdx) — Create a single offer programmatically with createOffersWorkflow.
|
|
288
|
+
- [Manage offer inventory](content/platform/offer/guides/manage-offer-inventory.mdx) — Attach, update, and detach inventory items on an existing offer.
|
|
289
|
+
- [Offer](content/platform/offer/overview.mdx) — How a store sells against the shared master catalog, with its own SKU, price, inventory, and shipping.
|
|
290
|
+
- [Data models](content/platform/offer/reference/data-models.mdx) — The data models owned by the Offer domain.
|
|
291
|
+
- [Event reference](content/platform/offer/reference/events.mdx) — Events emitted by the Offer domain, for subscribers and side effects.
|
|
292
|
+
- [Links to other modules](content/platform/offer/reference/links.mdx) — How the Offer domain links to other modules across the marketplace.
|
|
293
|
+
- [Service reference](content/platform/offer/reference/service.mdx) — The Offer module service and its methods for working with records directly.
|
|
294
|
+
- [Workflows](content/platform/offer/reference/workflows.mdx) — Offer workflows for creating, updating, deleting, and batching inventory.
|
|
295
|
+
- [Computed totals](content/platform/order-group/concepts/computed-totals.mdx) — Why an order group's seller count and total are derived at query time, not stored.
|
|
296
|
+
- [Order splitting](content/platform/order-group/concepts/order-splitting.mdx) — How a multi-seller cart becomes a group of independent per-seller orders.
|
|
297
|
+
- [The order group](content/platform/order-group/concepts/the-order-group.mdx) — The aggregate record over a multi-seller purchase, its display id, and cart link.
|
|
298
|
+
- [List order groups](content/platform/order-group/guides/list-order-groups.mdx) — Page through order groups and scope them to a seller with getOrderGroupsListWorkflow.
|
|
299
|
+
- [Retrieve an order group](content/platform/order-group/guides/retrieve-an-order-group.mdx) — Load an order group and its aggregated child orders with getOrderGroupDetailWorkflow.
|
|
300
|
+
- [Split a cart into orders](content/platform/order-group/guides/split-a-cart.mdx) — Complete a multi-seller cart into a group of per-seller orders with completeCartWithSplitOrdersWorkflow.
|
|
301
|
+
- [Order Group](content/platform/order-group/overview.mdx) — Wrap a multi-seller cart into one shopper-facing order made of independent per-seller orders.
|
|
302
|
+
- [Data models](content/platform/order-group/reference/data-models.mdx) — The data model owned by the Order Group domain.
|
|
303
|
+
- [Event reference](content/platform/order-group/reference/events.mdx) — Events emitted by the Order Group domain, for subscribers and side effects.
|
|
304
|
+
- [Links to other modules](content/platform/order-group/reference/links.mdx) — How the Order Group domain links to carts, orders, sellers, and offers.
|
|
305
|
+
- [Service reference](content/platform/order-group/reference/service.mdx) — The Seller module service and its methods for working with order group records directly.
|
|
306
|
+
- [Workflows](content/platform/order-group/reference/workflows.mdx) — Order group workflows, service methods, and events.
|
|
307
|
+
- [Account lifecycle](content/platform/payout/concepts/account-lifecycle.mdx) — Payout account statuses and the webhook-driven transitions between them.
|
|
308
|
+
- [Accounts & onboarding](content/platform/payout/concepts/accounts-and-onboarding.mdx) — The payout account, its onboarding record, and provider-specific data.
|
|
309
|
+
- [The payout pipeline](content/platform/payout/concepts/payout-pipeline.mdx) — Capture check, payment capture, daily payout, transfer, and the provider interface.
|
|
310
|
+
- [Create a payout account](content/platform/payout/guides/create-a-payout-account.mdx) — Create a seller's payout account with createPayoutAccountWorkflow.
|
|
311
|
+
- [Process a provider webhook](content/platform/payout/guides/process-a-provider-webhook.mdx) — Turn a provider webhook into account and payout status updates.
|
|
312
|
+
- [Start provider onboarding](content/platform/payout/guides/start-provider-onboarding.mdx) — Kick off provider onboarding with createOnboardingWorkflow.
|
|
313
|
+
- [Payout](content/platform/payout/overview.mdx) — Onboard sellers to a payment provider and settle their earnings automatically.
|
|
314
|
+
- [Data models](content/platform/payout/reference/data-models.mdx) — The data models owned by the Payout domain.
|
|
315
|
+
- [Event reference](content/platform/payout/reference/events.mdx) — Events that drive the payout pipeline, for subscribers and side effects.
|
|
316
|
+
- [Links to other modules](content/platform/payout/reference/links.mdx) — How the Payout domain links to sellers and orders across the marketplace.
|
|
317
|
+
- [Service reference](content/platform/payout/reference/service.mdx) — The Payout module service: methods for working with records directly.
|
|
318
|
+
- [Workflows](content/platform/payout/reference/workflows.mdx) — Payout account, onboarding, payout, and webhook workflows.
|
|
319
|
+
- [Change actions](content/platform/product-edit/concepts/change-actions.mdx) — The typed actions that make up a change and the details they carry.
|
|
320
|
+
- [The change pipeline](content/platform/product-edit/concepts/change-pipeline.mdx) — The ProductChange record, its immutability, and the audit trail.
|
|
321
|
+
- [Status & auto-confirm](content/platform/product-edit/concepts/status-and-auto-confirm.mdx) — The change status lifecycle, revision requests, and auto-confirm.
|
|
322
|
+
- [Confirm or decline a change](content/platform/product-edit/guides/confirm-or-decline-a-change.mdx) — Resolve a pending product change from server code.
|
|
323
|
+
- [Edit a product](content/platform/product-edit/guides/edit-a-product.mdx) — Stage a product change from server code with the edit workflows.
|
|
324
|
+
- [Request a revision](content/platform/product-edit/guides/request-a-revision.mdx) — Send a product submission back to the vendor from server code.
|
|
325
|
+
- [Product Edit](content/platform/product-edit/overview.mdx) — Route every product edit through a reviewable, immutable change pipeline.
|
|
326
|
+
- [Data models](content/platform/product-edit/reference/data-models.mdx) — The data models owned by the Product Edit domain.
|
|
327
|
+
- [Event reference](content/platform/product-edit/reference/events.mdx) — Events emitted by the Product Edit domain, for subscribers and side effects.
|
|
328
|
+
- [Links to other modules](content/platform/product-edit/reference/links.mdx) — How the Product Edit domain links to other modules across the marketplace.
|
|
329
|
+
- [Service reference](content/platform/product-edit/reference/service.mdx) — The Product Edit module service methods for working with records directly.
|
|
330
|
+
- [Workflows](content/platform/product-edit/reference/workflows.mdx) — Product change workflows, service methods, and events.
|
|
331
|
+
- [Product vs seller reviews](content/platform/review/concepts/product-vs-seller-reviews.mdx) — The reference discriminator and the links that anchor each review.
|
|
332
|
+
- [Ratings & moderation](content/platform/review/concepts/ratings-and-moderation.mdx) — The review status lifecycle, store responses, and aggregate ratings.
|
|
333
|
+
- [The review model](content/platform/review/concepts/the-review-model.mdx) — The single review entity, its rating, notes, and moderation status.
|
|
334
|
+
- [Compute aggregate ratings](content/platform/review/guides/compute-aggregate-ratings.mdx) — Compute average ratings for products and sellers from server code.
|
|
335
|
+
- [Create a review](content/platform/review/guides/create-a-review.mdx) — Create a review programmatically with createReviewWorkflow.
|
|
336
|
+
- [Moderate a review](content/platform/review/guides/moderate-a-review.mdx) — Publish, reject, and delete reviews from server code.
|
|
337
|
+
- [Respond to a review](content/platform/review/guides/respond-to-a-review.mdx) — Attach a store's public response with respondReviewWorkflow.
|
|
338
|
+
- [Review](content/platform/review/overview.mdx) — Collect, moderate, and surface customer ratings for products and sellers.
|
|
339
|
+
- [Data models](content/platform/review/reference/data-models.mdx) — The data models owned by the Review domain.
|
|
340
|
+
- [Event reference](content/platform/review/reference/events.mdx) — Running side effects as reviews are created, moderated, and answered.
|
|
341
|
+
- [Links to other modules](content/platform/review/reference/links.mdx) — How the Review domain links to products, sellers, orders, and customers.
|
|
342
|
+
- [Service reference](content/platform/review/reference/service.mdx) — The Review module service: CRUD methods and aggregate-rating helpers.
|
|
343
|
+
- [Workflows](content/platform/review/reference/workflows.mdx) — Review workflows for creating, moderating, responding, and deleting.
|
|
344
|
+
- [Lifecycle](content/platform/store/concepts/lifecycle.mdx) — Store statuses, transitions, scheduled closures, and premium.
|
|
345
|
+
- [The store entity](content/platform/store/concepts/store-entity.mdx) — The seller record, its business identity, and its satellite data.
|
|
346
|
+
- [Team & members](content/platform/store/concepts/team.mdx) — Members, roles, invites, and the many-to-many store relationship.
|
|
347
|
+
- [Create a store](content/platform/store/guides/create-a-store.mdx) — Create a seller programmatically with createSellersWorkflow.
|
|
348
|
+
- [Manage the team](content/platform/store/guides/manage-the-team.mdx) — Invite and add store members from server code.
|
|
349
|
+
- [Moderate stores](content/platform/store/guides/moderate-a-store.mdx) — Approve, suspend, and terminate stores from server code.
|
|
350
|
+
- [Store](content/platform/store/overview.mdx) — Manage sellers, their teams, and their lifecycle on the marketplace.
|
|
351
|
+
- [Data models](content/platform/store/reference/data-models.mdx) — The data models owned by the Store (Seller) domain.
|
|
352
|
+
- [Event reference](content/platform/store/reference/events.mdx) — Events emitted by the Store domain, for subscribers and side effects.
|
|
353
|
+
- [Links to other modules](content/platform/store/reference/links.mdx) — How the Store (Seller) domain links to other modules across the marketplace.
|
|
354
|
+
- [Service reference](content/platform/store/reference/service.mdx) — The Seller module service and its methods for working with records directly.
|
|
355
|
+
- [Workflows](content/platform/store/reference/workflows.mdx) — Seller and member workflows, service methods, and events.
|
|
322
356
|
- [Telemetry](content/telemetry.mdx) — Learn about the anonymous usage data collected by the Mercur CLI
|
package/package.json
CHANGED
|
@@ -1,84 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: "Concepts"
|
|
3
|
-
description: "Core concepts behind Mercur — from the Medusa foundation to blocks, panels, and the registry."
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
Mercur is built on a small set of concepts. Familiarity with these establishes a common language when working with the platform.
|
|
7
|
-
|
|
8
|
-
## Medusa
|
|
9
|
-
|
|
10
|
-
[MedusaJS](https://medusajs.com) is the open-source commerce framework that powers Mercur's foundation. It handles products, pricing, carts, orders, payments, fulfillment, and promotions. Mercur does not replace any of this — it extends Medusa with marketplace-specific logic using Medusa's own extension model.
|
|
11
|
-
|
|
12
|
-
## Admin Panel
|
|
13
|
-
|
|
14
|
-
The admin panel is a React application for **marketplace operators**. It provides a dashboard to manage sellers, configure commission rates, moderate product requests, handle disputes, and monitor the overall marketplace. It is built with [Medusa UI](https://docs.medusajs.com/ui) components and can be extended with custom pages and components through the [Dashboard SDK](#dashboard-sdk).
|
|
15
|
-
|
|
16
|
-
## Vendor Portal
|
|
17
|
-
|
|
18
|
-
The vendor portal is a React application for **sellers**. Sellers use it to manage their products, process orders, configure shipping, track payouts, and handle returns. Like the admin panel, it is built on the Dashboard SDK and can be fully customized.
|
|
19
|
-
|
|
20
|
-
## Storefront
|
|
21
|
-
|
|
22
|
-
The storefront is the **customer-facing** application. It can be built with any frontend technology that consumes the Store API — Next.js, Remix, or any other framework. Mercur provides a ready-made storefront template to start from.
|
|
23
|
-
|
|
24
|
-
## API Routes
|
|
25
|
-
|
|
26
|
-
Mercur exposes three sets of HTTP endpoints:
|
|
27
|
-
|
|
28
|
-
- **Admin API** (`/admin/*`) — Platform administration
|
|
29
|
-
- **Vendor API** (`/vendor/*`) — Seller operations
|
|
30
|
-
- **Store API** (`/store/*`) — Customer-facing storefront
|
|
31
|
-
|
|
32
|
-
Each route is composed of a handler, middleware, query configuration, and validators.
|
|
33
|
-
|
|
34
|
-
## Core Plugin
|
|
35
|
-
|
|
36
|
-
The core plugin (`@mercurjs/core`) is the main package that contains all of Mercur's marketplace logic — modules, links, workflows, API routes, subscribers, and providers. It is installed as a standard MedusaJS plugin and serves as the foundation that blocks extend.
|
|
37
|
-
|
|
38
|
-
## Modules
|
|
39
|
-
|
|
40
|
-
Modules encapsulate data models and business logic for a specific domain. Each module is self-contained with its own models, service, and migrations. Mercur's marketplace modules include Seller, Commission, Offer, Payout, Product Attribute, Product Edit, Media, Custom Fields, and Search. They communicate through [Links](#links) and [Workflows](#workflows), never directly. Additional domains — such as Reviews — ship as installable [blocks](#blocks) from the registry rather than inside the core plugin.
|
|
41
|
-
|
|
42
|
-
## Master Products
|
|
43
|
-
|
|
44
|
-
Products form a single **shared catalog** for the whole marketplace — a product is not owned by the seller who created it. Sellers gain the right to sell a product through eligibility assignments and sell it through [offers](#offers). See [Products](/rc/learn/products).
|
|
45
|
-
|
|
46
|
-
## Offers
|
|
47
|
-
|
|
48
|
-
An offer is a seller's sellable listing against a master product: their own SKU, price, inventory, and shipping profile. Many sellers can hold competing offers on the same product. See [Offers](/rc/learn/offers).
|
|
49
|
-
|
|
50
|
-
## Product Attributes
|
|
51
|
-
|
|
52
|
-
A typed, operator-managed attribute catalog (select, text, unit, toggle) that products reference for structured data and storefront filtering. Variant-axis attributes are backed by Medusa's native global product options. See [Product Attributes](/rc/learn/attributes).
|
|
53
|
-
|
|
54
|
-
## Product Requests
|
|
55
|
-
|
|
56
|
-
Vendor product submissions and edits flow through a reviewable change-request pipeline — the operator confirms, declines, or requests revisions before anything touches the shared catalog. See [Product Requests & Approvals](/rc/learn/product-requests).
|
|
57
|
-
|
|
58
|
-
## Links
|
|
59
|
-
|
|
60
|
-
Links define relationships between Mercur modules and Medusa core entities without modifying either side. For example, a link connects a Medusa Product to a Mercur Seller — this is how the system knows which sellers are eligible to sell which products.
|
|
61
|
-
|
|
62
|
-
## Workflows
|
|
63
|
-
|
|
64
|
-
Workflows coordinate multi-step operations across modules. They support compensation (automatic rollback on failure) and hooks (extension points for custom logic). For example, the checkout workflow splits a cart by seller, creates separate orders, allocates payments, and calculates commissions — all as a single atomic operation.
|
|
65
|
-
|
|
66
|
-
## Blocks
|
|
67
|
-
|
|
68
|
-
Blocks are the unit of distribution in Mercur. Each block is a self-contained piece of functionality — a module, a workflow, an API route, a link, or a UI extension. When you install a block, the CLI copies its source code directly into your project. You own every line and can modify anything.
|
|
69
|
-
|
|
70
|
-
## Registry
|
|
71
|
-
|
|
72
|
-
A registry is a collection of blocks available for installation. The official Mercur registry (`@mercurjs`) provides all marketplace blocks. You can also create and host [custom registries](/rc/tools/cli#custom-registries) for your own blocks.
|
|
73
|
-
|
|
74
|
-
## CLI
|
|
75
|
-
|
|
76
|
-
The [Mercur CLI](/rc/tools/cli) (`@mercurjs/cli@latest`) manages your project — scaffolding from templates, installing blocks, searching registries, generating types, and diffing local changes against upstream versions.
|
|
77
|
-
|
|
78
|
-
## Dashboard SDK
|
|
79
|
-
|
|
80
|
-
The [Dashboard SDK](/rc/tools/dashboard-sdk) (`@mercurjs/dashboard-sdk`) is a Vite plugin shared by the admin panel and vendor portal. It provides file-based routing, automatic navigation generation, widget and custom-field extensions, and i18n support.
|
|
81
|
-
|
|
82
|
-
## API Client
|
|
83
|
-
|
|
84
|
-
The [API Client](/rc/tools/api-client) (`@mercurjs/client`) provides type-safe access to all Mercur API endpoints. Types are generated from your actual API routes using `bunx @mercurjs/cli@latest codegen`, so requests and responses are always in sync with your backend.
|