@mercurjs/docs 2.3.8-canary.2 → 2.3.8-canary.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/content/learn/architecture.mdx +166 -263
- package/content/platform/attribute/concepts/attribute-types.mdx +73 -46
- package/content/platform/attribute/concepts/global-vs-inline.mdx +54 -32
- package/content/platform/attribute/concepts/variant-axes.mdx +54 -32
- package/content/platform/attribute/guides/attach-attributes-to-a-product.mdx +96 -53
- package/content/platform/attribute/guides/create-a-variant-axis.mdx +106 -57
- package/content/platform/attribute/guides/create-an-attribute.mdx +105 -56
- package/content/platform/attribute/overview.mdx +37 -33
- package/content/platform/attribute/reference/data-models.mdx +53 -38
- package/content/platform/attribute/reference/events.mdx +47 -24
- package/content/platform/attribute/reference/links.mdx +98 -27
- package/content/platform/attribute/reference/service.mdx +71 -32
- package/content/platform/attribute/reference/workflows.mdx +158 -28
- package/content/platform/catalog/concepts/master-products.mdx +39 -37
- package/content/platform/catalog/concepts/product-seller-allowlist.mdx +56 -35
- package/content/platform/catalog/concepts/status-lifecycle.mdx +55 -49
- package/content/platform/catalog/concepts/variants-categories-collections.mdx +55 -35
- package/content/platform/catalog/guides/allowlist-stores.mdx +100 -37
- package/content/platform/catalog/guides/create-a-master-product.mdx +124 -48
- package/content/platform/catalog/guides/publish-or-reject-a-product.mdx +120 -55
- package/content/platform/catalog/overview.mdx +39 -35
- package/content/platform/catalog/reference/data-models.mdx +154 -43
- package/content/platform/catalog/reference/events.mdx +41 -25
- package/content/platform/catalog/reference/links.mdx +196 -28
- package/content/platform/catalog/reference/service.mdx +57 -35
- package/content/platform/catalog/reference/workflows.mdx +124 -30
- package/content/platform/commission/concepts/order-commission-lines.mdx +54 -52
- package/content/platform/commission/concepts/rule-matching.mdx +53 -63
- package/content/platform/commission/concepts/rules-and-rates.mdx +61 -59
- package/content/platform/commission/guides/batch-update-rules.mdx +69 -41
- package/content/platform/commission/guides/create-a-rate.mdx +101 -53
- package/content/platform/commission/guides/refresh-order-commission-lines.mdx +104 -35
- package/content/platform/commission/overview.mdx +43 -35
- package/content/platform/commission/reference/data-models.mdx +59 -45
- package/content/platform/commission/reference/events.mdx +28 -34
- package/content/platform/commission/reference/links.mdx +42 -33
- package/content/platform/commission/reference/service.mdx +103 -28
- package/content/platform/commission/reference/workflows.mdx +101 -27
- package/content/platform/offer/concepts/pricing-and-inventory.mdx +63 -49
- package/content/platform/offer/concepts/shipping.mdx +28 -29
- package/content/platform/offer/concepts/what-is-an-offer.mdx +48 -45
- package/content/platform/offer/guides/bulk-create-offers.mdx +97 -61
- package/content/platform/offer/guides/create-an-offer.mdx +112 -60
- package/content/platform/offer/guides/manage-offer-inventory.mdx +78 -38
- package/content/platform/offer/overview.mdx +39 -32
- package/content/platform/offer/reference/data-models.mdx +77 -47
- package/content/platform/offer/reference/events.mdx +44 -18
- package/content/platform/offer/reference/links.mdx +92 -40
- package/content/platform/offer/reference/service.mdx +66 -31
- package/content/platform/offer/reference/workflows.mdx +146 -37
- package/content/platform/order-group/concepts/computed-totals.mdx +40 -37
- package/content/platform/order-group/concepts/order-splitting.mdx +41 -39
- package/content/platform/order-group/concepts/the-order-group.mdx +39 -32
- package/content/platform/order-group/guides/list-order-groups.mdx +96 -56
- package/content/platform/order-group/guides/retrieve-an-order-group.mdx +93 -42
- package/content/platform/order-group/guides/split-a-cart.mdx +115 -40
- package/content/platform/order-group/overview.mdx +42 -32
- package/content/platform/order-group/reference/data-models.mdx +48 -31
- package/content/platform/order-group/reference/events.mdx +29 -17
- package/content/platform/order-group/reference/links.mdx +90 -29
- package/content/platform/order-group/reference/service.mdx +55 -31
- package/content/platform/order-group/reference/workflows.mdx +83 -24
- package/content/platform/payout/concepts/account-lifecycle.mdx +64 -67
- package/content/platform/payout/concepts/accounts-and-onboarding.mdx +50 -40
- package/content/platform/payout/concepts/payout-pipeline.mdx +70 -73
- package/content/platform/payout/guides/create-a-payout-account.mdx +65 -41
- package/content/platform/payout/guides/process-a-provider-webhook.mdx +84 -38
- package/content/platform/payout/guides/start-provider-onboarding.mdx +90 -46
- package/content/platform/payout/overview.mdx +43 -34
- package/content/platform/payout/reference/data-models.mdx +63 -36
- package/content/platform/payout/reference/events.mdx +56 -30
- package/content/platform/payout/reference/links.mdx +52 -22
- package/content/platform/payout/reference/service.mdx +72 -33
- package/content/platform/payout/reference/workflows.mdx +80 -19
- package/content/platform/product-edit/concepts/change-actions.mdx +52 -45
- package/content/platform/product-edit/concepts/change-pipeline.mdx +60 -52
- package/content/platform/product-edit/concepts/status-and-auto-confirm.mdx +43 -46
- package/content/platform/product-edit/guides/confirm-or-decline-a-change.mdx +104 -56
- package/content/platform/product-edit/guides/edit-a-product.mdx +126 -46
- package/content/platform/product-edit/guides/request-a-revision.mdx +99 -39
- package/content/platform/product-edit/overview.mdx +41 -34
- package/content/platform/product-edit/reference/data-models.mdx +73 -47
- package/content/platform/product-edit/reference/events.mdx +39 -29
- package/content/platform/product-edit/reference/links.mdx +32 -24
- package/content/platform/product-edit/reference/service.mdx +45 -26
- package/content/platform/product-edit/reference/workflows.mdx +173 -31
- package/content/platform/review/concepts/product-vs-seller-reviews.mdx +42 -41
- package/content/platform/review/concepts/ratings-and-moderation.mdx +45 -44
- package/content/platform/review/concepts/the-review-model.mdx +52 -45
- package/content/platform/review/guides/compute-aggregate-ratings.mdx +62 -37
- package/content/platform/review/guides/create-a-review.mdx +109 -39
- package/content/platform/review/guides/moderate-a-review.mdx +83 -37
- package/content/platform/review/guides/respond-to-a-review.mdx +85 -40
- package/content/platform/review/overview.mdx +43 -33
- package/content/platform/review/reference/data-models.mdx +41 -27
- package/content/platform/review/reference/events.mdx +55 -37
- package/content/platform/review/reference/links.mdx +80 -22
- package/content/platform/review/reference/service.mdx +61 -33
- package/content/platform/review/reference/workflows.mdx +80 -24
- package/content/platform/store/concepts/lifecycle.mdx +68 -44
- package/content/platform/store/concepts/store-entity.mdx +45 -27
- package/content/platform/store/concepts/team.mdx +56 -35
- package/content/platform/store/guides/create-a-store.mdx +102 -35
- package/content/platform/store/guides/manage-the-team.mdx +122 -32
- package/content/platform/store/guides/moderate-a-store.mdx +107 -38
- package/content/platform/store/overview.mdx +41 -34
- package/content/platform/store/reference/data-models.mdx +132 -57
- package/content/platform/store/reference/events.mdx +42 -17
- package/content/platform/store/reference/links.mdx +67 -49
- package/content/platform/store/reference/service.mdx +105 -33
- package/content/platform/store/reference/workflows.mdx +304 -24
- package/content/references/panel-extensions/layouts.mdx +169 -0
- package/llms.txt +112 -111
- package/package.json +1 -1
package/llms.txt
CHANGED
|
@@ -7,7 +7,7 @@ package (`node_modules/@mercurjs/docs/`).
|
|
|
7
7
|
|
|
8
8
|
## Learn — concepts and getting started
|
|
9
9
|
|
|
10
|
-
- [Architecture](content/learn/architecture.mdx) —
|
|
10
|
+
- [Architecture](content/learn/architecture.mdx) — What runs where in a Mercur project, which package does what, and where your own code goes.
|
|
11
11
|
- [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.
|
|
12
12
|
- [Blocks](content/learn/blocks.mdx) — Self-contained pieces of marketplace functionality that get copied into your project as source code.
|
|
13
13
|
- [Commission](content/learn/commissions.mdx) — How marketplace commissions work in Mercur — rates, rules, the matching algorithm, and commission lines.
|
|
@@ -206,6 +206,7 @@ package (`node_modules/@mercurjs/docs/`).
|
|
|
206
206
|
- [Reference](content/references/overview.mdx) — Technical reference for Mercur's HTTP APIs, panel extensions, and configuration.
|
|
207
207
|
- [Create a new page](content/references/panel-extensions/create-page.mdx) — Add a page to the admin or vendor panel with file-based routing, then register it in the sidebar.
|
|
208
208
|
- [Custom Fields](content/references/panel-extensions/custom-fields.mdx) — Add fields, detail rows, section actions, and list columns to a built-in model.
|
|
209
|
+
- [Layouts and layers](content/references/panel-extensions/layouts.mdx) — How extensions from plugins and your project stack, how a page exposes its sections, and how to hide, reorder, replace or wrap what a page renders.
|
|
209
210
|
- [Panel extensions](content/references/panel-extensions/overview.mdx) — Customize the admin and vendor panels with pages, widgets, custom fields, and navigation, without forking them.
|
|
210
211
|
- [Widgets](content/references/panel-extensions/widgets.mdx) — Render a React component in a fixed slot on a built-in admin or vendor page.
|
|
211
212
|
|
|
@@ -243,114 +244,114 @@ package (`node_modules/@mercurjs/docs/`).
|
|
|
243
244
|
|
|
244
245
|
- [Official Blocks](content/blocks.mdx) — Modular blocks from the official Mercur registry — install only what you need.
|
|
245
246
|
- [Mercur Documentation](content/home.mdx) — The open-source enterprise marketplace platform. Composable, API-first, and AI-native, on infrastructure you own.
|
|
246
|
-
- [Attribute types](content/platform/attribute/concepts/attribute-types.mdx) — The five attribute types and the
|
|
247
|
-
- [Global
|
|
248
|
-
- [Variant axes](content/platform/attribute/concepts/variant-axes.mdx) — How
|
|
249
|
-
- [Attach attributes to a product](content/platform/attribute/guides/attach-attributes-to-a-product.mdx) — Attach, detach, and update a product's attributes in one batch
|
|
250
|
-
- [Create a variant axis](content/platform/attribute/guides/create-a-variant-axis.mdx) —
|
|
251
|
-
- [Create
|
|
252
|
-
- [
|
|
253
|
-
- [
|
|
254
|
-
- [
|
|
255
|
-
- [
|
|
256
|
-
- [
|
|
257
|
-
- [
|
|
258
|
-
- [Master products](content/platform/catalog/concepts/master-products.mdx) —
|
|
259
|
-
- [
|
|
260
|
-
- [
|
|
261
|
-
- [Variants, categories
|
|
262
|
-
- [
|
|
263
|
-
- [Create a master product](content/platform/catalog/guides/create-a-master-product.mdx) —
|
|
264
|
-
- [Publish or reject a product](content/platform/catalog/guides/publish-or-reject-a-product.mdx) —
|
|
265
|
-
- [Catalog](content/platform/catalog/overview.mdx) —
|
|
266
|
-
- [
|
|
267
|
-
- [
|
|
268
|
-
- [
|
|
269
|
-
- [
|
|
270
|
-
- [
|
|
271
|
-
- [
|
|
272
|
-
- [
|
|
273
|
-
- [
|
|
274
|
-
- [Batch-update commission rules](content/platform/commission/guides/batch-update-rules.mdx) —
|
|
275
|
-
- [Create a commission rate](content/platform/commission/guides/create-a-rate.mdx) — Create
|
|
276
|
-
- [Refresh order commission lines](content/platform/commission/guides/refresh-order-commission-lines.mdx) — Recompute
|
|
277
|
-
- [
|
|
278
|
-
- [
|
|
279
|
-
- [
|
|
280
|
-
- [
|
|
281
|
-
- [
|
|
282
|
-
- [
|
|
283
|
-
- [
|
|
284
|
-
- [
|
|
285
|
-
- [What is an offer](content/platform/offer/concepts/what-is-an-offer.mdx) — The offer record, how it points at a master
|
|
286
|
-
- [
|
|
287
|
-
- [Create an offer](content/platform/offer/guides/create-an-offer.mdx) —
|
|
288
|
-
- [
|
|
289
|
-
- [
|
|
290
|
-
- [
|
|
291
|
-
- [
|
|
292
|
-
- [
|
|
293
|
-
- [
|
|
294
|
-
- [
|
|
295
|
-
- [
|
|
296
|
-
- [
|
|
297
|
-
- [
|
|
298
|
-
- [List order groups](content/platform/order-group/guides/list-order-groups.mdx) — Page through order groups and scope them to
|
|
299
|
-
- [Retrieve an order group](content/platform/order-group/guides/retrieve-an-order-group.mdx) — Load
|
|
300
|
-
- [Split a cart into
|
|
301
|
-
- [Order
|
|
302
|
-
- [
|
|
303
|
-
- [
|
|
304
|
-
- [
|
|
305
|
-
- [
|
|
306
|
-
- [
|
|
307
|
-
- [
|
|
308
|
-
- [
|
|
309
|
-
- [
|
|
310
|
-
- [Create a payout account](content/platform/payout/guides/create-a-payout-account.mdx) —
|
|
311
|
-
- [Process
|
|
312
|
-
- [Start provider onboarding](content/platform/payout/guides/start-provider-onboarding.mdx) —
|
|
313
|
-
- [
|
|
314
|
-
- [
|
|
315
|
-
- [
|
|
316
|
-
- [
|
|
317
|
-
- [
|
|
318
|
-
- [
|
|
319
|
-
- [
|
|
320
|
-
- [
|
|
321
|
-
- [
|
|
322
|
-
- [Confirm or
|
|
323
|
-
- [
|
|
324
|
-
- [
|
|
325
|
-
- [Product
|
|
326
|
-
- [
|
|
327
|
-
- [
|
|
328
|
-
- [
|
|
329
|
-
- [
|
|
330
|
-
- [
|
|
331
|
-
- [Product
|
|
332
|
-
- [
|
|
333
|
-
- [
|
|
334
|
-
- [
|
|
335
|
-
- [Create a review](content/platform/review/guides/create-a-review.mdx) —
|
|
336
|
-
- [
|
|
337
|
-
- [
|
|
338
|
-
- [
|
|
339
|
-
- [
|
|
340
|
-
- [
|
|
341
|
-
- [
|
|
342
|
-
- [
|
|
343
|
-
- [
|
|
344
|
-
- [
|
|
345
|
-
- [
|
|
346
|
-
- [
|
|
347
|
-
- [Create a store](content/platform/store/guides/create-a-store.mdx) — Create a
|
|
348
|
-
- [Manage
|
|
349
|
-
- [
|
|
350
|
-
- [
|
|
351
|
-
- [
|
|
352
|
-
- [
|
|
353
|
-
- [
|
|
354
|
-
- [
|
|
355
|
-
- [
|
|
247
|
+
- [Attribute types and values](content/platform/attribute/concepts/attribute-types.mdx) — The five attribute types, how each one stores its values, and the flags every attribute carries.
|
|
248
|
+
- [Global and inline attributes](content/platform/attribute/concepts/global-vs-inline.mdx) — Catalog-wide attributes, attributes scoped to one product, category scoping, and storefront filters.
|
|
249
|
+
- [Variant axes and product options](content/platform/attribute/concepts/variant-axes.mdx) — How a multi_select axis attribute mirrors a native Medusa ProductOption, and how products pick a subset of its values.
|
|
250
|
+
- [Attach attributes to a product](content/platform/attribute/guides/attach-attributes-to-a-product.mdx) — Attach, detach, and update a product's attributes in one run of the batch workflow.
|
|
251
|
+
- [Create a variant axis and build variants on it](content/platform/attribute/guides/create-a-variant-axis.mdx) — Create a multi_select axis attribute, then create a product whose variants bind to it.
|
|
252
|
+
- [Create a catalog attribute](content/platform/attribute/guides/create-an-attribute.mdx) — Create a global attribute with its values from a route, a seed script, or a catalog import.
|
|
253
|
+
- [Attributes](content/platform/attribute/overview.mdx) — Describe the shared catalog with typed attributes, turn them into variant axes, and expose them as storefront filters.
|
|
254
|
+
- [Attribute data models](content/platform/attribute/reference/data-models.mdx) — Every field on ProductAttribute and ProductAttributeValue, with defaults, nullability, indexes, and relations.
|
|
255
|
+
- [Attribute events](content/platform/attribute/reference/events.mdx) — Events the Product Attribute workflows emit, when they fire, and their payloads.
|
|
256
|
+
- [Attribute links](content/platform/attribute/reference/links.mdx) — The five module links between the Product Attribute module and Medusa's Product module.
|
|
257
|
+
- [Product Attribute module service](content/platform/attribute/reference/service.mdx) — Resolve the Product Attribute module service, and the generated and overridden methods it exposes.
|
|
258
|
+
- [Attribute workflows](content/platform/attribute/reference/workflows.mdx) — Every catalog and product attachment workflow in the Product Attribute domain, with inputs, hooks, and events.
|
|
259
|
+
- [Master products in a shared catalog](content/platform/catalog/concepts/master-products.mdx) — Why products belong to the marketplace catalog instead of a store, and how Mercur records who submitted each one.
|
|
260
|
+
- [Restrict a product to chosen stores](content/platform/catalog/concepts/product-seller-allowlist.mdx) — How the product_seller link opens a product to every store or restricts it to the stores on its list.
|
|
261
|
+
- [Product status lifecycle](content/platform/catalog/concepts/status-lifecycle.mdx) — How a master product moves from draft or proposed to published or rejected, and which workflow runs each step.
|
|
262
|
+
- [Variants, categories, and collections](content/platform/catalog/concepts/variants-categories-collections.mdx) — The Medusa Product module models that structure the shared catalog, and the places Mercur extends them.
|
|
263
|
+
- [Restrict a product to chosen stores](content/platform/catalog/guides/allowlist-stores.mdx) — Add stores to a product's allowlist, remove them, and open a product to every store again from server code.
|
|
264
|
+
- [Create a master product from server code](content/platform/catalog/guides/create-a-master-product.mdx) — Add a product to the shared catalog with Mercur's createProductsWorkflow, including attributes, variants, and an allowlist.
|
|
265
|
+
- [Publish or reject a proposed product](content/platform/catalog/guides/publish-or-reject-a-product.mdx) — Review a store's product submission from server code: publish it, reject it, or ask for a revision.
|
|
266
|
+
- [Catalog](content/platform/catalog/overview.mdx) — Keep one shared product catalog, decide which stores may sell each product, and review what stores submit.
|
|
267
|
+
- [Catalog data models](content/platform/catalog/reference/data-models.mdx) — Every field on the Medusa Product module models the shared catalog is built on, and the relations Mercur adds.
|
|
268
|
+
- [Catalog events](content/platform/catalog/reference/events.mdx) — The events Mercur's product workflows emit, their payloads, and how to subscribe to them.
|
|
269
|
+
- [Catalog module links](content/platform/catalog/reference/links.mdx) — Every Mercur link on Product module models: both sides, cardinality, source file, and how to query it.
|
|
270
|
+
- [Product module service](content/platform/catalog/reference/service.mdx) — Resolve Medusa's Product module service with Modules.PRODUCT and call its methods for catalog records.
|
|
271
|
+
- [Catalog workflows](content/platform/catalog/reference/workflows.mdx) — Mercur's product create, review, allowlist, and category workflows: inputs, hooks, and events.
|
|
272
|
+
- [Commission lines on orders](content/platform/commission/concepts/order-commission-lines.mdx) — What a commission line records, when Mercur writes and rewrites it, and how payouts read it.
|
|
273
|
+
- [How Mercur picks a commission rate](content/platform/commission/concepts/rule-matching.mdx) — The five rule dimensions, AND and OR matching, most-specific-wins, the oldest-rate tie-break, and shipping.
|
|
274
|
+
- [Commission rates and rules](content/platform/commission/concepts/rules-and-rates.mdx) — How a commission rate expresses the marketplace's cut, how rules scope it, and what the global commission does.
|
|
275
|
+
- [Batch-update commission rules](content/platform/commission/guides/batch-update-rules.mdx) — Add, change, and remove a commission rate's rules in one workflow run with batchCommissionRulesWorkflow.
|
|
276
|
+
- [Create a commission rate](content/platform/commission/guides/create-a-rate.mdx) — Create percentage and fixed commission rates from a seed script or API route with createCommissionRatesWorkflow.
|
|
277
|
+
- [Refresh order commission lines](content/platform/commission/guides/refresh-order-commission-lines.mdx) — Recompute commission lines for existing orders, and pass extra data to the commission provider with workflow hooks.
|
|
278
|
+
- [Commissions](content/platform/commission/overview.mdx) — Set the share of each sale the marketplace keeps, scope it to sellers and parts of the catalog, and record it per order line.
|
|
279
|
+
- [Commission data models](content/platform/commission/reference/data-models.mdx) — Every field of CommissionRate, CommissionRule, CommissionRateValue, and CommissionLine.
|
|
280
|
+
- [Commission events](content/platform/commission/reference/events.mdx) — Commission emits no domain events of its own. It listens to four order events and recomputes commission lines.
|
|
281
|
+
- [Commission links to other modules](content/platform/commission/reference/links.mdx) — Commission defines no module links. Rules and lines reference the catalog, sellers, and orders by plain id.
|
|
282
|
+
- [Commission module service](content/platform/commission/reference/service.mdx) — Resolve the Commission module service, its generated and custom methods, and the commission provider interface.
|
|
283
|
+
- [Commission workflows](content/platform/commission/reference/workflows.mdx) — Inputs, outputs, steps, and hooks of the rate, rule, and order-line commission workflows.
|
|
284
|
+
- [How offer prices and stock work](content/platform/offer/concepts/pricing-and-inventory.mdx) — Offer prices live on the variant's shared price set behind an offer_id rule, and offer stock lives in inventory items linked to the offer.
|
|
285
|
+
- [How an offer ships](content/platform/offer/concepts/shipping.mdx) — Each offer names its store's shipping profile, and Mercur links the master product to a profile so multi-store carts keep their shipping methods.
|
|
286
|
+
- [What is an offer](content/platform/offer/concepts/what-is-an-offer.mdx) — The offer record, how it points at a master variant, its SKU rules, and the conditions a store can list under.
|
|
287
|
+
- [Create and update offers in bulk](content/platform/offer/guides/bulk-create-offers.mdx) — List a store’s master variants in a single createOffersWorkflow run, then update or delete them in bulk.
|
|
288
|
+
- [Create an offer from your server code](content/platform/offer/guides/create-an-offer.mdx) — Run createOffersWorkflow to list a master variant for a store with a SKU, price, stock, and shipping profile.
|
|
289
|
+
- [Change the inventory items behind an offer](content/platform/offer/guides/manage-offer-inventory.mdx) — Use batchOfferInventoryItemsWorkflow to link, relink, and unlink existing inventory items on an offer.
|
|
290
|
+
- [Offers](content/platform/offer/overview.mdx) — Let every store sell a shared catalog product with its own SKU, price, stock, condition, and shipping profile.
|
|
291
|
+
- [Offer data models](content/platform/offer/reference/data-models.mdx) — Every field of the Offer and OfferCondition data models in the Offer module.
|
|
292
|
+
- [Offer events](content/platform/offer/reference/events.mdx) — Events the offer workflows emit, with their payloads, for subscribers and side effects.
|
|
293
|
+
- [Offer module links](content/platform/offer/reference/links.mdx) — Every module link that connects offers to stores, the catalog, pricing, inventory, fulfillment, carts, and orders.
|
|
294
|
+
- [Offer module service](content/platform/offer/reference/service.mdx) — Resolve the Offer module service and use its generated and custom methods.
|
|
295
|
+
- [Offer workflows](content/platform/offer/reference/workflows.mdx) — Every offer and offer condition workflow, with its input, hooks, and events.
|
|
296
|
+
- [How order group totals are computed](content/platform/order-group/concepts/computed-totals.mdx) — Why seller_count and total are summed from the child orders at read time, and how child order statuses are derived.
|
|
297
|
+
- [How checkout splits a cart into orders](content/platform/order-group/concepts/order-splitting.mdx) — How completeCartWithSplitOrdersWorkflow turns one multi-seller cart into one order per seller under a group.
|
|
298
|
+
- [What an order group is](content/platform/order-group/concepts/the-order-group.mdx) — The record that ties a multi-seller purchase together: its display id, its customer, its cart, and its child orders.
|
|
299
|
+
- [List and filter order groups](content/platform/order-group/guides/list-order-groups.mdx) — Page through order groups, filter them, and scope them to one seller with getOrderGroupsListWorkflow.
|
|
300
|
+
- [Retrieve an order group with its child orders](content/platform/order-group/guides/retrieve-an-order-group.mdx) — Load one order group, its child orders, and their payment and fulfillment status with getOrderGroupDetailWorkflow.
|
|
301
|
+
- [Split a cart into an order group](content/platform/order-group/guides/split-a-cart.mdx) — Run completeCartWithSplitOrdersWorkflow from your own code and change the split with its validate and setOrderStatus hooks.
|
|
302
|
+
- [Order groups](content/platform/order-group/overview.mdx) — Turn a cart with items from several sellers into per-seller orders under one group the shopper can track.
|
|
303
|
+
- [Order group data models](content/platform/order-group/reference/data-models.mdx) — Fields, indexes, and relations of the OrderGroup data model in the Seller module.
|
|
304
|
+
- [Order group events](content/platform/order-group/reference/events.mdx) — The events emitted when checkout splits a cart into an order group, with their payloads and a subscriber example.
|
|
305
|
+
- [Order group links](content/platform/order-group/reference/links.mdx) — The module links that connect an order group to its cart and child orders, and its orders to sellers and offers.
|
|
306
|
+
- [Order group service methods](content/platform/order-group/reference/service.mdx) — Seller module service methods for OrderGroup records, the filters they accept, and how they compute totals.
|
|
307
|
+
- [Order group workflows](content/platform/order-group/reference/workflows.mdx) — Input, output, hooks, steps, and events of the checkout split and the order group read workflows.
|
|
308
|
+
- [Payout account and payout statuses](content/platform/payout/concepts/account-lifecycle.mdx) — The statuses a payout account and a payout move through, and the provider webhooks that move them.
|
|
309
|
+
- [Payout accounts and onboarding](content/platform/payout/concepts/accounts-and-onboarding.mdx) — How a seller connects to the payout provider, and where provider data such as account ids and onboarding links lives.
|
|
310
|
+
- [How a payout reaches a seller](content/platform/payout/concepts/payout-pipeline.mdx) — What Mercur ships for payouts, what you trigger yourself, and how the provider interface fits in.
|
|
311
|
+
- [Create a payout account for a seller](content/platform/payout/guides/create-a-payout-account.mdx) — Run createPayoutAccountWorkflow from your own route to connect a seller to the payout provider.
|
|
312
|
+
- [Process payout provider webhooks](content/platform/payout/guides/process-a-provider-webhook.mdx) — Route provider webhooks to Mercur so payout accounts and payouts pick up the provider's status changes.
|
|
313
|
+
- [Start provider onboarding for a seller](content/platform/payout/guides/start-provider-onboarding.mdx) — Run createOnboardingWorkflow to get a provider onboarding link, such as a Stripe Connect account link, for a seller.
|
|
314
|
+
- [Payouts](content/platform/payout/overview.mdx) — Connect each seller to a payout provider, onboard them, and transfer their share of an order to their own account.
|
|
315
|
+
- [Payout data models](content/platform/payout/reference/data-models.mdx) — Every field of PayoutAccount, Onboarding, and Payout, plus the PayoutAccountStatus and PayoutStatus enums.
|
|
316
|
+
- [Payout events](content/platform/payout/reference/events.mdx) — The payout webhook event, the data-model events the Payout module emits, and the reserved PayoutEvents names that nothing emits yet.
|
|
317
|
+
- [Payout module links](content/platform/payout/reference/links.mdx) — The 3 module links that connect payout accounts and payouts to sellers and orders.
|
|
318
|
+
- [Payout module service](content/platform/payout/reference/service.mdx) — Resolve the Payout module service, and use its generated data methods and its provider-backed methods.
|
|
319
|
+
- [Payout workflows](content/platform/payout/reference/workflows.mdx) — The 4 payout workflows and 6 payout steps exported from @mercurjs/core/workflows, with their inputs, steps, and hooks.
|
|
320
|
+
- [What a change action records and how it applies](content/platform/product-edit/concepts/change-actions.mdx) — The ProductChangeAction types, the details each one carries, and the order they apply in.
|
|
321
|
+
- [How product changes are staged and recorded](content/platform/product-edit/concepts/change-pipeline.mdx) — How an edit becomes a ProductChange, who can have one open, and how the audit trail builds up.
|
|
322
|
+
- [Change statuses, revision requests, and auto-confirm](content/platform/product-edit/concepts/status-and-auto-confirm.mdx) — The four ProductChangeStatus values, how a revision request fits in, and when a change confirms without review.
|
|
323
|
+
- [Confirm, decline, or cancel a product change](content/platform/product-edit/guides/confirm-or-decline-a-change.mdx) — Resolve a pending product change from server code and react to the result.
|
|
324
|
+
- [Stage a product edit from server code](content/platform/product-edit/guides/edit-a-product.mdx) — Route a product edit through the review pipeline from a custom API route, a script, or a bulk tool.
|
|
325
|
+
- [Send a proposed product back for a revision](content/platform/product-edit/guides/request-a-revision.mdx) — Ask a seller to rework a proposed product, record the request, and notify the seller.
|
|
326
|
+
- [Product edits](content/platform/product-edit/overview.mdx) — Review every seller edit to a shared product before it lands, and keep a record of who changed what.
|
|
327
|
+
- [Product Edit data models](content/platform/product-edit/reference/data-models.mdx) — Fields, enums, indexes, and relations of the ProductChange and ProductChangeAction models.
|
|
328
|
+
- [Product Edit events](content/platform/product-edit/reference/events.mdx) — Events emitted as product changes are staged and resolved, and when an operator requests a revision.
|
|
329
|
+
- [Product Edit links](content/platform/product-edit/reference/links.mdx) — The read-only link that exposes a product's change history as product.changes.
|
|
330
|
+
- [Product Edit module service](content/platform/product-edit/reference/service.mdx) — Resolve the Product Edit module service and call its generated methods for changes and actions.
|
|
331
|
+
- [Product Edit workflows](content/platform/product-edit/reference/workflows.mdx) — Inputs, hooks, and events of every product change workflow, from staging to audit records.
|
|
332
|
+
- [Product reviews and store reviews](content/platform/review/concepts/product-vs-seller-reviews.mdx) — How the reference field picks a review's target, and the four links that anchor every review.
|
|
333
|
+
- [How reviews are moderated and rated](content/platform/review/concepts/ratings-and-moderation.mdx) — The review status values, who can change them, how a store answers, and how average ratings are computed.
|
|
334
|
+
- [What a review stores](content/platform/review/concepts/the-review-model.mdx) — The fields of a review: its target type, rating, the customer's note, the store's answer, and its status.
|
|
335
|
+
- [Show average ratings on your storefront](content/platform/review/guides/compute-aggregate-ratings.mdx) — Serve average ratings for products and stores from a custom route, with the service helpers or from published reviews only.
|
|
336
|
+
- [Create a review from your own route](content/platform/review/guides/create-a-review.mdx) — Run createReviewWorkflow from a custom API route, an import script, or a seed.
|
|
337
|
+
- [Publish, reject, and delete reviews in code](content/platform/review/guides/moderate-a-review.mdx) — Set a review's status with updateReviewWorkflow and remove it with deleteReviewWorkflow.
|
|
338
|
+
- [Answer a review as a store](content/platform/review/guides/respond-to-a-review.mdx) — Attach a store's public answer to a review with respondReviewWorkflow.
|
|
339
|
+
- [Reviews](content/platform/review/overview.mdx) — Let customers rate the products and stores they bought from, then moderate, answer, and average those ratings.
|
|
340
|
+
- [Review data model](content/platform/review/reference/data-models.mdx) — Every field and index of the Review model in the Review module.
|
|
341
|
+
- [Review events](content/platform/review/reference/events.mdx) — The mutation events the Review module service emits, and how to subscribe to them.
|
|
342
|
+
- [Review links](content/platform/review/reference/links.mdx) — The four module links that connect reviews to products, sellers, orders, and customers.
|
|
343
|
+
- [Review module service](content/platform/review/reference/service.mdx) — Resolve the Review module service, its generated CRUD methods, and its three rating helpers.
|
|
344
|
+
- [Review workflows](content/platform/review/reference/workflows.mdx) — The four review workflows, their inputs, steps, compensation, and errors.
|
|
345
|
+
- [Store statuses and transitions](content/platform/store/concepts/lifecycle.mdx) — The four store statuses, the workflow behind each transition, scheduled closures, and the premium flag.
|
|
346
|
+
- [What a store is made of](content/platform/store/concepts/store-entity.mdx) — The seller record, its currency and regions, and the satellite records that hold its business details.
|
|
347
|
+
- [How store teams work](content/platform/store/concepts/team.mdx) — Members, memberships, owners, roles, invites, and how a member picks the store they act for.
|
|
348
|
+
- [Create a store from server code](content/platform/store/guides/create-a-store.mdx) — Create stores with createSellersWorkflow from a route, a seed script, or an import job, and extend creation with hooks.
|
|
349
|
+
- [Manage a store's team from server code](content/platform/store/guides/manage-the-team.mdx) — Invite members, accept invites, add existing members, change roles, and remove members with the Seller module workflows.
|
|
350
|
+
- [Approve, suspend, and terminate stores](content/platform/store/guides/moderate-a-store.mdx) — Move stores through their lifecycle from server code, extend each transition with a hook, and react to the events.
|
|
351
|
+
- [Stores](content/platform/store/overview.mdx) — Control who sells on your marketplace, who works on each store, and when a store can trade.
|
|
352
|
+
- [Seller module data models](content/platform/store/reference/data-models.mdx) — Every data model in the Seller module, with fields, types, defaults, indexes, and relations.
|
|
353
|
+
- [Seller module events](content/platform/store/reference/events.mdx) — Every event the store and team workflows emit, when each fires, and its payload.
|
|
354
|
+
- [Seller module links](content/platform/store/reference/links.mdx) — Every module link that connects the Seller module to other modules, with cardinality, source file, and query.graph aliases.
|
|
355
|
+
- [Seller module service](content/platform/store/reference/service.mdx) — Resolve the Seller module service, and the generated and custom methods it exposes for direct reads and writes.
|
|
356
|
+
- [Seller module workflows](content/platform/store/reference/workflows.mdx) — Every store, lifecycle, business-detail, and team workflow in the Seller module, with inputs, hooks, and events.
|
|
356
357
|
- [Telemetry](content/telemetry.mdx) — Learn about the anonymous usage data collected by the Mercur CLI
|