@mercurjs/docs 2.2.1 → 2.3.0-canary.1

package/content/references/workflows/offer/batch-offer-inventory-items.mdx

@@ -1,62 +0,0 @@
----
-title: "batchOfferInventoryItemsWorkflow"
-description: "Create, update, and delete an offer's inventory-item links in one call."
----
-
-Manages the `offer ↔ inventory_item` links that define what stock an offer consumes. Validates the payload (no duplicates, no ID in more than one bucket, created items must exist, deleted items must already be linked), then batches the link changes — each link carries a `required_quantity` (default `1`). Emits `offer.updated`. Triggered by `POST /vendor/offers/:id/inventory-items/batch`.
-
-## Usage
-
-```ts
-import { batchOfferInventoryItemsWorkflow } from "@mercurjs/core/workflows"
-
-const { result } = await batchOfferInventoryItemsWorkflow(container).run({
-  input: {
-    offer_id: "offer_123",
-    create: [{ inventory_item_id: "iitem_1", required_quantity: 2 }],
-    update: [{ inventory_item_id: "iitem_2", required_quantity: 1 }],
-    delete: ["iitem_3"],
-  },
-})
-```
-
-## Input
-
-<ParamField body="offer_id" type="string" required>The offer whose inventory links are managed; fails if not found.</ParamField>
-<ParamField body="create" type="object[]">
-  Links to create; the inventory items must exist and not appear in `update`/`delete`.
-
-  <Expandable title="properties">
-    <ParamField body="inventory_item_id" type="string" required>The inventory item to link.</ParamField>
-    <ParamField body="required_quantity" type="number">Units consumed per offer unit; defaults to `1`.</ParamField>
-  </Expandable>
-</ParamField>
-<ParamField body="update" type="object[]">
-  Existing links to update.
-
-  <Expandable title="properties">
-    <ParamField body="inventory_item_id" type="string" required>The linked inventory item.</ParamField>
-    <ParamField body="required_quantity" type="number" required>New units consumed per offer unit.</ParamField>
-  </Expandable>
-</ParamField>
-<ParamField body="delete" type="string[]">Inventory item IDs to unlink; each must currently be linked or the workflow throws a 404.</ParamField>
-<ParamField body="additional_data" type="object">Custom data passed through to the workflow hooks.</ParamField>
-
-## Result
-
-<ResponseField name="result.created" type="LinkDefinition[]">The created offer ↔ inventory-item links.</ResponseField>
-<ResponseField name="result.updated" type="LinkDefinition[]">The updated links.</ResponseField>
-<ResponseField name="result.deleted" type="string[]">Inventory item IDs that were unlinked.</ResponseField>
-
-## Hooks
-
-- `validate` — runs first with `{ input }`.
-- `offerInventoryItemsBatched` — runs after the batch with `{ offer_id, result, additional_data }`.
-
-```ts
-batchOfferInventoryItemsWorkflow.hooks.offerInventoryItemsBatched(
-  async ({ offer_id, result }) => {
-    // react to link changes
-  }
-)
-```

package/content/references/workflows/offer/create-offers.mdx

