Skip to main content
This section is the technical contract of the Mercur core plugin. The Learn tab explains concepts and the Platform tab documents each domain’s data models, workflows, service, and events. These pages cover the HTTP APIs, the panel extension helpers, and configuration.

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/*.

Panel extensions

File-based helpers for extending the Admin and Vendor panels without forking.

Overview

Typed targets, persistence, and how the helpers fit together.

Widgets

defineWidgetConfig: zones, config, and component props.

Custom Fields

defineCustomFieldsConfig: forms, displays, and list columns.

Create a new page

defineNavigationConfig and createFormHelper.

Configuration

Configuration

withMercur(), environment variables, and provider options.

Platform modules

Data models, workflows, service, and events for each domain.