@mercurjs/docs 2.2.1 → 2.3.0-canary.1

package/content/references/workflows/seller/create-sellers.mdx

@@ -1,65 +0,0 @@
----
-title: "createSellersWorkflow"
-description: "Create one or more sellers and invite their first member."
----
-
-Creates sellers (defaulting `status` to `pending_approval`), then runs `createMemberInvitesWorkflow` to invite each seller's initial member with the seller administration role. Triggered by `POST /admin/sellers`. Emits `seller.created` and `member_invite.created`.
-
-## Usage
-
-```ts
-import { createSellersWorkflow } from "@mercurjs/core/workflows"
-
-const { result } = await createSellersWorkflow(container).run({
-  input: {
-    sellers: [
-      {
-        name: "Acme",
-        email: "hello@acme.co",
-        currency_code: "usd",
-        member: { email: "owner@acme.co" },
-      },
-    ],
-  },
-})
-```
-
-## Input
-
-<ParamField body="sellers" type="object[]" required>
-  Sellers to create.
-  <Expandable title="properties">
-    <ParamField body="name" type="string" required>Display name of the seller.</ParamField>
-    <ParamField body="email" type="string" required>Contact email of the seller.</ParamField>
-    <ParamField body="currency_code" type="string" required>Default currency of the seller.</ParamField>
-    <ParamField body="member" type="object" required>Initial member to invite; `{ email: string }`.</ParamField>
-    <ParamField body="handle" type="string">URL handle; auto-generated from the name when omitted.</ParamField>
-    <ParamField body="description" type="string">Public seller description.</ParamField>
-    <ParamField body="logo" type="string">Logo URL.</ParamField>
-    <ParamField body="banner" type="string">Banner URL.</ParamField>
-    <ParamField body="website_url" type="string">Seller website URL.</ParamField>
-    <ParamField body="external_id" type="string">External system identifier.</ParamField>
-    <ParamField body="status" type="string">One of `open`, `pending_approval`, `suspended`, `terminated`; defaults to `pending_approval`.</ParamField>
-    <ParamField body="status_reason" type="string">Reason attached to the current status.</ParamField>
-    <ParamField body="is_premium" type="boolean">Marks the seller as premium.</ParamField>
-    <ParamField body="closed_from" type="Date">Start of a store closure window.</ParamField>
-    <ParamField body="closed_to" type="Date">End of a store closure window.</ParamField>
-    <ParamField body="metadata" type="object">Custom key-value data.</ParamField>
-  </Expandable>
-</ParamField>
-<ParamField body="additional_data" type="object">Custom data passed through to the workflow hooks.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="SellerDTO[]">The created sellers.</ResponseField>
-
-## Hooks
-
-- `validate` — runs before creation with `{ input }`.
-- `sellersCreated` — runs after creation with `{ sellers, additional_data }`.
-
-```ts
-createSellersWorkflow.hooks.sellersCreated(async ({ sellers, additional_data }) => {
-  // react to new sellers
-})
-```

package/content/references/workflows/seller/delete-seller-professional-details.mdx

@@ -1,37 +0,0 @@
----
-title: "deleteSellerProfessionalDetailsWorkflow"
-description: "Remove a seller's professional details."
----
-
-Deletes the professional details record attached to a seller.
-
-## Usage
-
-```ts
-import { deleteSellerProfessionalDetailsWorkflow } from "@mercurjs/core/workflows"
-
-await deleteSellerProfessionalDetailsWorkflow(container).run({
-  input: { seller_id: "sel_123" },
-})
-```
-
-## Input
-
-<ParamField body="seller_id" type="string" required>Id of the seller whose professional details are removed.</ParamField>
-<ParamField body="additional_data" type="object">Custom data passed through to the workflow hooks.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="void">Nothing is returned.</ResponseField>
-
-## Hooks
-
-- `professionalDetailsDeleted` — runs after deletion with `{ seller_id, additional_data }`.
-
-```ts
-deleteSellerProfessionalDetailsWorkflow.hooks.professionalDetailsDeleted(
-  async ({ seller_id }) => {
-    // e.g. flag the seller for re-verification
-  }
-)
-```