@@ -1,65 +0,0 @@
----
-title: "createOffersWorkflow"
-description: "Create seller offers with inventory items and offer-scoped prices."
----
-
-Creates one offer per entry: creates and links new inventory items (with optional starting stock levels) to the offer and the seller, ensures the master variant has a `PriceSet`, writes the offer's prices onto that shared set scoped by an `offer_id` price rule, and links the price rows to the offer. Emits `offer.created`. Triggered by `POST /vendor/offers` and the vendor/admin offer batch routes.
-
-## Usage
-
-```ts
-import { createOffersWorkflow } from "@mercurjs/core/workflows"
-
-const { result } = await createOffersWorkflow(container).run({
-  input: {
-    offers: [
-      {
-        seller_id: "sel_123",
-        created_by: "member_123",
-        variant_id: "variant_123",
-        shipping_profile_id: "sp_123",
-        sku: "ACME-TEE-M",
-        inventory_items: [
-          { stock_levels: [{ location_id: "sloc_123", stocked_quantity: 50 }] },
-        ],
-        prices: [{ amount: 1999, currency_code: "usd" }],
-      },
-    ],
-  },
-})
-```
-
-## Input
-
-<ParamField body="offers" type="object[]" required>
-  Offers to create.
-
-  <Expandable title="properties">
-    <ParamField body="seller_id" type="string" required>The seller that owns the offer.</ParamField>
-    <ParamField body="created_by" type="string" required>ID of the member creating the offer.</ParamField>
-    <ParamField body="sku" type="string" required>The offer's SKU.</ParamField>
-    <ParamField body="variant_id" type="string" required>The master product variant the offer sells; fails if not found.</ParamField>
-    <ParamField body="shipping_profile_id" type="string" required>Shipping profile used to fulfill the offer.</ParamField>
-    <ParamField body="inventory_items" type="object[]" required>New inventory items to create and link; at least one entry. Each entry accepts `sku`, `title`, `required_quantity` (default `1`), and `stock_levels` (`{ location_id, stocked_quantity }[]`).</ParamField>
-    <ParamField body="prices" type="object[]" required>Offer price ladder; each row accepts `amount`, `currency_code`, `min_quantity`, `max_quantity`, and `rules`.</ParamField>
-    <ParamField body="ean" type="string | null">EAN; snapshotted from the variant when omitted.</ParamField>
-    <ParamField body="upc" type="string | null">UPC; snapshotted from the variant when omitted.</ParamField>
-    <ParamField body="metadata" type="object | null">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="OfferDTO[]">The created offers.</ResponseField>
-
-## Hooks
-
-- `validate` — runs first with `{ input }`.
-- `offersCreated` — runs after creation with `{ offers, additional_data }`.
-
-```ts
-createOffersWorkflow.hooks.offersCreated(async ({ offers, additional_data }) => {
-  // react to new offers
-})
-```

package/content/references/workflows/offer/delete-offers.mdx

@@ -1,35 +0,0 @@
----
-title: "deleteOffersWorkflow"
-description: "Delete one or more offers."
----
-
-Deletes the given offers and emits `offer.deleted` with each offer's `id` and `product_id`. Triggered by `DELETE /vendor/offers/:id`, `DELETE /admin/offers/:id`, and the offer batch routes.
-
-## Usage
-
-```ts
-import { deleteOffersWorkflow } from "@mercurjs/core/workflows"
-
-await deleteOffersWorkflow(container).run({
-  input: { ids: ["offer_123"] },
-})
-```
-
-## Input
-
-<ParamField body="ids" type="string[]" required>IDs of the offers to delete.</ParamField>
-<ParamField body="additional_data" type="object">Custom data passed through to the workflow hooks.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="void">No return value; the offers are deleted.</ResponseField>
-
-## Hooks
-
-- `offersDeleted` — runs after deletion with `{ ids, additional_data }`.
-
-```ts
-deleteOffersWorkflow.hooks.offersDeleted(async ({ ids, additional_data }) => {
-  // react to deleted offers
-})
-```

package/content/references/workflows/offer/update-offers.mdx

