Skip to main content
This section is the technical contract of the Mercur core plugin. Where the Learn tab explains concepts, these pages document the exact surface: data models and their fields, module links, service methods, HTTP routes, workflow names, and configuration options.

Modules

Every marketplace capability ships as a Medusa module inside @mercurjs/core. Each reference covers the module’s data models, enums, links to Medusa core entities, service methods, and options.

Seller

Sellers, members, invites, and order groups.

Commission

Commission rates, rules, and per-order commission lines.

Payout

Payout accounts, onboarding, payouts, and the provider interface.

Offer

Per-seller listings binding a variant to SKU, price, and inventory.

Product Attribute

Configurable attributes, values, and variant axes on native product options.

Product Edit

Product change requests and the approval queue.

Media

Image galleries, thumbnails, banners, and icons for categories and collections.

Search

Provider-agnostic search with the built-in Orama provider.

Custom Fields

Extra columns on any entity without a custom module.

HTTP API

Mercur extends the Medusa server with three route surfaces. Start with the conventions page — authentication, seller scoping, and pagination work the same way across all of them.

API conventions

Authentication, seller scoping, pagination, field selection, and webhooks.

Admin API

Operator routes under /admin/*.

Vendor API

Seller-scoped routes under /vendor/*.

Store API

Storefront routes under /store/*.

Workflows and configuration

Workflows

Every workflow exported by @mercurjs/core, grouped by domain.

Configuration

withMercur(), environment variables, and provider options.