package/content/references/workflows/seller/delete-sellers.mdx

@@ -1,24 +0,0 @@
----
-title: "deleteSellersWorkflow"
-description: "Delete sellers by id."
----
-
-Soft-deletes the given sellers. Emits `seller.deleted` for each id.
-
-## Usage
-
-```ts
-import { deleteSellersWorkflow } from "@mercurjs/core/workflows"
-
-await deleteSellersWorkflow(container).run({
-  input: { ids: ["sel_123"] },
-})
-```
-
-## Input
-
-<ParamField body="ids" type="string[]" required>Ids of the sellers to delete.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="void">Nothing is returned.</ResponseField>

package/content/references/workflows/seller/invite-seller.mdx

@@ -1,28 +0,0 @@
----
-title: "inviteSellerWorkflow"
-description: "Send a marketplace invitation email to a prospective seller."
----
-
-Sends an invitation email (via the notification module, `email` channel) inviting someone to register as a seller, optionally with a registration link. Not wired to a core API route — run it from your own routes or automations. Does not create any seller records.
-
-## Usage
-
-```ts
-import { inviteSellerWorkflow } from "@mercurjs/core/workflows"
-
-const { result } = await inviteSellerWorkflow(container).run({
-  input: {
-    email: "owner@acme.co",
-    registration_url: "https://vendor.example.com/register",
-  },
-})
-```
-
-## Input
-
-<ParamField body="email" type="string" required>Recipient of the invitation email.</ParamField>
-<ParamField body="registration_url" type="string">Link rendered as the email's call-to-action button.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="NotificationDTO">The created email notification.</ResponseField>

package/content/references/workflows/seller/suspend-seller.mdx

@@ -1,37 +0,0 @@
----
-title: "suspendSellerWorkflow"
-description: "Suspend a seller with an optional reason."
----
-
-Validates the seller can be suspended, sets `status` to `suspended`, records the reason, and stamps `rejected_at` on first suspension. Triggered by `POST /admin/sellers/:id/suspend`. Emits `seller.suspended`.
-
-## Usage
-
-```ts
-import { suspendSellerWorkflow } from "@mercurjs/core/workflows"
-
-await suspendSellerWorkflow(container).run({
-  input: { seller_id: "sel_123", reason: "Policy violation" },
-})
-```
-
-## Input
-
-<ParamField body="seller_id" type="string" required>Id of the seller to suspend.</ParamField>
-<ParamField body="reason" type="string">Reason stored in `status_reason`.</ParamField>
-
-<ParamField body="additional_data" type="object">Custom data passed through to the workflow hooks.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="void">Nothing is returned.</ResponseField>
-
-## Hooks
-
-- `sellerSuspended` — runs after suspension with `{ seller_id }`.
-
-```ts
-suspendSellerWorkflow.hooks.sellerSuspended(async ({ seller_id }) => {
-  // e.g. pause the seller's listings
-})
-```

package/content/references/workflows/seller/terminate-seller.mdx

@@ -1,37 +0,0 @@
----
-title: "terminateSellerWorkflow"
-description: "Terminate a seller with an optional reason."
----
-
-Validates the seller can be terminated, then sets `status` to `terminated` and records the reason. Emits `seller.terminated`.
-
-## Usage
-
-```ts
-import { terminateSellerWorkflow } from "@mercurjs/core/workflows"
-
-await terminateSellerWorkflow(container).run({
-  input: { seller_id: "sel_123", reason: "Account closure requested" },
-})
-```
-
-## Input
-
-<ParamField body="seller_id" type="string" required>Id of the seller to terminate.</ParamField>
-<ParamField body="reason" type="string">Reason stored in `status_reason`.</ParamField>
-
-<ParamField body="additional_data" type="object">Custom data passed through to the workflow hooks.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="void">Nothing is returned.</ResponseField>
-
-## Hooks
-
-- `sellerTerminated` — runs after termination with `{ seller_id }`.
-
-```ts
-terminateSellerWorkflow.hooks.sellerTerminated(async ({ seller_id }) => {
-  // e.g. archive the seller's data
-})
-```