@@ -1,53 +0,0 @@
----
-title: "updateOffersWorkflow"
-description: "Update offer rows and rewrite their price ladders with replace semantics."
----
-
-Applies partial updates to offer rows (`sku`, `shipping_profile_id`, `metadata`). When an entry sets `prices`, the offer's price ladder is rewritten with replace semantics: rows with `id` are updated in place, rows without `id` are added, and existing offer-owned prices omitted from the array are removed — all on the variant's shared `PriceSet`, scoped by the `offer_id` price rule. Price ownership is asserted so an offer can't touch another offer's rows. Emits `offer.updated`. Triggered by `POST /vendor/offers/:id` and the offer batch routes.
-
-## Usage
-
-```ts
-import { updateOffersWorkflow } from "@mercurjs/core/workflows"
-
-const { result } = await updateOffersWorkflow(container).run({
-  input: {
-    offers: [
-      {
-        id: "offer_123",
-        prices: [{ amount: 1799, currency_code: "usd" }],
-      },
-    ],
-  },
-})
-```
-
-## Input
-
-<ParamField body="offers" type="object[]" required>
-  Offer updates, keyed by ID.
-
-  <Expandable title="properties">
-    <ParamField body="id" type="string" required>The offer to update; fails if not found.</ParamField>
-    <ParamField body="sku" type="string">New SKU.</ParamField>
-    <ParamField body="shipping_profile_id" type="string">New shipping profile.</ParamField>
-    <ParamField body="metadata" type="object | null">Custom key-value data.</ParamField>
-    <ParamField body="prices" type="object[]">Full replacement price ladder; each row accepts `id` (update in place when set), `amount`, `currency_code`, `min_quantity`, `max_quantity`, and `rules`. Omit the field to leave prices untouched.</ParamField>
-  </Expandable>
-</ParamField>
-<ParamField body="additional_data" type="object">Custom data passed through to the workflow hooks.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="OfferDTO[]">The updated offers.</ResponseField>
-
-## Hooks
-
-- `validate` — runs first with `{ input }`.
-- `offersUpdated` — runs after the update with `{ offers, additional_data }`.
-
-```ts
-updateOffersWorkflow.hooks.offersUpdated(async ({ offers, additional_data }) => {
-  // react to updated offers
-})
-```

package/content/references/workflows/order/cancel-order-fulfillment.mdx

@@ -1,34 +0,0 @@
----
-title: "cancelOrderFulfillmentWorkflow"
-description: "Cancel an unshipped fulfillment and restore reservations and stock."
----
-
-Mercur's offer-aware replacement for Medusa's cancel-order-fulfillment flow. Validates that the fulfillment exists, is not shipped, and not already canceled, then cancels it on the order and at the provider, re-creates or tops up reservations, and adjusts inventory back up — dividing line quantities by each offer's `required_quantity` so bundle offers restock correctly. Triggered by `POST /vendor/orders/:id/fulfillments/:fulfillment_id/cancel`. Emits `order.fulfillment_canceled`.
-
-## Usage
-
-```ts
-import { cancelOrderFulfillmentWorkflow } from "@mercurjs/core/workflows"
-
-await cancelOrderFulfillmentWorkflow(container).run({
-  input: {
-    order_id: "order_123",
-    fulfillment_id: "ful_123",
-  },
-})
-```
-
-## Input
-
-<ParamField body="order_id" type="string" required>The order the fulfillment belongs to; must not be canceled.</ParamField>
-<ParamField body="fulfillment_id" type="string" required>The fulfillment to cancel; shipped or already-canceled fulfillments throw.</ParamField>
-<ParamField body="no_notification" type="boolean">Suppress customer notification for the cancellation.</ParamField>
-<ParamField body="additional_data" type="object">Custom data passed through to the hooks.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="void">No return value.</ResponseField>
-
-## Hooks
-
-- `orderFulfillmentCanceled` — runs after cancellation with `{ fulfillment, additional_data }`.

package/content/references/workflows/order/confirm-claim-request.mdx

