@mercurjs/docs 2.3.8-canary.3 → 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.
Files changed (113) hide show
  1. package/content/learn/architecture.mdx +166 -263
  2. package/content/platform/attribute/concepts/attribute-types.mdx +73 -46
  3. package/content/platform/attribute/concepts/global-vs-inline.mdx +54 -32
  4. package/content/platform/attribute/concepts/variant-axes.mdx +54 -32
  5. package/content/platform/attribute/guides/attach-attributes-to-a-product.mdx +96 -53
  6. package/content/platform/attribute/guides/create-a-variant-axis.mdx +106 -57
  7. package/content/platform/attribute/guides/create-an-attribute.mdx +105 -56
  8. package/content/platform/attribute/overview.mdx +37 -33
  9. package/content/platform/attribute/reference/data-models.mdx +53 -38
  10. package/content/platform/attribute/reference/events.mdx +47 -24
  11. package/content/platform/attribute/reference/links.mdx +98 -27
  12. package/content/platform/attribute/reference/service.mdx +71 -32
  13. package/content/platform/attribute/reference/workflows.mdx +158 -28
  14. package/content/platform/catalog/concepts/master-products.mdx +39 -37
  15. package/content/platform/catalog/concepts/product-seller-allowlist.mdx +56 -35
  16. package/content/platform/catalog/concepts/status-lifecycle.mdx +55 -49
  17. package/content/platform/catalog/concepts/variants-categories-collections.mdx +55 -35
  18. package/content/platform/catalog/guides/allowlist-stores.mdx +100 -37
  19. package/content/platform/catalog/guides/create-a-master-product.mdx +124 -48
  20. package/content/platform/catalog/guides/publish-or-reject-a-product.mdx +120 -55
  21. package/content/platform/catalog/overview.mdx +39 -35
  22. package/content/platform/catalog/reference/data-models.mdx +154 -43
  23. package/content/platform/catalog/reference/events.mdx +41 -25
  24. package/content/platform/catalog/reference/links.mdx +196 -28
  25. package/content/platform/catalog/reference/service.mdx +57 -35
  26. package/content/platform/catalog/reference/workflows.mdx +124 -30
  27. package/content/platform/commission/concepts/order-commission-lines.mdx +54 -52
  28. package/content/platform/commission/concepts/rule-matching.mdx +53 -63
  29. package/content/platform/commission/concepts/rules-and-rates.mdx +61 -59
  30. package/content/platform/commission/guides/batch-update-rules.mdx +69 -41
  31. package/content/platform/commission/guides/create-a-rate.mdx +101 -53
  32. package/content/platform/commission/guides/refresh-order-commission-lines.mdx +104 -35
  33. package/content/platform/commission/overview.mdx +43 -35
  34. package/content/platform/commission/reference/data-models.mdx +59 -45
  35. package/content/platform/commission/reference/events.mdx +28 -34
  36. package/content/platform/commission/reference/links.mdx +42 -33
  37. package/content/platform/commission/reference/service.mdx +103 -28
  38. package/content/platform/commission/reference/workflows.mdx +101 -27
  39. package/content/platform/offer/concepts/pricing-and-inventory.mdx +63 -49
  40. package/content/platform/offer/concepts/shipping.mdx +28 -29
  41. package/content/platform/offer/concepts/what-is-an-offer.mdx +48 -45
  42. package/content/platform/offer/guides/bulk-create-offers.mdx +97 -61
  43. package/content/platform/offer/guides/create-an-offer.mdx +112 -60
  44. package/content/platform/offer/guides/manage-offer-inventory.mdx +78 -38
  45. package/content/platform/offer/overview.mdx +39 -32
  46. package/content/platform/offer/reference/data-models.mdx +77 -47
  47. package/content/platform/offer/reference/events.mdx +44 -18
  48. package/content/platform/offer/reference/links.mdx +92 -40
  49. package/content/platform/offer/reference/service.mdx +66 -31
  50. package/content/platform/offer/reference/workflows.mdx +146 -37
  51. package/content/platform/order-group/concepts/computed-totals.mdx +40 -37
  52. package/content/platform/order-group/concepts/order-splitting.mdx +41 -39
  53. package/content/platform/order-group/concepts/the-order-group.mdx +39 -32
  54. package/content/platform/order-group/guides/list-order-groups.mdx +96 -56
  55. package/content/platform/order-group/guides/retrieve-an-order-group.mdx +93 -42
  56. package/content/platform/order-group/guides/split-a-cart.mdx +115 -40
  57. package/content/platform/order-group/overview.mdx +42 -32
  58. package/content/platform/order-group/reference/data-models.mdx +48 -31
  59. package/content/platform/order-group/reference/events.mdx +29 -17
  60. package/content/platform/order-group/reference/links.mdx +90 -29
  61. package/content/platform/order-group/reference/service.mdx +55 -31
  62. package/content/platform/order-group/reference/workflows.mdx +83 -24
  63. package/content/platform/payout/concepts/account-lifecycle.mdx +64 -67
  64. package/content/platform/payout/concepts/accounts-and-onboarding.mdx +50 -40
  65. package/content/platform/payout/concepts/payout-pipeline.mdx +70 -73
  66. package/content/platform/payout/guides/create-a-payout-account.mdx +65 -41
  67. package/content/platform/payout/guides/process-a-provider-webhook.mdx +84 -38
  68. package/content/platform/payout/guides/start-provider-onboarding.mdx +90 -46
  69. package/content/platform/payout/overview.mdx +43 -34
  70. package/content/platform/payout/reference/data-models.mdx +63 -36
  71. package/content/platform/payout/reference/events.mdx +56 -30
  72. package/content/platform/payout/reference/links.mdx +52 -22
  73. package/content/platform/payout/reference/service.mdx +72 -33
  74. package/content/platform/payout/reference/workflows.mdx +80 -19
  75. package/content/platform/product-edit/concepts/change-actions.mdx +52 -45
  76. package/content/platform/product-edit/concepts/change-pipeline.mdx +60 -52
  77. package/content/platform/product-edit/concepts/status-and-auto-confirm.mdx +43 -46
  78. package/content/platform/product-edit/guides/confirm-or-decline-a-change.mdx +104 -56
  79. package/content/platform/product-edit/guides/edit-a-product.mdx +126 -46
  80. package/content/platform/product-edit/guides/request-a-revision.mdx +99 -39
  81. package/content/platform/product-edit/overview.mdx +41 -34
  82. package/content/platform/product-edit/reference/data-models.mdx +73 -47
  83. package/content/platform/product-edit/reference/events.mdx +39 -29
  84. package/content/platform/product-edit/reference/links.mdx +32 -24
  85. package/content/platform/product-edit/reference/service.mdx +45 -26
  86. package/content/platform/product-edit/reference/workflows.mdx +173 -31
  87. package/content/platform/review/concepts/product-vs-seller-reviews.mdx +42 -41
  88. package/content/platform/review/concepts/ratings-and-moderation.mdx +45 -44
  89. package/content/platform/review/concepts/the-review-model.mdx +52 -45
  90. package/content/platform/review/guides/compute-aggregate-ratings.mdx +62 -37
  91. package/content/platform/review/guides/create-a-review.mdx +109 -39
  92. package/content/platform/review/guides/moderate-a-review.mdx +83 -37
  93. package/content/platform/review/guides/respond-to-a-review.mdx +85 -40
  94. package/content/platform/review/overview.mdx +43 -33
  95. package/content/platform/review/reference/data-models.mdx +41 -27
  96. package/content/platform/review/reference/events.mdx +55 -37
  97. package/content/platform/review/reference/links.mdx +80 -22
  98. package/content/platform/review/reference/service.mdx +61 -33
  99. package/content/platform/review/reference/workflows.mdx +80 -24
  100. package/content/platform/store/concepts/lifecycle.mdx +68 -44
  101. package/content/platform/store/concepts/store-entity.mdx +45 -27
  102. package/content/platform/store/concepts/team.mdx +56 -35
  103. package/content/platform/store/guides/create-a-store.mdx +102 -35
  104. package/content/platform/store/guides/manage-the-team.mdx +122 -32
  105. package/content/platform/store/guides/moderate-a-store.mdx +107 -38
  106. package/content/platform/store/overview.mdx +41 -34
  107. package/content/platform/store/reference/data-models.mdx +132 -57
  108. package/content/platform/store/reference/events.mdx +42 -17
  109. package/content/platform/store/reference/links.mdx +67 -49
  110. package/content/platform/store/reference/service.mdx +105 -33
  111. package/content/platform/store/reference/workflows.mdx +304 -24
  112. package/llms.txt +111 -111
  113. 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) — How Mercur is put together: the runtime layers, the boundary between the marketplace platform and your own code, and the zones you extend.
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.
@@ -244,114 +244,114 @@ package (`node_modules/@mercurjs/docs/`).
244
244
 