package/content/references/workflows/seller/unsuspend-seller.mdx

@@ -1,36 +0,0 @@
----
-title: "unsuspendSellerWorkflow"
-description: "Lift a seller suspension."
----
-
-Validates the seller is currently suspended, then sets `status` back to `open` and clears `status_reason`. Triggered by `POST /admin/sellers/:id/unsuspend`. Emits `seller.unsuspended`.
-
-## Usage
-
-```ts
-import { unsuspendSellerWorkflow } from "@mercurjs/core/workflows"
-
-await unsuspendSellerWorkflow(container).run({
-  input: { seller_id: "sel_123" },
-})
-```
-
-## Input
-
-<ParamField body="seller_id" type="string" required>Id of the suspended seller.</ParamField>
-
-<ParamField body="additional_data" type="object">Custom data passed through to the workflow hooks.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="void">Nothing is returned.</ResponseField>
-
-## Hooks
-
-- `sellerUnsuspended` — runs after the status change with `{ seller_id }`.
-
-```ts
-unsuspendSellerWorkflow.hooks.sellerUnsuspended(async ({ seller_id }) => {
-  // e.g. re-enable listings
-})
-```

package/content/references/workflows/seller/unterminate-seller.mdx

@@ -1,36 +0,0 @@
----
-title: "unterminateSellerWorkflow"
-description: "Revert a terminated seller back to suspended."
----
-
-Validates the seller is currently terminated, then sets `status` to `suspended` and clears `status_reason`. The seller must be unsuspended separately to reopen the store. Emits `seller.unterminated`.
-
-## Usage
-
-```ts
-import { unterminateSellerWorkflow } from "@mercurjs/core/workflows"
-
-await unterminateSellerWorkflow(container).run({
-  input: { seller_id: "sel_123" },
-})
-```
-
-## Input
-
-<ParamField body="seller_id" type="string" required>Id of the terminated seller.</ParamField>
-
-<ParamField body="additional_data" type="object">Custom data passed through to the workflow hooks.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="void">Nothing is returned.</ResponseField>
-
-## Hooks
-
-- `sellerUnterminated` — runs after the status change with `{ seller_id }`.
-
-```ts
-unterminateSellerWorkflow.hooks.sellerUnterminated(async ({ seller_id }) => {
-  // e.g. notify the operator
-})
-```

package/content/references/workflows/seller/update-seller-address.mdx

@@ -1,55 +0,0 @@
----
-title: "updateSellerAddressWorkflow"
-description: "Upsert a seller's address."
----
-
-Creates or updates the address record attached to a seller. Also run as a step by `createSellerAccountWorkflow` when an address is provided at registration.
-
-## Usage
-
-```ts
-import { updateSellerAddressWorkflow } from "@mercurjs/core/workflows"
-
-const { result } = await updateSellerAddressWorkflow(container).run({
-  input: {
-    seller_id: "sel_123",
-    data: { address_1: "1 Main St", city: "Berlin", country_code: "de" },
-  },
-})
-```
-
-## Input
-
-<ParamField body="seller_id" type="string" required>Id of the seller whose address is updated.</ParamField>
-<ParamField body="data" type="UpdateSellerAddressDTO" required>
-  Address fields to set; all optional.
-  <Expandable title="properties">
-    <ParamField body="name" type="string">Address label.</ParamField>
-    <ParamField body="company" type="string">Company name.</ParamField>
-    <ParamField body="first_name" type="string">Contact first name.</ParamField>
-    <ParamField body="last_name" type="string">Contact last name.</ParamField>
-    <ParamField body="address_1" type="string">Street address, line 1.</ParamField>
-    <ParamField body="address_2" type="string">Street address, line 2.</ParamField>
-    <ParamField body="city" type="string">City.</ParamField>
-    <ParamField body="country_code" type="string">ISO 2-letter country code.</ParamField>
-    <ParamField body="province" type="string">Province or state.</ParamField>
-    <ParamField body="postal_code" type="string">Postal code.</ParamField>
-    <ParamField body="phone" type="string">Phone number.</ParamField>
-    <ParamField body="metadata" type="object">Custom key-value data.</ParamField>
-  </Expandable>
-</ParamField>
-<ParamField body="additional_data" type="object">Custom data passed through to the workflow hooks.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="SellerAddressDTO">The updated address.</ResponseField>
-
-## Hooks
-
-- `addressUpdated` — runs after the update with `{ address, additional_data }`.
-
-```ts
-updateSellerAddressWorkflow.hooks.addressUpdated(async ({ address }) => {
-  // e.g. re-verify tax settings
-})
-```