@@ -1,25 +0,0 @@
----
-title: "confirmClaimRequestWorkflow"
-description: "Confirm a claim request and fix reservations for offer bundles."
----
-
-Wraps Medusa's `confirmClaimRequestWorkflow` and then rewrites the reservations created for the claim's additional items when those items come from offers: single-link offers get their reservation quantity scaled by `required_quantity`, multi-link (bundle) offers have the default reservation replaced with one reservation per linked inventory item. Triggered by `POST /admin/claims/:id/request` and `POST /vendor/claims/:id/request`. Events are emitted by the wrapped Medusa workflow.
-
-## Usage
-
-```ts
-import { confirmClaimRequestWorkflow } from "@mercurjs/core/workflows"
-
-const { result } = await confirmClaimRequestWorkflow(container).run({
-  input: { claim_id: "claim_123", confirmed_by: "user_123" },
-})
-```
-
-## Input
-
-<ParamField body="claim_id" type="string" required>The claim whose pending request is confirmed.</ParamField>
-<ParamField body="confirmed_by" type="string">Id of the user confirming the claim.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="OrderPreviewDTO">Preview of the order with the confirmed claim applied.</ResponseField>

package/content/references/workflows/order/confirm-exchange-request.mdx

@@ -1,25 +0,0 @@
----
-title: "confirmExchangeRequestWorkflow"
-description: "Confirm an exchange request and fix reservations for offer bundles."
----
-
-Wraps Medusa's `confirmExchangeRequestWorkflow` and then rewrites the reservations created for the exchange's additional items when those items come from offers: single-link offers get their reservation quantity scaled by `required_quantity`, multi-link (bundle) offers have the default reservation replaced with one reservation per linked inventory item. Triggered by `POST /admin/exchanges/:id/request` and `POST /vendor/exchanges/:id/request`. Events are emitted by the wrapped Medusa workflow.
-
-## Usage
-
-```ts
-import { confirmExchangeRequestWorkflow } from "@mercurjs/core/workflows"
-
-const { result } = await confirmExchangeRequestWorkflow(container).run({
-  input: { exchange_id: "exchange_123", confirmed_by: "user_123" },
-})
-```
-
-## Input
-
-<ParamField body="exchange_id" type="string" required>The exchange whose pending request is confirmed.</ParamField>
-<ParamField body="confirmed_by" type="string">Id of the user confirming the exchange.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="OrderPreviewDTO">Preview of the order with the confirmed exchange applied.</ResponseField>

package/content/references/workflows/order/confirm-order-edit-request.mdx

@@ -1,25 +0,0 @@
----
-title: "confirmOrderEditRequestWorkflow"
-description: "Confirm an order edit and reconcile offer-bundle reservations."
----
-
-Wraps Medusa's `confirmOrderEditRequestWorkflow` and then reconciles reservations for every unfulfilled order item that comes from an offer with inventory links: desired quantities are computed as `(ordered - fulfilled) × required_quantity` per linked inventory item, and mismatching reservations are replaced with a correct set (one per linked item, bundle offers included). Triggered by `POST /admin/order-edits/:id/confirm` and `POST /vendor/order-edits/:id/confirm`. Events are emitted by the wrapped Medusa workflow.
-
-## Usage
-
-```ts
-import { confirmOrderEditRequestWorkflow } from "@mercurjs/core/workflows"
-
-const { result } = await confirmOrderEditRequestWorkflow(container).run({
-  input: { order_id: "order_123", confirmed_by: "user_123" },
-})
-```
-
-## Input
-
-<ParamField body="order_id" type="string" required>The order whose pending edit is confirmed.</ParamField>
-<ParamField body="confirmed_by" type="string">Id of the user confirming the edit.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="OrderPreviewDTO">Preview of the order with the confirmed edit applied.</ResponseField>

package/content/references/workflows/order/confirm-return-receive.mdx