245
245
  - [Official Blocks](content/blocks.mdx) — Modular blocks from the official Mercur registry — install only what you need.
246
246
  - [Mercur Documentation](content/home.mdx) — The open-source enterprise marketplace platform. Composable, API-first, and AI-native, on infrastructure you own.
247
- - [Attribute types](content/platform/attribute/concepts/attribute-types.mdx) — The five attribute types and the values they hold.
248
- - [Global vs inline & filtering](content/platform/attribute/concepts/global-vs-inline.mdx) — Catalog-wide attributes, product-scoped attributes, and storefront filtering.
249
- - [Variant axes](content/platform/attribute/concepts/variant-axes.mdx) — How is_variant_axis mirrors a native ProductOption and generates variants.
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 batch call.
251
- - [Create a variant axis](content/platform/attribute/guides/create-a-variant-axis.mdx) — Generate product variants from a multi_select axis attribute.
252
- - [Create an attribute](content/platform/attribute/guides/create-an-attribute.mdx) — Create a typed catalog attribute with createProductAttributesWorkflow.
253
- - [Attribute](content/platform/attribute/overview.mdx) — An operator-managed, typed attribute catalog for describing and filtering the shared product catalog.
254
- - [Data models](content/platform/attribute/reference/data-models.mdx) — The data models owned by the Attribute (Product Attribute) domain.
255
- - [Event reference](content/platform/attribute/reference/events.mdx) — Events emitted by the Attribute domain, for subscribers and side effects.
256
- - [Links to other modules](content/platform/attribute/reference/links.mdx) — How the Attribute (Product Attribute) domain links to products, categories, and options.
257
- - [Service reference](content/platform/attribute/reference/service.mdx) — The Product Attribute module service, with methods for working with records directly.
258
- - [Workflows](content/platform/attribute/reference/workflows.mdx) — Attribute catalog and product-attachment workflows.
259
- - [Master products](content/platform/catalog/concepts/master-products.mdx) — The shared catalog, why products aren't seller-owned, and submission attribution.
260
- - [The store allowlist](content/platform/catalog/concepts/product-seller-allowlist.mdx) — The product_seller link that controls which stores may sell a master product.
261
- - [Status lifecycle](content/platform/catalog/concepts/status-lifecycle.mdx) — How a master product moves from draft to proposed, published, or rejected.
262
- - [Variants, categories & collections](content/platform/catalog/concepts/variants-categories-collections.mdx) — The native Medusa Product structure the shared catalog is built on.
263
- - [Allowlist stores](content/platform/catalog/guides/allowlist-stores.mdx) — Grant and revoke a store's right to sell a master product from server code.
264
- - [Create a master product](content/platform/catalog/guides/create-a-master-product.mdx) — Create a master product programmatically with createProductsWorkflow.
265
- - [Publish or reject a product](content/platform/catalog/guides/publish-or-reject-a-product.mdx) — Move a proposed master product to published or rejected from server code.
266
- - [Catalog](content/platform/catalog/overview.mdx) — Master products, variants, categories, and the store allowlist that governs who may sell what.
267
- - [Data models](content/platform/catalog/reference/data-models.mdx) — The Medusa Product models the catalog is built on, plus Mercur's marketplace layer.
268
- - [Event reference](content/platform/catalog/reference/events.mdx) — Events emitted by the Catalog domain, for subscribers and side effects.
269
- - [Links to other modules](content/platform/catalog/reference/links.mdx) — How the catalog links to sellers, offers, attributes, and media.
270
- - [Service reference](content/platform/catalog/reference/service.mdx) — Medusa's Product module service: methods for working with records directly.
271
- - [Workflows](content/platform/catalog/reference/workflows.mdx) — Mercur's product create, review, and allowlist workflows.
272
- - [Order commission lines](content/platform/commission/concepts/order-commission-lines.mdx) — Per-order commission lines, how they're computed, and BigNumber precision.
273
- - [Rule matching](content/platform/commission/concepts/rule-matching.mdx) — The five dimensions, most-specific-wins resolution, tie-breaks, and shipping.
274
- - [Rules & rates](content/platform/commission/concepts/rules-and-rates.mdx) — The commission rate, its fixed and percentage forms, and per-currency amounts.
275
- - [Batch-update commission rules](content/platform/commission/guides/batch-update-rules.mdx) — Create, update, and delete a rate's rules in a single call.
276
- - [Create a commission rate](content/platform/commission/guides/create-a-rate.mdx) — Create a commission rate programmatically with createCommissionRatesWorkflow.
277
- - [Refresh order commission lines](content/platform/commission/guides/refresh-order-commission-lines.mdx) — Recompute an order's commission lines after it changes.
278
- - [Commission](content/platform/commission/overview.mdx) — Configure how the marketplace takes its cut of every seller order.
279
- - [Data models](content/platform/commission/reference/data-models.mdx) — The data models owned by the Commission domain.
280
- - [Event reference](content/platform/commission/reference/events.mdx) — How the Commission domain stays in sync with order changes.
281
- - [Links to other modules](content/platform/commission/reference/links.mdx) — How the Commission domain connects to the catalog, sellers, and orders.
282
- - [Service reference](content/platform/commission/reference/service.mdx) — The Commission module service and its methods for working with records directly.
283
- - [Workflows](content/platform/commission/reference/workflows.mdx) — Commission rate, rule, and order-line workflows.
284
- - [Pricing & inventory](content/platform/offer/concepts/pricing-and-inventory.mdx) — Offer-scoped prices on the shared price set, and inventory linked to the offer.
285
- - [Shipping](content/platform/offer/concepts/shipping.mdx) — How an offer carries its own shipping profile.
286
- - [What is an offer](content/platform/offer/concepts/what-is-an-offer.mdx) — The offer record, how it points at a master product variant, and its SKU.
287
- - [Bulk-create offers](content/platform/offer/guides/bulk-create-offers.mdx) — List many offers against the master catalog in a single workflow run.
288
- - [Create an offer](content/platform/offer/guides/create-an-offer.mdx) — Create a single offer programmatically with createOffersWorkflow.
289
- - [Manage offer inventory](content/platform/offer/guides/manage-offer-inventory.mdx) — Attach, update, and detach inventory items on an existing offer.
290
- - [Offer](content/platform/offer/overview.mdx) — How a store sells against the shared master catalog, with its own SKU, price, inventory, and shipping.
291
- - [Data models](content/platform/offer/reference/data-models.mdx) — The data models owned by the Offer domain.
292
- - [Event reference](content/platform/offer/reference/events.mdx) — Events emitted by the Offer domain, for subscribers and side effects.
293
- - [Links to other modules](content/platform/offer/reference/links.mdx) — How the Offer domain links to other modules across the marketplace.
294
- - [Service reference](content/platform/offer/reference/service.mdx) — The Offer module service and its methods for working with records directly.
295
- - [Workflows](content/platform/offer/reference/workflows.mdx) — Offer workflows for creating, updating, deleting, and batching inventory.
296
- - [Computed totals](content/platform/order-group/concepts/computed-totals.mdx) — Why an order group's seller count and total are derived at query time, not stored.
297
- - [Order splitting](content/platform/order-group/concepts/order-splitting.mdx) — How a multi-seller cart becomes a group of independent per-seller orders.
298
- - [The order group](content/platform/order-group/concepts/the-order-group.mdx) — The aggregate record over a multi-seller purchase, its display id, and cart link.
299
- - [List order groups](content/platform/order-group/guides/list-order-groups.mdx) — Page through order groups and scope them to a seller with getOrderGroupsListWorkflow.
300
- - [Retrieve an order group](content/platform/order-group/guides/retrieve-an-order-group.mdx) — Load an order group and its aggregated child orders with getOrderGroupDetailWorkflow.
301
- - [Split a cart into orders](content/platform/order-group/guides/split-a-cart.mdx) — Complete a multi-seller cart into a group of per-seller orders with completeCartWithSplitOrdersWorkflow.
302
- - [Order Group](content/platform/order-group/overview.mdx) — Wrap a multi-seller cart into one shopper-facing order made of independent per-seller orders.
303
- - [Data models](content/platform/order-group/reference/data-models.mdx) — The data model owned by the Order Group domain.
304
- - [Event reference](content/platform/order-group/reference/events.mdx) — Events emitted by the Order Group domain, for subscribers and side effects.
305
- - [Links to other modules](content/platform/order-group/reference/links.mdx) — How the Order Group domain links to carts, orders, sellers, and offers.
306
- - [Service reference](content/platform/order-group/reference/service.mdx) — The Seller module service and its methods for working with order group records directly.
307
- - [Workflows](content/platform/order-group/reference/workflows.mdx) — Order group workflows, service methods, and events.
308
- - [Account lifecycle](content/platform/payout/concepts/account-lifecycle.mdx) — Payout account statuses and the webhook-driven transitions between them.
309
- - [Accounts & onboarding](content/platform/payout/concepts/accounts-and-onboarding.mdx) — The payout account, its onboarding record, and provider-specific data.
310
- - [The payout pipeline](content/platform/payout/concepts/payout-pipeline.mdx) — Capture check, payment capture, daily payout, transfer, and the provider interface.
311
- - [Create a payout account](content/platform/payout/guides/create-a-payout-account.mdx) — Create a seller's payout account with createPayoutAccountWorkflow.
312
- - [Process a provider webhook](content/platform/payout/guides/process-a-provider-webhook.mdx) — Turn a provider webhook into account and payout status updates.
313
- - [Start provider onboarding](content/platform/payout/guides/start-provider-onboarding.mdx) — Kick off provider onboarding with createOnboardingWorkflow.
314
- - [Payout](content/platform/payout/overview.mdx) — Onboard sellers to a payment provider and settle their earnings automatically.
315
- - [Data models](content/platform/payout/reference/data-models.mdx) — The data models owned by the Payout domain.
316
- - [Event reference](content/platform/payout/reference/events.mdx) — Events that drive the payout pipeline, for subscribers and side effects.
317
- - [Links to other modules](content/platform/payout/reference/links.mdx) — How the Payout domain links to sellers and orders across the marketplace.
318
- - [Service reference](content/platform/payout/reference/service.mdx) — The Payout module service: methods for working with records directly.
319
- - [Workflows](content/platform/payout/reference/workflows.mdx) — Payout account, onboarding, payout, and webhook workflows.
320
- - [Change actions](content/platform/product-edit/concepts/change-actions.mdx) — The typed actions that make up a change and the details they carry.
321
- - [The change pipeline](content/platform/product-edit/concepts/change-pipeline.mdx) — The ProductChange record, its immutability, and the audit trail.
322
- - [Status & auto-confirm](content/platform/product-edit/concepts/status-and-auto-confirm.mdx) — The change status lifecycle, revision requests, and auto-confirm.
323
- - [Confirm or decline a change](content/platform/product-edit/guides/confirm-or-decline-a-change.mdx) — Resolve a pending product change from server code.
324
- - [Edit a product](content/platform/product-edit/guides/edit-a-product.mdx) — Stage a product change from server code with the edit workflows.
325
- - [Request a revision](content/platform/product-edit/guides/request-a-revision.mdx) — Send a product submission back to the vendor from server code.
326
- - [Product Edit](content/platform/product-edit/overview.mdx) — Route every product edit through a reviewable, immutable change pipeline.
327
- - [Data models](content/platform/product-edit/reference/data-models.mdx) — The data models owned by the Product Edit domain.
328
- - [Event reference](content/platform/product-edit/reference/events.mdx) — Events emitted by the Product Edit domain, for subscribers and side effects.
329
- - [Links to other modules](content/platform/product-edit/reference/links.mdx) — How the Product Edit domain links to other modules across the marketplace.
330
- - [Service reference](content/platform/product-edit/reference/service.mdx) — The Product Edit module service methods for working with records directly.
331
- - [Workflows](content/platform/product-edit/reference/workflows.mdx) — Product change workflows, service methods, and events.
332
- - [Product vs seller reviews](content/platform/review/concepts/product-vs-seller-reviews.mdx) — The reference discriminator and the links that anchor each review.
333
- - [Ratings & moderation](content/platform/review/concepts/ratings-and-moderation.mdx) — The review status lifecycle, store responses, and aggregate ratings.
334
- - [The review model](content/platform/review/concepts/the-review-model.mdx) — The single review entity, its rating, notes, and moderation status.
335
- - [Compute aggregate ratings](content/platform/review/guides/compute-aggregate-ratings.mdx) — Compute average ratings for products and sellers from server code.
336
- - [Create a review](content/platform/review/guides/create-a-review.mdx) — Create a review programmatically with createReviewWorkflow.
337
- - [Moderate a review](content/platform/review/guides/moderate-a-review.mdx) — Publish, reject, and delete reviews from server code.
338
- - [Respond to a review](content/platform/review/guides/respond-to-a-review.mdx) — Attach a store's public response with respondReviewWorkflow.
339
- - [Review](content/platform/review/overview.mdx) — Collect, moderate, and surface customer ratings for products and sellers.
340
- - [Data models](content/platform/review/reference/data-models.mdx) — The data models owned by the Review domain.
341
- - [Event reference](content/platform/review/reference/events.mdx) — Running side effects as reviews are created, moderated, and answered.
342
- - [Links to other modules](content/platform/review/reference/links.mdx) — How the Review domain links to products, sellers, orders, and customers.
343
- - [Service reference](content/platform/review/reference/service.mdx) — The Review module service: CRUD methods and aggregate-rating helpers.
344
- - [Workflows](content/platform/review/reference/workflows.mdx) — Review workflows for creating, moderating, responding, and deleting.
345
- - [Lifecycle](content/platform/store/concepts/lifecycle.mdx) — Store statuses, transitions, scheduled closures, and premium.
346
- - [The store entity](content/platform/store/concepts/store-entity.mdx) — The seller record, its business identity, and its satellite data.
347
- - [Team & members](content/platform/store/concepts/team.mdx) — Members, roles, invites, and the many-to-many store relationship.
348
- - [Create a store](content/platform/store/guides/create-a-store.mdx) — Create a seller programmatically with createSellersWorkflow.
349
- - [Manage the team](content/platform/store/guides/manage-the-team.mdx) — Invite and add store members from server code.
350
- - [Moderate stores](content/platform/store/guides/moderate-a-store.mdx) — Approve, suspend, and terminate stores from server code.
351
- - [Store](content/platform/store/overview.mdx) — Manage sellers, their teams, and their lifecycle on the marketplace.
352
- - [Data models](content/platform/store/reference/data-models.mdx) — The data models owned by the Store (Seller) domain.
353
- - [Event reference](content/platform/store/reference/events.mdx) — Events emitted by the Store domain, for subscribers and side effects.
354
- - [Links to other modules](content/platform/store/reference/links.mdx) — How the Store (Seller) domain links to other modules across the marketplace.
355
- - [Service reference](content/platform/store/reference/service.mdx) — The Seller module service and its methods for working with records directly.
356
- - [Workflows](content/platform/store/reference/workflows.mdx) — Seller and member workflows, service methods, and events.
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.
357
357
  - [Telemetry](content/telemetry.mdx) — Learn about the anonymous usage data collected by the Mercur CLI
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mercurjs/docs",
3
- "version": "2.3.8-canary.3",
3
+ "version": "2.3.8-canary.4",
4
4
  "repository": {
5
5
  "type": "git",
6
6
  "url": "https://github.com/mercurjs/mercur",