package/content/references/workflows/seller/update-seller-payment-details.mdx

@@ -1,52 +0,0 @@
----
-title: "updateSellerPaymentDetailsWorkflow"
-description: "Upsert a seller's bank payment details."
----
-
-Creates or updates the payment details record attached to a seller. Also run as a step by `createSellerAccountWorkflow` when payment details are provided at registration.
-
-## Usage
-
-```ts
-import { updateSellerPaymentDetailsWorkflow } from "@mercurjs/core/workflows"
-
-const { result } = await updateSellerPaymentDetailsWorkflow(container).run({
-  input: {
-    seller_id: "sel_123",
-    data: { holder_name: "Acme GmbH", iban: "DE89370400440532013000" },
-  },
-})
-```
-
-## Input
-
-<ParamField body="seller_id" type="string" required>Id of the seller whose payment details are updated.</ParamField>
-<ParamField body="data" type="UpdatePaymentDetailsDTO" required>
-  Payment fields to set; all optional.
-  <Expandable title="properties">
-    <ParamField body="country_code" type="string">Bank country code.</ParamField>
-    <ParamField body="holder_name" type="string">Account holder name.</ParamField>
-    <ParamField body="bank_name" type="string">Bank name.</ParamField>
-    <ParamField body="iban" type="string">IBAN.</ParamField>
-    <ParamField body="bic" type="string">BIC / SWIFT code.</ParamField>
-    <ParamField body="routing_number" type="string">Routing number.</ParamField>
-    <ParamField body="account_number" type="string">Account number.</ParamField>
-  </Expandable>
-</ParamField>
-<ParamField body="additional_data" type="object">Custom data passed through to the workflow hooks.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="PaymentDetailsDTO">The updated payment details.</ResponseField>
-
-## Hooks
-
-- `paymentDetailsUpdated` — runs after the update with `{ payment_details, additional_data }`.
-
-```ts
-updateSellerPaymentDetailsWorkflow.hooks.paymentDetailsUpdated(
-  async ({ payment_details }) => {
-    // e.g. trigger payout account re-verification
-  }
-)
-```

package/content/references/workflows/seller/update-seller-professional-details.mdx

