@mercurjs/docs 2.2.0-canary.40

package/content/user-guide/vendor/stores.mdx

@@ -0,0 +1,209 @@
+---
+title: "Store in Mercur Vendor Panel"
+sidebarTitle: "Store"
+---
+
+This guide explains how to manage store in the Mercur Vendor Panel.
+
+## Store Set Up
+
+You can set up a store in Mercur in three ways:
+
+1. Admin Invitation: The admin invites you to join the platform and set up your first store.
+2. Vendor Request: You create a new store in your panel, which the admin then confirms.
+3. Vendor Self-Registration. When enabled, you can apply to join the platform through the storefront or other available entry points.
+
+### Admin Invitation
+
+Once the admin creates the store and invites you, you receive an email with a link to join as the store's admin. After accepting the invitation, you are redirected to the setup page, where you enter your details and set a password. Once completed, click “Continue” to start onboarding.
+
+![Vendor Onboarding (4)](/images/Vendor-Onboarding-\(4\).png)
+
+The onboarding setup is customizable depending on marketplace needs and may include:
+
+- Store Details
+- Address
+- Company Details
+- Payment Details
+
+![Vendor Onboarding Details (2)](/images/Vendor-Onboarding---Details-\(2\).png)
+
+Depending on the marketplace configuration, you need to complete all required steps during onboarding or later in the store profile. The “Complete profile” block shows any missing information required by the marketplace. Once all required information is added, the block disappears.
+
+![Store Details (16)](/images/Store-Details-\(16\).png)
+
+### Vendor Request
+
+A vendor can have multiple stores in Mercur. If you already have one, you can create another.
+
+To create a store:
+
+1. Click the store name in the upper left corner.
+2. A menu appears showing your available stores, with the active one selected.
+3. Click the “Add new store” button.
+4. This opens a new page for store setup. The setup is customizable based on marketplace needs and may include:
+   - Store Details
+   - Address
+   - Company Details
+   - Payment Details
+
+After creating the store, you are redirected to the store details page with a "Pending" status.
+
+Depending on the marketplace setup, a “Complete profile” block may appear showing any missing information required by the marketplace. Once all required information is added, the block disappears.
+
+<Frame>
+  ![Products Main View (3)](/images/Products---Main-View-\(3\).png)
+</Frame>
+
+### Vendor Self-Registration
+
+When the marketplace admin enables self-registration, you can apply to join the platform through the storefront or other entry points. You are then redirected to the registration page to set up an admin account and create the first store.
+
+After creating the store, you are redirected to the store details page with a "Pending" status.
+
+Depending on the marketplace setup, a “Complete profile” block may appear showing any missing information required by the marketplace. Once all required information is added, the block disappears.
+
+![Vendor Registation (1)](/images/Vendor-Registation-\(1\).png)
+
+## Store Details
+
+To view store details:
+
+1. Go to “Settings” in the sidebar.
+2. Go to “Store” in the sidebar.
+
+This opens the store details page. Here, you can view and edit store details, address, company details, payment details, time off.
+
+![Store Details Edit (7)](/images/Store-Details---Edit-\(7\).png)
+
+### Edit Store Details
+
+To edit store details:
+
+1. Go to “Settings” in the sidebar.
+2. Go to “Store” in the sidebar.
+3. Click the icon in the section's header.
+4. Choose “Edit” from the dropdown.
+5. In the side window that opens, you can edit the store:
+   - Name
+   - Description
+   - Handle
+   - Email
+   - Phone
+   - Website
+   - Media. You can add logo and banner. This media will be visible on the storefront.
+6. Once you’re done, click the “Save” button.
+
+<Warning>
+  A vendor can have only one currency per store. Once set, the vendor cannot change the currency.
+</Warning>
+
+![Store Details Edit (8)](/images/Store-Details---Edit-\(8\).png)
+
+### Edit Store Address
+
+To edit store address:
+
+1. Go to “Settings” in the sidebar.
+2. Go to “Store” in the sidebar.
+3. Click the icon in the “Address” header.
+4. Choose “Edit” from the dropdown.
+5. In the side window that opens, you can edit:
+   - Name
+   - Address
+   - Apartment, suite, etc.
+   - Postal Code
+   - City
+   - Country
+   - State
+6. Once you're done, click the “Save” button.
+
+![Store Details Address (4)](/images/Store-Details---Address-\(4\).png)
+
+### Edit Store Company Details
+
+To edit company details:
+
+1. Go to “Settings” in the sidebar.
+2. Go to “Store” in the sidebar.
+3. Click the icon in the “Company Details” header.
+4. Choose “Edit” from the dropdown.
+5. In the side window that opens, you can edit:
+   1. Company
+   2. Registration number
+   3. Tax ID
+6. Once you're done, click the “Save” button.
+
+![Store Details Company Details (1)](/images/Store-Details---Company-Details-\(1\).png)
+
+### Edit Store Payment Details
+
+To edit payment details:
+
+1. Go to “Settings” in the sidebar.
+2. Go to “Store” in the sidebar.
+3. Click the icon in the “Payment Details” header.
+4. Choose “Edit” from the dropdown.
+5. In the side window, you can edit payment details:
+   1. For all countries except the United States, provide the following details based on your needs:
+      - Account name
+      - IBAN
+      - Account number
+      - SWIFT/BIC
+   2. For United States:
+      - Account name
+      - Account number
+      - ACH routing number
+6. Once you're done, click the “Save” button.
+
+![Store Details Payment Details (2)](/images/Store-Details---Payment-Details-\(2\).png)
+
+## Time Off
+
+In the “Time off” section, you can manage your store's time off. It specifies when the store will be unavailable to receive orders. You can specify one time off period and add a note. During this period, the store’s products will not be visible on the storefront.
+
+<Frame>
+  ![Store Details Time Off (8)](/images/Store-Details---Time-off-\(8\).png)
+</Frame>
+
+### Create Time Off
+
+To create a time off:
+
+1. Go to “Settings” in the sidebar.
+2. Go to “Store” in the sidebar.
+3. Click the “Create” button in the “Time off” section.
+4. In the side window, you can enter:
+   - First day
+   - Last day. If you leave this field empty, the store will be closed indefinitely.
+   - Note
+5. Once you're done, click the “Save” button.
+
+Once time off expires, it will disappear.
+
+![Create time off drawer](/images/user-guides/vendor/stores/13.png)
+
+### Edit Time Off
+
+To edit a time off:
+
+1. Go to “Settings” in the sidebar.
+2. Go to “Store” in the sidebar.
+3. Click the icon in the time off row.
+4. Choose “Edit” from the dropdown.
+5. In the side window, you can edit:
+   - First day
+   - Last day. If you leave this field empty, the store will be closed indefinitely.
+   - Note
+6. Once you're done, click the “Save” button.
+
+![Edit time off drawer](/images/user-guides/vendor/stores/14.png)
+
+### Delete Time Off
+
+To delete a time off:
+
+1. Go to “Settings” in the sidebar.
+2. Go to “Store” in the sidebar.
+3. Click the icon in the time off row.
+4. Choose “Delete” from the dropdown.