@@ -1,25 +0,0 @@
----
-title: "confirmReturnReceiveWorkflow"
-description: "Confirm a return receival, offer-aware restock included."
----
-
-Mercur's offer-aware replacement for Medusa's confirm-return-receive flow. Applies the pending receive actions of the return's order change, updates return items' received/damaged quantities, marks the return `received` (or `partially_received`), restocks inventory — expanding offer bundle links by `required_quantity` — and refreshes the order payment collection. Throws when a bundle offer has no stock level at the return's location. Triggered by `POST /admin/returns/:id/receive/confirm` and `POST /vendor/returns/:id/receive/confirm`. Emits `order.return_received`.
-
-## Usage
-
-```ts
-import { confirmReturnReceiveWorkflow } from "@mercurjs/core/workflows"
-
-const { result } = await confirmReturnReceiveWorkflow(container).run({
-  input: { return_id: "return_123", confirmed_by: "user_123" },
-})
-```
-
-## Input
-
-<ParamField body="return_id" type="string" required>The return whose pending receival is confirmed.</ParamField>
-<ParamField body="confirmed_by" type="string">Id of the user confirming the receival.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="OrderPreviewDTO">Preview of the order with the confirmed changes applied.</ResponseField>

package/content/references/workflows/order/create-order-fulfillment.mdx

@@ -1,45 +0,0 @@
----
-title: "createOrderFulfillmentWorkflow"
-description: "Create a fulfillment for order items, offer-bundle aware."
----
-
-Mercur's offer-aware replacement for Medusa's create-order-fulfillment flow. Validates the order and items, creates the fulfillment, registers it on the order, links it, and consumes reservations / adjusts inventory — multiplying quantities by each offer's `required_quantity` inventory links so bundle offers deduct the right stock. Triggered by `POST /vendor/orders/:id/fulfillments`. Emits `order.fulfillment_created`.
-
-## Usage
-
-```ts
-import { createOrderFulfillmentWorkflow } from "@mercurjs/core/workflows"
-
-const { result } = await createOrderFulfillmentWorkflow(container).run({
-  input: {
-    order_id: "order_123",
-    items: [{ id: "ordli_123", quantity: 1 }],
-  },
-})
-```
-
-## Input
-
-<ParamField body="order_id" type="string" required>The order to fulfill.</ParamField>
-<ParamField body="items" type="{ id: string; quantity: number }[]" required>Order line items and quantities to fulfill; all items must either require shipping or not — mixed requests throw.</ParamField>
-<ParamField body="location_id" type="string">Stock location to fulfill from; defaults to the shipping option's linked location.</ParamField>
-<ParamField body="shipping_option_id" type="string">Shipping option to fulfill with; defaults to the order's first shipping method.</ParamField>
-<ParamField body="created_by" type="string">Id of the user creating the fulfillment.</ParamField>
-<ParamField body="labels" type="FulfillmentLabelDTO[]">Tracking labels to attach.</ParamField>
-<ParamField body="no_notification" type="boolean">Suppress customer notification for this fulfillment.</ParamField>
-<ParamField body="metadata" type="object | null">Custom key-value data on the fulfillment.</ParamField>
-<ParamField body="additional_data" type="object">Custom data passed through to the hooks.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="FulfillmentDTO">The created fulfillment.</ResponseField>
-
-## Hooks
-
-- `fulfillmentCreated` — runs after creation with `{ fulfillment, additional_data }`.
-
-```ts
-createOrderFulfillmentWorkflow.hooks.fulfillmentCreated(async ({ fulfillment }) => {
-  // push to a 3PL
-})
-```

package/content/references/workflows/order-group/get-order-group-detail.mdx

@@ -1,29 +0,0 @@
----
-title: "getOrderGroupDetailWorkflow"
-description: "Retrieve one order group with per-order aggregated payment and fulfillment statuses."
----
-
-Loads an order group with its child orders and computes each order's `payment_status` and `fulfillment_status` from its payment collections and fulfillments. Payment collections and fulfillments are stripped from the response unless the requested fields include them. Triggered by `GET /admin/order-groups/:id` and `GET /admin/orders/:id/order-group`.
-
-## Usage
-
-```ts
-import { getOrderGroupDetailWorkflow } from "@mercurjs/core/workflows"
-
-const { result } = await getOrderGroupDetailWorkflow(container).run({
-  input: {
-    order_group_id: "ordgrp_123",
-    fields: ["display_id", "total", "orders.display_id"],
-  },
-})
-```
-
-## Input
-
-<ParamField body="order_group_id" type="string" required>The order group to retrieve; fails if not found.</ParamField>
-<ParamField body="fields" type="string[]" required>Fields to retrieve; merged with the defaults needed for status aggregation (`orders.items.*`, payment collection and fulfillment timestamps).</ParamField>
-
-## Result
-
-<ResponseField name="result" type="object">The order group with its child orders.</ResponseField>
-<ResponseField name="result.orders" type="OrderDetailDTO[]">Child orders, each with computed `payment_status` and `fulfillment_status`.</ResponseField>