@@ -1,48 +0,0 @@
----
-title: "updateSellerProfessionalDetailsWorkflow"
-description: "Upsert a seller's professional (business) details."
----
-
-Creates or updates the professional details record attached to a seller. Also run as a step by `createSellerAccountWorkflow` when professional details are provided at registration.
-
-## Usage
-
-```ts
-import { updateSellerProfessionalDetailsWorkflow } from "@mercurjs/core/workflows"
-
-const { result } = await updateSellerProfessionalDetailsWorkflow(container).run({
-  input: {
-    seller_id: "sel_123",
-    data: { corporate_name: "Acme GmbH", tax_id: "DE123456789" },
-  },
-})
-```
-
-## Input
-
-<ParamField body="seller_id" type="string" required>Id of the seller whose professional details are updated.</ParamField>
-<ParamField body="data" type="UpdateProfessionalDetailsDTO" required>
-  Fields to set; all optional.
-  <Expandable title="properties">
-    <ParamField body="corporate_name" type="string">Registered corporate name.</ParamField>
-    <ParamField body="registration_number" type="string">Company registration number.</ParamField>
-    <ParamField body="tax_id" type="string">Tax identifier.</ParamField>
-  </Expandable>
-</ParamField>
-<ParamField body="additional_data" type="object">Custom data passed through to the workflow hooks.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="ProfessionalDetailsDTO">The updated professional details.</ResponseField>
-
-## Hooks
-
-- `professionalDetailsUpdated` — runs after the update with `{ professional_details, additional_data }`.
-
-```ts
-updateSellerProfessionalDetailsWorkflow.hooks.professionalDetailsUpdated(
-  async ({ professional_details }) => {
-    // e.g. re-run KYB checks
-  }
-)
-```

package/content/references/workflows/seller/update-sellers.mdx

@@ -1,57 +0,0 @@
----
-title: "updateSellersWorkflow"
-description: "Update sellers matching a selector."
----
-
-Updates every seller matching the selector with the given data. Triggered by `POST /admin/sellers/:id` and `POST /vendor/sellers/:id`. Emits `seller.updated` for each updated seller.
-
-## Usage
-
-```ts
-import { updateSellersWorkflow } from "@mercurjs/core/workflows"
-
-const { result } = await updateSellersWorkflow(container).run({
-  input: {
-    selector: { id: "sel_123" },
-    update: { name: "Acme Inc." },
-  },
-})
-```
-
-## Input
-
-<ParamField body="selector" type="object" required>Filter selecting the sellers to update, e.g. `{ id: "sel_123" }`.</ParamField>
-<ParamField body="update" type="UpdateSellerDTO" required>
-  Fields to update; all optional.
-  <Expandable title="properties">
-    <ParamField body="name" type="string">Display name.</ParamField>
-    <ParamField body="handle" type="string">URL handle.</ParamField>
-    <ParamField body="email" type="string">Contact email.</ParamField>
-    <ParamField body="description" type="string">Public description.</ParamField>
-    <ParamField body="logo" type="string">Logo URL.</ParamField>
-    <ParamField body="banner" type="string">Banner URL.</ParamField>
-    <ParamField body="website_url" type="string">Website URL.</ParamField>
-    <ParamField body="external_id" type="string">External system identifier.</ParamField>
-    <ParamField body="status" type="string">One of `open`, `pending_approval`, `suspended`, `terminated`.</ParamField>
-    <ParamField body="status_reason" type="string">Reason attached to the status.</ParamField>
-    <ParamField body="is_premium" type="boolean">Premium flag.</ParamField>
-    <ParamField body="closed_from" type="Date">Start of a store closure window.</ParamField>
-    <ParamField body="closed_to" type="Date">End of a store closure window.</ParamField>
-    <ParamField body="metadata" type="object">Custom key-value data.</ParamField>
-  </Expandable>
-</ParamField>
-<ParamField body="additional_data" type="object">Custom data passed through to the workflow hooks.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="SellerDTO[]">The updated sellers.</ResponseField>
-
-## Hooks
-
-- `sellersUpdated` — runs after the update with `{ sellers, additional_data }`.
-
-```ts
-updateSellersWorkflow.hooks.sellersUpdated(async ({ sellers }) => {
-  // sync updated sellers elsewhere
-})
-```

package/content/resources/ai/llms.mdx