package/llms.txt

@@ -0,0 +1,307 @@
+# Mercur Documentation
+
+Bundled documentation for the Mercur marketplace framework. AI agents:
+read this index, then open the referenced file under `content/` for the
+full page before implementing anything. Paths are relative to this
+package (`node_modules/@mercurjs/docs/`).
+
+## Learn — concepts and getting started
+
+- [Overview](content/learn/architecture.mdx) — How Mercur is built — architecture, technology stack, and how the pieces fit together.
+- [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.
+- [Blocks](content/learn/blocks.mdx) — Self-contained pieces of marketplace functionality that get copied into your project as source code.
+- [Commission](content/learn/commissions.mdx) — How marketplace commissions work in Mercur — rates, rules, the matching algorithm, and commission lines.
+- [Concepts](content/learn/concepts.mdx) — Core concepts behind Mercur — from the Medusa foundation to blocks, panels, and the registry.
+- [Installation](content/learn/installation.mdx) — Install Mercur and set up your marketplace project.
+- [Introduction](content/learn/introduction.mdx) — Mercur is an open-source marketplace platform built on MedusaJS with a block-based architecture.
+- [Offers](content/learn/offers.mdx) — An offer is a seller's sellable listing against a master product — their own SKU, price, inventory, and shipping.
+- [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.
+- [Payout](content/learn/payouts.mdx) — How seller payouts work in Mercur — accounts, onboarding, payment capture, and the transfer pipeline.
+- [Product Requests & Approvals](content/learn/product-requests.mdx) — How vendor product submissions and edits are reviewed — the ProductChange pipeline that keeps a shared catalog under operator control.
+- [Products](content/learn/products.mdx) — Mercur products are master products — a single shared catalog for the whole marketplace, with selling eligibility instead of ownership.
+- [Registry](content/learn/registry.mdx) — Create, build, and host your own block registry.
+- [Seller Members](content/learn/seller-members.mdx) — Multi-user seller accounts — member data, team management, store switching, and access rules.
+- [Seller](content/learn/sellers.mdx) — The central marketplace actor — seller profile, lifecycle, registration flows, and business rules.
+
+## Resources — tutorials, integrations, deployment
+
+- [LLMs](content/resources/ai/llms.mdx) — Feed Mercur documentation directly to LLMs for accurate, context-aware assistance.
+- [MCP Server](content/resources/ai/mcp.mdx) — Connect your AI environment to Mercur documentation via Model Context Protocol.
+- [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.
+- [Custom Fields](content/resources/customization/custom-fields.mdx) — Extend any Medusa entity with additional fields without modifying core code.
+- [Extend a workflow](content/resources/customization/extend-a-workflow.mdx) — Inject custom logic into an existing Mercur workflow through hooks — without rewriting it.
+- [Extending Panels](content/resources/customization/extending-panels.mdx) — Add pages, customize navigation, branding, and replace components in the admin and vendor panels.
+- [Medusa Cloud deployment](content/resources/deployment/medusa-cloud.mdx) — Deploy Mercur — backend, admin panel, and vendor panel — on Medusa Cloud.
+- [Notifications](content/resources/integrations/notifications.mdx) — Send transactional emails and marketplace notifications with Resend.
+- [Search](content/resources/integrations/search.mdx) — Mercur's provider-agnostic search module — zero-infrastructure Orama by default, swappable for Algolia, Meilisearch, or your own provider.
+- [Stripe Connect Integration](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.
+- [Add a feature with a block](content/resources/tutorials/add-a-block.mdx) — Install the reviews block end-to-end and see it live across the admin, vendor, and storefront surfaces.
+- [Create attributes and variant axes](content/resources/tutorials/attributes-and-variant-axes.mdx) — Build the attribute catalog: a filterable attribute, a variant axis backed by a native product option, and an inline product-scoped axis.
+- [Build your own block](content/resources/tutorials/build-a-block.mdx) — Author a reusable feature as a block — backend, panel UI, and docs — build it into a registry, and install it into any Mercur project.
+- [Configure commissions](content/resources/tutorials/configure-commissions.mdx) — Set the global commission, add scoped rules for categories and sellers, and confirm the right rate lands on an order.
+- [Add a custom API route](content/resources/tutorials/custom-api-route.mdx) — Create a backend endpoint, regenerate the route map, and call it from a panel page with full type safety end to end.
+- [Add a custom panel page](content/resources/tutorials/custom-panel-page.mdx) — Add a page to the vendor portal with file-based routing — the dashboard SDK wires it in automatically.
+- [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.
+- [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.
+- [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.
+- [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.
+- [Re-compose a built-in page](content/resources/tutorials/recompose-a-page.mdx) — Override a built-in panel page by dropping a route file at the same path and re-composing its compound component slots.
+- [Replace panel components](content/resources/tutorials/replace-panel-components.mdx) — Swap the sidebar, topbar actions, or store setup screen for your own components through dashboard SDK configuration.
+- [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.
+
+## Tools — CLI, API client, dashboard SDK
+
+- [API Client](content/tools/api-client.mdx) — Type-safe client for consuming Mercur APIs.
+- [CLI](content/tools/cli.mdx) — Install blocks, scaffold projects, and generate types from the command line.
+- [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.
+
+## References — modules, HTTP API, configuration
+
+- [Admin API](content/references/api/admin.mdx) — Operator routes under /admin/* — sellers, commissions, payouts, master catalog, and marketplace-wide orders.
+- [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.
+- [Create Commission Rate](content/references/api/admin/commission-rates/create-commission-rate.mdx) — Create a commission rate.
+- [Delete Commission Rate](content/references/api/admin/commission-rates/delete-commission-rate.mdx) — Delete a commission rate.
+- [List Commission Rates](content/references/api/admin/commission-rates/list-commission-rates.mdx) — Retrieve a paginated list of commission rates.
+- [Retrieve Commission Rate](content/references/api/admin/commission-rates/retrieve-commission-rate.mdx) — Retrieve a commission rate by ID.
+- [Update Commission Rate](content/references/api/admin/commission-rates/update-commission-rate.mdx) — Update a commission rate.
+- [List Members](content/references/api/admin/members/list-members.mdx) — Retrieve a paginated list of members across all sellers.
+- [Batch Create Offers](content/references/api/admin/offers/batch-create-offers.mdx) — Create up to 100 offers for a seller in one request.
+- [Delete Offer](content/references/api/admin/offers/delete-offer.mdx) — Delete an offer.
+- [List Offers](content/references/api/admin/offers/list-offers.mdx) — Retrieve a paginated list of offers across all sellers.
+- [Retrieve Offer](content/references/api/admin/offers/retrieve-offer.mdx) — Retrieve an offer by ID.
+- [List Order Groups](content/references/api/admin/order-groups/list-order-groups.mdx) — Retrieve a paginated list of order groups.
+- [Retrieve Order Group](content/references/api/admin/order-groups/retrieve-order-group.mdx) — Retrieve an order group by ID.
+- [Get Order Commission Lines](content/references/api/admin/orders/get-order-commission-lines.mdx) — Retrieve the commission lines calculated for an order.
+- [Get Order's Order Group](content/references/api/admin/orders/get-order-order-group.mdx) — Retrieve the order group a specific order belongs to.
+- [List Orders](content/references/api/admin/orders/list-orders.mdx) — Retrieve a paginated list of orders across all sellers.
+- [List Payouts](content/references/api/admin/payouts/list-payouts.mdx) — Retrieve a paginated list of payouts across all sellers.
+- [Retrieve Payout](content/references/api/admin/payouts/retrieve-payout.mdx) — Retrieve a payout by ID.
+- [Upsert Attribute Values](content/references/api/admin/product-attributes/create-attribute-value.mdx) — Create or update values on a product attribute.
+- [Create Product Attribute](content/references/api/admin/product-attributes/create-product-attribute.mdx) — Create a catalog product attribute.
+- [Delete Attribute Value](content/references/api/admin/product-attributes/delete-attribute-value.mdx) — Delete a value from a product attribute.
+- [Delete Product Attribute](content/references/api/admin/product-attributes/delete-product-attribute.mdx) — Delete a catalog product attribute.
+- [List Product Attributes](content/references/api/admin/product-attributes/list-product-attributes.mdx) — Retrieve a paginated list of catalog product attributes.
+- [Retrieve Product Attribute](content/references/api/admin/product-attributes/retrieve-product-attribute.mdx) — Retrieve a catalog product attribute by ID.
+- [Update Attribute Value](content/references/api/admin/product-attributes/update-attribute-value.mdx) — Update a single value on a product attribute.
+- [Update Product Attribute](content/references/api/admin/product-attributes/update-product-attribute.mdx) — Update a catalog product attribute.
+- [Cancel Product Change](content/references/api/admin/product-changes/cancel-product-change.mdx) — Cancel a pending product change without applying it.
+- [Confirm Product Change](content/references/api/admin/product-changes/confirm-product-change.mdx) — Approve a pending product change and apply it to the product.
+- [Batch Product Attributes](content/references/api/admin/products/batch-product-attributes.mdx) — Add, remove, and update attributes on a product in one request.
+- [Confirm Product](content/references/api/admin/products/confirm-product.mdx) — Approve a proposed product for publishing.
+- [Create Product Variant](content/references/api/admin/products/create-product-variant.mdx) — Add a variant to a product.
+- [Create Product](content/references/api/admin/products/create-product.mdx) — Create a master catalog product.
+- [Delete Product Variant](content/references/api/admin/products/delete-product-variant.mdx) — Delete a variant from a product.
+- [Delete Product](content/references/api/admin/products/delete-product.mdx) — Delete a master catalog product.
+- [List Product Variants](content/references/api/admin/products/list-product-variants.mdx) — Retrieve a paginated list of a product's variants.
+- [List Products](content/references/api/admin/products/list-products.mdx) — Retrieve a paginated list of master catalog products.
+- [Preview Product Changes](content/references/api/admin/products/preview-product.mdx) — Retrieve the pending change set for a product.
+- [Reject Product](content/references/api/admin/products/reject-product.mdx) — Reject a proposed product.
+- [Request Product Changes](content/references/api/admin/products/request-product-changes.mdx) — Ask the vendor to revise a product before it can be published.
+- [Retrieve Product Variant](content/references/api/admin/products/retrieve-product-variant.mdx) — Retrieve a single variant of a product.
+- [Retrieve Product](content/references/api/admin/products/retrieve-product.mdx) — Retrieve a master catalog product by ID.
+- [Set Product Sellers](content/references/api/admin/products/set-product-sellers.mdx) — Manage which sellers are eligible to sell a product.
+- [Update Product Variant](content/references/api/admin/products/update-product-variant.mdx) — Update a variant of a product.
+- [Update Product](content/references/api/admin/products/update-product.mdx) — Update a master catalog product.
+- [Add Seller Member](content/references/api/admin/sellers/add-seller-member.mdx) — Add an existing member to a seller's team.
+- [Approve Seller](content/references/api/admin/sellers/approve-seller.mdx) — Approve a pending seller.
+- [Create Seller](content/references/api/admin/sellers/create-seller.mdx) — Create a new seller account.
+- [Delete Member Invite](content/references/api/admin/sellers/delete-member-invite.mdx) — Delete a seller's member invite.
+- [Delete Professional Details](content/references/api/admin/sellers/delete-professional-details.mdx) — Delete a seller's professional details.
+- [Invite Seller Member](content/references/api/admin/sellers/invite-seller-member.mdx) — Invite a new member to a seller's team by email.
+- [List Member Invites](content/references/api/admin/sellers/list-member-invites.mdx) — Retrieve a paginated list of a seller's member invites.
+- [List Seller Members](content/references/api/admin/sellers/list-seller-members.mdx) — Retrieve a paginated list of a seller's members.
+- [List Seller Products](content/references/api/admin/sellers/list-seller-products.mdx) — Retrieve a paginated list of a seller's products.
+- [List Sellers](content/references/api/admin/sellers/list-sellers.mdx) — Retrieve a paginated list of sellers.
+- [Remove Seller Member](content/references/api/admin/sellers/remove-seller-member.mdx) — Remove a member from a seller's team.
+- [Resend Member Invite](content/references/api/admin/sellers/resend-member-invite.mdx) — Resend a seller's member invite.
+- [Retrieve Seller](content/references/api/admin/sellers/retrieve-seller.mdx) — Retrieve a seller by ID.
+- [Suspend Seller](content/references/api/admin/sellers/suspend-seller.mdx) — Suspend a seller.
+- [Terminate Seller](content/references/api/admin/sellers/terminate-seller.mdx) — Terminate a seller account.
+- [Unsuspend Seller](content/references/api/admin/sellers/unsuspend-seller.mdx) — Lift a seller's suspension.
+- [Unterminate Seller](content/references/api/admin/sellers/unterminate-seller.mdx) — Reverse a seller termination.
+- [Update Seller](content/references/api/admin/sellers/update-seller.mdx) — Update a seller's details.
+- [Upsert Payment Details](content/references/api/admin/sellers/upsert-payment-details.mdx) — Create or update a seller's bank payment details.
+- [Upsert Professional Details](content/references/api/admin/sellers/upsert-professional-details.mdx) — Create or update a seller's legal and tax details.
+- [Upsert Seller Address](content/references/api/admin/sellers/upsert-seller-address.mdx) — Create or update a seller's address.
+- [API conventions](content/references/api/conventions.mdx) — Authentication, seller scoping, pagination, field selection, and webhooks — shared by every Mercur API surface.
+- [Store API](content/references/api/store.mdx) — Storefront routes under /store/* — discovery, multi-vendor carts, checkout, and order groups.
+- [Add Line Item](content/references/api/store/carts/add-line-item.mdx) — Add a seller offer to the cart as a line item.
+- [Add Shipping Method](content/references/api/store/carts/add-shipping-methods.mdx) — Add a seller shipping option to the cart.
+- [Apply Promotions](content/references/api/store/carts/apply-promotions.mdx) — Apply promotion codes to the cart.
+- [Complete Cart](content/references/api/store/carts/complete-cart.mdx) — Complete the cart and split it into per-seller orders under an order group.
+- [List Offers](content/references/api/store/offers/list-offers.mdx) — Retrieve seller offers with per-offer calculated prices.
+- [Retrieve Offer](content/references/api/store/offers/retrieve-offer.mdx) — Retrieve a seller offer by ID with its per-offer calculated price.
+- [List Order Groups](content/references/api/store/order-groups/list-order-groups.mdx) — Retrieve the authenticated customer's order groups.
+- [Retrieve Order Group](content/references/api/store/order-groups/retrieve-order-group.mdx) — Retrieve one of the authenticated customer's order groups by ID.
+- [List Product Attributes](content/references/api/store/product-attributes/list-product-attributes.mdx) — Retrieve active global product attributes.
+- [Retrieve Product Attribute](content/references/api/store/product-attributes/retrieve-product-attribute.mdx) — Retrieve an active global product attribute by ID.
+- [List Product Categories](content/references/api/store/product-categories/list-product-categories.mdx) — Retrieve active, public product categories.
+- [Retrieve Product Category](content/references/api/store/product-categories/retrieve-product-category.mdx) — Retrieve an active, public product category by ID.
+- [List Products](content/references/api/store/products/list-products.mdx) — Retrieve published products from visible sellers.
+- [Retrieve Product](content/references/api/store/products/retrieve-product.mdx) — Retrieve a published product by ID.
+- [Search](content/references/api/store/search/search.mdx) — Query the search index across products and offers.
+- [List Sellers](content/references/api/store/sellers/list-sellers.mdx) — Retrieve open sellers visible on the storefront.
+- [Retrieve Seller](content/references/api/store/sellers/retrieve-seller.mdx) — Retrieve an open seller by ID.
+- [List Shipping Options](content/references/api/store/shipping-options/list-shipping-options.mdx) — Retrieve available shipping options for a cart, grouped by seller.
+- [Vendor API](content/references/api/vendor.mdx) — Seller-scoped routes under /vendor/* — every request operates on the authenticated member's selected seller.
+- [Accept Member Invite](content/references/api/vendor/members/accept-member-invite.mdx) — Accept a seller team invite using its token.
+- [Retrieve Current Member](content/references/api/vendor/members/retrieve-current-member.mdx) — Retrieve the authenticated member's profile for the active seller.
+- [Update Current Member](content/references/api/vendor/members/update-current-member.mdx) — Update the authenticated member's profile.
+- [Batch Create Offers](content/references/api/vendor/offers/batch-create-offers.mdx) — Create up to 100 offers in a single request.
+- [Batch Offer Inventory Items](content/references/api/vendor/offers/batch-offer-inventory-items.mdx) — Link, update, or unlink inventory items on an offer.
+- [Create Offer](content/references/api/vendor/offers/create-offer.mdx) — Create a listing for a product variant.
+- [Delete Offer](content/references/api/vendor/offers/delete-offer.mdx) — Delete one of the seller's offers.
+- [List Offers](content/references/api/vendor/offers/list-offers.mdx) — Retrieve a paginated list of the seller's offers.
+- [Retrieve Offer](content/references/api/vendor/offers/retrieve-offer.mdx) — Retrieve one of the seller's offers by its ID.
+- [Update Offer](content/references/api/vendor/offers/update-offer.mdx) — Update one of the seller's offers.
+- [Cancel Fulfillment](content/references/api/vendor/orders/cancel-fulfillment.mdx) — Cancel a fulfillment on the order.
+- [Cancel Order](content/references/api/vendor/orders/cancel-order.mdx) — Cancel the order.
+- [Complete Order](content/references/api/vendor/orders/complete-order.mdx) — Mark the order as completed.
+- [Create Fulfillment](content/references/api/vendor/orders/create-fulfillment.mdx) — Create a fulfillment for the order's items.
+- [Create Shipment](content/references/api/vendor/orders/create-shipment.mdx) — Create a shipment for a fulfillment.
+- [Get Order Commission Lines](content/references/api/vendor/orders/get-order-commission-lines.mdx) — Retrieve the commission lines charged on the order.
+- [List Order Changes](content/references/api/vendor/orders/list-order-changes.mdx) — Retrieve the change history of an order.
+- [List Orders](content/references/api/vendor/orders/list-orders.mdx) — Retrieve a paginated list of the seller's orders.
+- [Mark Fulfillment as Delivered](content/references/api/vendor/orders/mark-fulfillment-delivered.mdx) — Mark a fulfillment as delivered.
+- [Preview Order](content/references/api/vendor/orders/preview-order.mdx) — Preview the order with its pending order change applied.
+- [Retrieve Order](content/references/api/vendor/orders/retrieve-order.mdx) — Retrieve a single order by ID.
+- [Create Onboarding](content/references/api/vendor/payout-accounts/create-onboarding.mdx) — Start or refresh provider onboarding for a payout account.
+- [Create Payout Account](content/references/api/vendor/payout-accounts/create-payout-account.mdx) — Create the seller's payout account with the configured provider.
+- [Retrieve Payout Account](content/references/api/vendor/payout-accounts/retrieve-payout-account-by-id.mdx) — Retrieve one of the seller's payout accounts by ID.
+- [List Payout Accounts](content/references/api/vendor/payout-accounts/retrieve-payout-account.mdx) — List the seller's payout accounts.
+- [List Payouts](content/references/api/vendor/payouts/list-payouts.mdx) — List the seller's payouts.
+- [Retrieve Payout](content/references/api/vendor/payouts/retrieve-payout.mdx) — Retrieve one of the seller's payouts by ID.
+- [List Product Attributes](content/references/api/vendor/product-attributes/list-product-attributes.mdx) — Retrieve a paginated list of global product attributes.
+- [Retrieve Product Attribute](content/references/api/vendor/product-attributes/retrieve-product-attribute.mdx) — Retrieve a product attribute by its ID.
+- [List Variants](content/references/api/vendor/product-variants/list-variants.mdx) — Retrieve a paginated list of product variants across products.
+- [Batch Product Attributes](content/references/api/vendor/products/batch-product-attributes.mdx) — Stage attribute additions, removals, and updates on a product.
+- [Cancel Product Change](content/references/api/vendor/products/cancel-product-change.mdx) — Cancel the seller's pending change request for a product.
+- [Create Product Variant](content/references/api/vendor/products/create-product-variant.mdx) — Stage the addition of a variant to a product.
+- [Create Product](content/references/api/vendor/products/create-product.mdx) — Create a new product owned by the seller.
+- [Delete Product Variant](content/references/api/vendor/products/delete-product-variant.mdx) — Stage the removal of a product variant as a change request.
+- [Delete Product](content/references/api/vendor/products/delete-product.mdx) — Stage a product deletion as a change request.
+- [List Product Variants](content/references/api/vendor/products/list-product-variants.mdx) — Retrieve a paginated list of a product's variants.
+- [List Products](content/references/api/vendor/products/list-products.mdx) — Retrieve a paginated list of products visible to the seller.
+- [Preview Product Change](content/references/api/vendor/products/preview-product.mdx) — Retrieve the seller's pending change request for a product.
+- [Retrieve Product Variant](content/references/api/vendor/products/retrieve-product-variant.mdx) — Retrieve a single variant of a product.
+- [Retrieve Product](content/references/api/vendor/products/retrieve-product.mdx) — Retrieve a product by its ID.
+- [Update Product Variant](content/references/api/vendor/products/update-product-variant.mdx) — Stage an update to a product variant as a change request.
+- [Update Product](content/references/api/vendor/products/update-product.mdx) — Stage an update to a product as a change request.
+- [Create Seller](content/references/api/vendor/sellers/create-seller.mdx) — Register a new seller account with its first member.
+- [Delete Professional Details](content/references/api/vendor/sellers/delete-professional-details.mdx) — Remove the seller's business registration details.
+- [Invite Seller Member](content/references/api/vendor/sellers/invite-seller-member.mdx) — Invite a new member to the seller's team.
+- [List Member Invites](content/references/api/vendor/sellers/list-member-invites.mdx) — List the seller's pending member invites.
+- [List Seller Members](content/references/api/vendor/sellers/list-seller-members.mdx) — List the members of a seller account.
+- [List Sellers](content/references/api/vendor/sellers/list-sellers.mdx) — List the seller accounts the authenticated member belongs to.
+- [Remove Seller Member](content/references/api/vendor/sellers/remove-seller-member.mdx) — Remove a member from the seller's team.
+- [Retrieve Current Seller Member](content/references/api/vendor/sellers/retrieve-current-seller-member.mdx) — Retrieve the authenticated member's membership in a seller.
+- [Retrieve Current Seller](content/references/api/vendor/sellers/retrieve-current-seller.mdx) — Retrieve the seller the request is scoped to.
+- [Select Seller](content/references/api/vendor/sellers/select-seller.mdx) — Set the active seller for the member's session.
+- [Update Current Seller](content/references/api/vendor/sellers/update-current-seller.mdx) — Update the seller the request is scoped to.
+- [Update Member Role](content/references/api/vendor/sellers/update-member-role.mdx) — Change the role of a seller team member.
+- [Upsert Payment Details](content/references/api/vendor/sellers/upsert-payment-details.mdx) — Create or update the seller's bank account details.
+- [Upsert Professional Details](content/references/api/vendor/sellers/upsert-professional-details.mdx) — Create or update the seller's business registration details.
+- [Upsert Seller Address](content/references/api/vendor/sellers/upsert-seller-address.mdx) — Create or update the seller's address.
+- [Configuration](content/references/configuration.mdx) — withMercur() options, environment variables, and provider configuration.
+- [Commission module](content/references/modules/commission.mdx) — Data models and service methods for the Commission module.
+- [Custom Fields module](content/references/modules/custom-fields.mdx) — Add extra columns to any entity without writing a custom module.
+- [Media module](content/references/modules/media.mdx) — Image records for categories and collections — galleries, thumbnails, banners, and icons.
+- [Offer module](content/references/modules/offer.mdx) — Data models, links, and service methods for the Offer module.
+- [Payout module](content/references/modules/payout.mdx) — Data models, links, service methods, and the provider interface for the Payout module.
+- [Product Attribute module](content/references/modules/product-attribute.mdx) — Data models, links, and service methods for the Product Attribute module.
+- [Product Edit module](content/references/modules/product-edit.mdx) — Data models and lifecycle for product change requests on master products.
+- [Search module](content/references/modules/search.mdx) — The provider-agnostic search module, its document shapes, and the provider contract.
+- [Seller module](content/references/modules/seller.mdx) — Data models, links, and service methods for the Seller module.
+- [References](content/references/overview.mdx) — Technical references for Mercur's modules, HTTP APIs, workflows, and configuration.
+- [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.
+- [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.
+- [listSellerShippingOptionsForCartWorkflow](content/references/workflows/cart/list-seller-shipping-options-for-cart.mdx) — List available shipping options for a cart, grouped by seller.
+- [updateCartSellerPromotionsWorkflow](content/references/workflows/cart/update-cart-seller-promotions.mdx) — Apply, remove, or replace promotion codes on a cart with seller-scoped adjustments.
+- [batchCommissionRulesWorkflow](content/references/workflows/commission/batch-commission-rules.mdx) — Create, update, and delete a commission rate's rules in one call.
+- [createCommissionRatesWorkflow](content/references/workflows/commission/create-commission-rates.mdx) — Create one or more commission rates.
+- [deleteCommissionRatesWorkflow](content/references/workflows/commission/delete-commission-rates.mdx) — Soft-delete commission rates after validating they can be removed.
+- [refreshOrderCommissionLinesWorkflow](content/references/workflows/commission/refresh-order-commission-lines.mdx) — Recompute the commission lines for one or more orders.
+- [updateCommissionRatesWorkflow](content/references/workflows/commission/update-commission-rates.mdx) — Update one or more commission rates.
+- [setCategoryImagesWorkflow](content/references/workflows/media/set-category-images.mdx) — Replace a category's media gallery and icon, enforcing single thumbnail/banner.
+- [setCollectionImagesWorkflow](content/references/workflows/media/set-collection-images.mdx) — Replace a collection's media gallery and icon, enforcing single thumbnail/banner.
+- [acceptMemberInviteWorkflow](content/references/workflows/member/accept-member-invite.mdx) — Redeem an invite token and join a seller's team.
+- [addSellerMemberWorkflow](content/references/workflows/member/add-seller-member.mdx) — Attach an existing member to a seller with a role.
+- [createMemberInvitesWorkflow](content/references/workflows/member/create-member-invites.mdx) — Create tokenized member invitations for sellers.
+- [deleteMemberInviteWorkflow](content/references/workflows/member/delete-member-invite.mdx) — Delete a pending member invite.
+- [removeSellerMemberWorkflow](content/references/workflows/member/remove-seller-member.mdx) — Remove a member from a seller's team.
+- [resendMemberInviteWorkflow](content/references/workflows/member/resend-member-invite.mdx) — Re-issue a member invite with a fresh token.
+- [updateMemberRoleWorkflow](content/references/workflows/member/update-member-role.mdx) — Change a team member's role.
+- [updateMemberWorkflow](content/references/workflows/member/update-member.mdx) — Update member profile fields matching a selector.
+- [batchOfferInventoryItemsWorkflow](content/references/workflows/offer/batch-offer-inventory-items.mdx) — Create, update, and delete an offer's inventory-item links in one call.
+- [createOffersWorkflow](content/references/workflows/offer/create-offers.mdx) — Create seller offers with inventory items and offer-scoped prices.
+- [deleteOffersWorkflow](content/references/workflows/offer/delete-offers.mdx) — Delete one or more offers.
+- [updateOffersWorkflow](content/references/workflows/offer/update-offers.mdx) — Update offer rows and rewrite their price ladders with replace semantics.
+- [getOrderGroupDetailWorkflow](content/references/workflows/order-group/get-order-group-detail.mdx) — Retrieve one order group with per-order aggregated payment and fulfillment statuses.
+- [getOrderGroupsListWorkflow](content/references/workflows/order-group/get-order-groups-list.mdx) — List order groups with pagination and per-order aggregated statuses.
+- [cancelOrderFulfillmentWorkflow](content/references/workflows/order/cancel-order-fulfillment.mdx) — Cancel an unshipped fulfillment and restore reservations and stock.
+- [confirmClaimRequestWorkflow](content/references/workflows/order/confirm-claim-request.mdx) — Confirm a claim request and fix reservations for offer bundles.
+- [confirmExchangeRequestWorkflow](content/references/workflows/order/confirm-exchange-request.mdx) — Confirm an exchange request and fix reservations for offer bundles.
+- [confirmOrderEditRequestWorkflow](content/references/workflows/order/confirm-order-edit-request.mdx) — Confirm an order edit and reconcile offer-bundle reservations.
+- [confirmReturnReceiveWorkflow](content/references/workflows/order/confirm-return-receive.mdx) — Confirm a return receival, offer-aware restock included.
+- [createOrderFulfillmentWorkflow](content/references/workflows/order/create-order-fulfillment.mdx) — Create a fulfillment for order items, offer-bundle aware.
+- [Workflows](content/references/workflows/overview.mdx) — Every workflow exported by @mercurjs/core, grouped by domain.
+- [createOnboardingWorkflow](content/references/workflows/payout/create-onboarding.mdx) — Start a provider onboarding session for a payout account.
+- [createPayoutAccountWorkflow](content/references/workflows/payout/create-payout-account.mdx) — Create a payout account for a seller through the registered payout provider.
+- [createPayoutWorkflow](content/references/workflows/payout/create-payout.mdx) — Issue a payout to a seller through the registered provider.
+- [processPayoutForWebhookWorkflow](content/references/workflows/payout/process-payout-for-webhook.mdx) — Apply a payout provider webhook event to the matching account or payout.
+- [addProductAttributesToProductWorkflow](content/references/workflows/product-attribute/add-product-attributes-to-product.mdx) — Attach existing or inline attributes (and their values) to a product.
+- [createAndLinkProductAttributesToProductWorkflow](content/references/workflows/product-attribute/create-and-link-product-attributes-to-product.mdx) — Batch attach, detach, and update attribute selections on a product.
+- [createProductAttributeValuesWorkflow](content/references/workflows/product-attribute/create-product-attribute-values.mdx) — Add values to an attribute, mirroring them onto its product option.
+- [createProductAttributesWorkflow](content/references/workflows/product-attribute/create-product-attributes.mdx) — Create catalog attributes with values, mirror options, and category links.
+- [deleteProductAttributeValuesWorkflow](content/references/workflows/product-attribute/delete-product-attribute-values.mdx) — Delete attribute values and shrink the mirror option accordingly.
+- [deleteProductAttributesWorkflow](content/references/workflows/product-attribute/delete-product-attributes.mdx) — Delete attributes and their mirror product options.
+- [removeProductAttributesFromProductWorkflow](content/references/workflows/product-attribute/remove-product-attributes-from-product.mdx) — Detach attributes from a product, deleting product-scoped ones.
+- [updateProductAttributeValuesWorkflow](content/references/workflows/product-attribute/update-product-attribute-values.mdx) — Update attribute values matching a selector and re-sync the mirror option.
+- [updateProductAttributesOnProductWorkflow](content/references/workflows/product-attribute/update-product-attributes-on-product.mdx) — Mutate a product's per-attribute value selections.
+- [updateProductAttributesWorkflow](content/references/workflows/product-attribute/update-product-attributes.mdx) — Update attributes matching a selector and sync mirror option titles.
+- [upsertProductAttributeValuesWorkflow](content/references/workflows/product-attribute/upsert-product-attribute-values.mdx) — Create or update attribute values in one call, keyed by id presence.
+- [autoConfirmProductChangeWorkflow](content/references/workflows/product-edit/auto-confirm-product-change.mdx) — Conditionally confirm a ProductChange based on the product_request feature flag.
+- [cancelProductChangeWorkflow](content/references/workflows/product-edit/cancel-product-change.mdx) — Cancel a pending ProductChange so its staged actions are never applied.
+- [confirmProductChangeWorkflow](content/references/workflows/product-edit/confirm-product-change.mdx) — Confirm pending ProductChanges and apply their staged actions to the master product.
+- [createProductChangeWorkflow](content/references/workflows/product-edit/create-product-change.mdx) — Create ProductChange records after validating no pending change exists per product.
+- [rejectProductChangeWorkflow](content/references/workflows/product-edit/reject-product-change.mdx) — Decline a pending ProductChange with an optional reason for the vendor.
+- [stageProductChangeWorkflow](content/references/workflows/product-edit/stage-product-change.mdx) — Stage a pending ProductChange with its actions and optionally auto-confirm it.
+- [confirmProductsWorkflow](content/references/workflows/product/confirm-products.mdx) — Approve proposed products and publish them to the catalog.
+- [createProductsWorkflow](content/references/workflows/product/create-products.mdx) — Create master catalog products with seller eligibility and creator attribution.
+- [linkSellersToProductCategoryWorkflow](content/references/workflows/product/link-sellers-to-product-category.mdx) — Add or remove seller eligibility links on a product category.
+- [linkSellersToProductWorkflow](content/references/workflows/product/link-sellers-to-product.mdx) — Add or remove seller eligibility links on a master product.
+- [rejectProductWorkflow](content/references/workflows/product/reject-product.mdx) — Reject a proposed product submission with an optional message to the vendor.
+- [requestProductChangeWorkflow](content/references/workflows/product/request-product-change.mdx) — Ask a vendor to revise a proposed product submission without changing its status.
+- [approveSellerWorkflow](content/references/workflows/seller/approve-seller.mdx) — Approve a pending seller and open its store.
+- [createSellerAccountWorkflow](content/references/workflows/seller/create-seller-account.mdx) — Create a seller with its owner member during self-registration.
+- [createSellerDefaultsWorkflow](content/references/workflows/seller/create-seller-defaults.mdx) — Ensure the default seller roles exist.
+- [createSellersWorkflow](content/references/workflows/seller/create-sellers.mdx) — Create one or more sellers and invite their first member.
+- [deleteSellerProfessionalDetailsWorkflow](content/references/workflows/seller/delete-seller-professional-details.mdx) — Remove a seller's professional details.
+- [deleteSellersWorkflow](content/references/workflows/seller/delete-sellers.mdx) — Delete sellers by id.
+- [inviteSellerWorkflow](content/references/workflows/seller/invite-seller.mdx) — Send a marketplace invitation email to a prospective seller.
+- [suspendSellerWorkflow](content/references/workflows/seller/suspend-seller.mdx) — Suspend a seller with an optional reason.
+- [terminateSellerWorkflow](content/references/workflows/seller/terminate-seller.mdx) — Terminate a seller with an optional reason.
+- [unsuspendSellerWorkflow](content/references/workflows/seller/unsuspend-seller.mdx) — Lift a seller suspension.
+- [unterminateSellerWorkflow](content/references/workflows/seller/unterminate-seller.mdx) — Revert a terminated seller back to suspended.
+- [updateSellerAddressWorkflow](content/references/workflows/seller/update-seller-address.mdx) — Upsert a seller's address.
+- [updateSellerPaymentDetailsWorkflow](content/references/workflows/seller/update-seller-payment-details.mdx) — Upsert a seller's bank payment details.
+- [updateSellerProfessionalDetailsWorkflow](content/references/workflows/seller/update-seller-professional-details.mdx) — Upsert a seller's professional (business) details.
+- [updateSellersWorkflow](content/references/workflows/seller/update-sellers.mdx) — Update sellers matching a selector.
+
+## User Guide — admin and vendor panels
+
+- [Admin Panel](content/user-guide/admin/overview.mdx) — What marketplace operators do in the Admin Panel — no technical knowledge required.
+- [Stores in Mercur Admin Panel](content/user-guide/admin/stores.mdx)
+- [Vendor Panel](content/user-guide/vendor/overview.mdx) — What sellers do in the Vendor Panel — no technical knowledge required.
+- [Store in Mercur Vendor Panel](content/user-guide/vendor/stores.mdx)
+
+## Migration
+
+- [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.
+- [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.
+- [Migration Overview](content/migration/overview.mdx) — Understand what changes between Mercur 1.x and 2.0 and how to migrate your project.
+
+## Other
+
+- [Official Blocks](content/blocks.mdx) — Modular blocks from the official Mercur registry — install only what you need.
+- [Telemetry](content/telemetry.mdx) — Learn about the anonymous usage data collected by the Mercur CLI

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@mercurjs/docs",
+  "version": "2.2.0-canary.40",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mercurjs/mercur",
+    "directory": "packages/docs"
+  },
+  "keywords": [
+    "marketplace",
+    "multi-vendor",
+    "medusajs",
+    "documentation",
+    "llms"
+  ],
+  "description": "Bundled Mercur documentation for AI agents — read node_modules/@mercurjs/docs/llms.txt, then open the referenced content/*.mdx.",
+  "author": "Mercur",
+  "license": "MIT",
+  "files": [
+    "content",
+    "llms.txt"
+  ],
+  "scripts": {
+    "build": "node ./scripts/build.mjs",
+    "dev": "node ./scripts/build.mjs"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=20"
+  }
+}