package/content/references/workflows/order-group/get-order-groups-list.mdx

@@ -1,38 +0,0 @@
----
-title: "getOrderGroupsListWorkflow"
-description: "List order groups with pagination and per-order aggregated statuses."
----
-
-Lists order groups with their child orders, computing each order's `payment_status` and `fulfillment_status` from payment collections and fulfillments. When `sellerId` is set, each group's `orders` array is filtered to that seller's orders — useful for vendor-scoped views. Payment collections and fulfillments are stripped unless the requested fields include them. Triggered by `GET /admin/order-groups`.
-
-## Usage
-
-```ts
-import { getOrderGroupsListWorkflow } from "@mercurjs/core/workflows"
-
-const { result } = await getOrderGroupsListWorkflow(container).run({
-  input: {
-    fields: ["display_id", "total"],
-    variables: { skip: 0, take: 20, order: { created_at: "DESC" } },
-  },
-})
-```
-
-## Input
-
-<ParamField body="fields" type="string[]" required>Fields to retrieve; merged with the defaults needed for status aggregation.</ParamField>
-<ParamField body="variables" type="object">
-  Query filters plus pagination.
-
-  <Expandable title="properties">
-    <ParamField body="skip" type="number">Number of groups to skip.</ParamField>
-    <ParamField body="take" type="number">Number of groups to return.</ParamField>
-    <ParamField body="order" type="object">Sort spec, e.g. `{ created_at: "DESC" }`.</ParamField>
-  </Expandable>
-</ParamField>
-<ParamField body="sellerId" type="string | string[]">Restrict each group's `orders` to the given seller(s).</ParamField>
-
-## Result
-
-<ResponseField name="result.rows" type="object[]">The order groups; each child order carries computed `payment_status` and `fulfillment_status`.</ResponseField>
-<ResponseField name="result.metadata" type="object">Pagination metadata (`count`, `skip`, `take`).</ResponseField>

package/content/references/workflows/overview.mdx