@@ -1,74 +0,0 @@
----
-title: "LLMs"
-description: "Feed Mercur documentation directly to LLMs for accurate, context-aware assistance."
----
-
-# LLMs
-
-Mercur documentation is optimized for Large Language Models using the [llms.txt standard](https://llmstxt.org). This gives AI tools a structured map of all documentation — so they can answer technical questions accurately instead of guessing.
-
-Think of it like a sitemap, but for AI: a machine-readable file that describes what documentation exists, how it's organized, and where to find specific topics.
-
-<Note>
-  This page is for **chat assistants and hosted tools** (Claude, ChatGPT). If you're using a coding agent *inside* a Mercur project, prefer the version-matched docs bundled in `node_modules/@mercurjs/docs/` — see [Building with AI](/rc/resources/ai/overview).
-</Note>
-
----
-
-## Available files
-
-### llms.txt
-
-A structured index of all Mercur documentation pages with descriptions and links.
-
-```
-https://docs.mercurjs.com/llms.txt
-```
-
-Use this when your AI tool supports llms.txt natively or when you want to give it an overview of what's available without sending the full content.
-
-### llms-full.txt
-
-The entire Mercur documentation compiled into a single plain-text file.
-
-```
-https://docs.mercurjs.com/llms-full.txt
-```
-
-Use this when you want to give an LLM the complete context in one shot — ideal for complex questions that span multiple topics.
-
----
-
-## How to use
-
-<Tabs>
-  <Tab title="Claude Projects">
-    1. Open [Claude](https://claude.ai) and create a new Project
-    2. In project knowledge, add a URL: `https://docs.mercurjs.com/llms-full.txt`
-    3. Claude now has full Mercur documentation context in every conversation within that project
-  </Tab>
-  <Tab title="ChatGPT">
-    1. Download `https://docs.mercurjs.com/llms-full.txt`
-    2. Upload it as a file in your conversation or attach it to a Custom GPT's knowledge base
-  </Tab>
-  <Tab title="AI IDE (paste)">
-    For any AI coding tool that accepts context:
-    1. Fetch the file: `curl -o mercur-docs.txt https://docs.mercurjs.com/llms-full.txt`
-    2. Attach it to your conversation or project context
-  </Tab>
-</Tabs>
-
-<Tip>
-  Both files are auto-generated and always reflect the latest documentation. No maintenance required.
-</Tip>
-
----
-
-## When to use llms.txt vs MCP
-
-| Approach | Best for |
-|----------|----------|
-| **llms.txt / llms-full.txt** | One-time context loading, tools without MCP support, offline use |
-| **[MCP Server](/rc/resources/ai/mcp)** | Live search, always up-to-date results, integrated AI environments |
-
-For the best experience, use the [MCP server](/rc/resources/ai/mcp) if your tool supports it. Fall back to llms.txt when MCP isn't available.

package/content/resources/integrations/notifications.mdx

@@ -1,39 +0,0 @@
----
-title: "Notifications"
-description: "Send transactional emails and marketplace notifications with Resend."
----
-
-<Note>
-  This guide is being written. The outline below is the intended structure.
-</Note>
-
-<Info>
-  **Two notification surfaces.** Mercur sends provider-backed transactional email (seller approvals, invites, order events) *and* keeps an in-app vendor notification feed in the Vendor Portal. The email side uses Medusa's standard notification-provider model — Resend is the documented default, but any Medusa notification provider plugs in the same way.
-</Info>
-
-## What Resend powers
-
-The emails and notifications Mercur sends, and where they're triggered.
-
-<Steps>
-  <Step title="Prerequisites">
-    Resend account, API key, and environment variables.
-  </Step>
-  <Step title="Configure the provider">
-    Wire Resend as the notification provider.
-  </Step>
-  <Step title="Send a test notification">
-    Trigger a test notification and confirm delivery.
-  </Step>
-</Steps>
-
-## Verify
-
-Trigger a test notification and confirm delivery.
-
-## Next steps
-
-<CardGroup cols={2}>
-  <Card title="Search" href="/rc/resources/integrations/search" />
-  <Card title="Deploy to Medusa Cloud" href="/rc/resources/deployment/medusa-cloud" />
-</CardGroup>