@@ -1,72 +0,0 @@
----
-title: "Workflows"
-description: "Every workflow exported by @mercurjs/core, grouped by domain."
----
-
-All marketplace business logic runs through Medusa workflows exported from `@mercurjs/core/workflows`. Run them from your own API routes, jobs, or subscribers, and extend them through their hooks — see [Extend a workflow](/rc/resources/customization/extend-a-workflow).
-
-```ts
-import { createSellersWorkflow } from "@mercurjs/core/workflows"
-
-const { result } = await createSellersWorkflow(container).run({
-  input: { name: "Acme", email: "hello@acme.co" },
-})
-```
-
-Each workflow has its own reference page with the exact input, result, and hooks.
-
-<CardGroup cols={2}>
-  <Card title="Seller lifecycle" href="/rc/references/workflows/seller/create-sellers">
-    Create, approve, suspend, terminate sellers and manage their details.
-  </Card>
-  <Card title="Members & invites" href="/rc/references/workflows/member/add-seller-member">
-    Team management and the JWT invite flow.
-  </Card>
-  <Card title="Checkout & carts" href="/rc/references/workflows/cart/complete-cart-with-split-orders">
-    The multi-vendor split checkout and per-seller cart operations.
-  </Card>
-  <Card title="Order groups" href="/rc/references/workflows/order-group/get-order-group-detail">
-    Read models over grouped per-seller orders.
-  </Card>
-  <Card title="Commission" href="/rc/references/workflows/commission/create-commission-rates">
-    Rate CRUD, rule batching, and order line recomputation.
-  </Card>
-  <Card title="Payout" href="/rc/references/workflows/payout/create-payout">
-    Accounts, onboarding, payouts, and webhook processing.
-  </Card>
-  <Card title="Products" href="/rc/references/workflows/product/create-products">
-    Master product creation, confirmation, and seller linking.
-  </Card>
-  <Card title="Product edit" href="/rc/references/workflows/product-edit/create-product-change">
-    The change-request lifecycle behind vendor edits.
-  </Card>
-  <Card title="Product attributes" href="/rc/references/workflows/product-attribute/create-and-link-product-attributes-to-product">
-    Attribute catalog CRUD and the product batch engine.
-  </Card>
-  <Card title="Offers" href="/rc/references/workflows/offer/create-offers">
-    Listing CRUD and inventory item batching.
-  </Card>
-  <Card title="Media" href="/rc/references/workflows/media/set-collection-images">
-    Category and collection galleries, thumbnails, banners, icons.
-  </Card>
-  <Card title="Orders & RMA" href="/rc/references/workflows/order/create-order-fulfillment">
-    Fulfillment and return/claim/exchange confirmation.
-  </Card>
-</CardGroup>
-
-## Internal and utility workflows
-
-These are exported but usually not called directly — they run inside the workflows above:
-
-| Workflow | Called by |
-| --- | --- |
-| `applyProductChangeActionsWorkflow` / `applyProductAttributeChangeActionsWorkflow` | `confirmProductChangeWorkflow` — replays staged actions onto the product |
-| `productEditUpdateProductWorkflow` / `productEditUpdateVariantsWorkflow` / `productEditUpdateAttributesWorkflow` / `productEditDeleteProductWorkflow` | Vendor product edit routes — stage the corresponding change actions |
-| `recordProductAuditChangeWorkflow` | Product flows — writes audit change records |
-| `create/update/deleteProductCategoryWithImagesWorkflow` and `create/update/deleteProductCollectionWithImagesWorkflow` | Admin category/collection routes — wrap Medusa's workflows plus the image-set step |
-| `createSellerCampaignsWorkflow`, `createSellerCustomerGroupsWorkflow`, `createSellerInventoryItemsWorkflow`, `createSellerPriceListsWorkflow`, `createSellerPromotionsWorkflow`, `createSellerShippingOptionsWorkflow`, `createSellerShippingProfilesWorkflow`, `createSellerStockLocationsWorkflow` | Vendor resource-create routes — create the record and link it to the seller |
-
-<Note>
-  Search has no workflows by design — index synchronization is event-driven
-  through subscribers. See the [Search module](/rc/references/modules/search#index-synchronization).
-</Note>

package/content/references/workflows/payout/create-onboarding.mdx

@@ -1,36 +0,0 @@
----
-title: "createOnboardingWorkflow"
-description: "Start a provider onboarding session for a payout account."
----
-
-Creates an onboarding session for an existing payout account through the payout provider — for Stripe Connect this returns a hosted onboarding link the seller completes in the browser. Triggered by `POST /vendor/payout-accounts/:id/onboarding`.
-
-## Usage
-
-```ts
-import { createOnboardingWorkflow } from "@mercurjs/core/workflows"
-
-const { result } = await createOnboardingWorkflow(container).run({
-  input: {
-    account_id: "pacc_123",
-    data: {
-      refresh_url: "https://vendor.example.com/payouts",
-      return_url: "https://vendor.example.com/payouts",
-    },
-  },
-})
-```
-
-## Input
-
-<ParamField body="account_id" type="string" required>The payout account to onboard.</ParamField>
-<ParamField body="context" type="object">Provider context; supports `idempotency_key` plus provider-specific keys.</ParamField>
-<ParamField body="data" type="object">Provider-specific onboarding data (e.g. Stripe `refresh_url` / `return_url`).</ParamField>
-
-## Result
-
-<ResponseField name="result" type="OnboardingDTO">The created onboarding session.</ResponseField>
-<ResponseField name="result.id" type="string">Onboarding ID.</ResponseField>
-<ResponseField name="result.account_id" type="string">The payout account the session belongs to.</ResponseField>
-<ResponseField name="result.data" type="object | null">Provider response data (e.g. the hosted onboarding URL).</ResponseField>
-<ResponseField name="result.context" type="object | null">The context the session was created with.</ResponseField>

package/content/references/workflows/payout/create-payout-account.mdx

@@ -1,33 +0,0 @@
----
-title: "createPayoutAccountWorkflow"
-description: "Create a payout account for a seller through the registered payout provider."
----
-
-Validates that the seller doesn't already have a payout account, creates one through the payout provider (e.g. Stripe Connect), and links it to the seller. Triggered by `POST /vendor/payout-accounts`.
-
-## Usage
-
-```ts
-import { createPayoutAccountWorkflow } from "@mercurjs/core/workflows"
-
-const { result } = await createPayoutAccountWorkflow(container).run({
-  input: {
-    seller_id: "sel_123",
-    context: { country: "US" },
-  },
-})
-```
-
-## Input
-
-<ParamField body="seller_id" type="string" required>The seller to create the payout account for; fails if the seller already has one.</ParamField>
-<ParamField body="context" type="object">Provider context; supports `idempotency_key` plus provider-specific keys.</ParamField>
-<ParamField body="data" type="object">Provider-specific creation data passed straight to the payout provider.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="PayoutAccountDTO">The created payout account.</ResponseField>
-<ResponseField name="result.id" type="string">Payout account ID.</ResponseField>
-<ResponseField name="result.status" type="string">One of `pending`, `active`, `restricted`, `rejected`; starts as `pending` until onboarding completes.</ResponseField>
-<ResponseField name="result.data" type="object">Provider-side account data (e.g. the connected account payload).</ResponseField>
-<ResponseField name="result.context" type="object | null">The context the account was created with.</ResponseField>

package/content/references/workflows/payout/create-payout.mdx

@@ -1,30 +0,0 @@
----
-title: "createPayoutWorkflow"
-description: "Issue a payout to a seller through the registered provider."
----
-
-Loads a settled order with its seller and payout account, sums the order's commission lines (item and shipping), and pays out `order.total - total commission` through the payout provider, linking the payout to the seller. Fails if the seller has no payout account. The order ID doubles as the provider idempotency key, so re-running for the same order is safe. Not wired to a route — run it from your own subscriber or scheduled job once an order is captured and ready to settle.
-
-## Usage
-
-```ts
-import { createPayoutWorkflow } from "@mercurjs/core/workflows"
-
-const { result } = await createPayoutWorkflow(container).run({
-  input: { order_id: "order_123" },
-})
-```
-
-## Input
-
-<ParamField body="order_id" type="string" required>The order to settle; must belong to a seller with a payout account.</ParamField>
-
-## Result
-
-<ResponseField name="result" type="PayoutDTO">The created payout.</ResponseField>
-<ResponseField name="result.id" type="string">Payout ID.</ResponseField>
-<ResponseField name="result.account_id" type="string">The seller's payout account.</ResponseField>
-<ResponseField name="result.amount" type="BigNumberInput">Order total minus the order's commission lines.</ResponseField>
-<ResponseField name="result.currency_code" type="string">The order's currency.</ResponseField>
-<ResponseField name="result.status" type="string">One of `pending`, `processing`, `paid`, `failed`, `canceled`.</ResponseField>
-<ResponseField name="result.data" type="object | null">Provider transfer data; includes `order_id` and `seller_id`.</ResponseField>