@mercurjs/docs 2.2.1 → 2.3.0-canary.1

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 (316) hide show
  1. package/content/home.mdx +107 -0
  2. package/content/learn/architecture.mdx +168 -83
  3. package/content/learn/introduction.mdx +161 -56
  4. package/content/learn/migration-to-2-0.mdx +187 -0
  5. package/content/learn/why-mercur.mdx +91 -0
  6. package/content/platform/attribute/concepts/attribute-types.mdx +59 -0
  7. package/content/platform/attribute/concepts/global-vs-inline.mdx +50 -0
  8. package/content/platform/attribute/concepts/variant-axes.mdx +61 -0
  9. package/content/platform/attribute/guides/attach-attributes-to-a-product.mdx +69 -0
  10. package/content/platform/attribute/guides/create-a-variant-axis.mdx +83 -0
  11. package/content/platform/attribute/guides/create-an-attribute.mdx +81 -0
  12. package/content/platform/attribute/overview.mdx +87 -0
  13. package/content/platform/attribute/reference/data-models.mdx +56 -0
  14. package/content/platform/attribute/reference/events.mdx +41 -0
  15. package/content/platform/attribute/reference/links.mdx +45 -0
  16. package/content/platform/attribute/reference/service.mdx +49 -0
  17. package/content/platform/attribute/reference/workflows.mdx +45 -0
  18. package/content/platform/catalog/concepts/master-products.mdx +54 -0
  19. package/content/platform/catalog/concepts/product-seller-allowlist.mdx +48 -0
  20. package/content/platform/catalog/concepts/status-lifecycle.mdx +58 -0
  21. package/content/platform/catalog/concepts/variants-categories-collections.mdx +49 -0
  22. package/content/platform/catalog/guides/allowlist-stores.mdx +59 -0
  23. package/content/platform/catalog/guides/create-a-master-product.mdx +70 -0
  24. package/content/platform/catalog/guides/publish-or-reject-a-product.mdx +79 -0
  25. package/content/platform/catalog/overview.mdx +90 -0
  26. package/content/platform/catalog/reference/data-models.mdx +66 -0
  27. package/content/platform/catalog/reference/events.mdx +41 -0
  28. package/content/platform/catalog/reference/links.mdx +44 -0
  29. package/content/platform/catalog/reference/service.mdx +52 -0
  30. package/content/platform/catalog/reference/workflows.mdx +40 -0
  31. package/content/platform/commission/concepts/order-commission-lines.mdx +65 -0
  32. package/content/platform/commission/concepts/rule-matching.mdx +86 -0
  33. package/content/platform/commission/concepts/rules-and-rates.mdx +84 -0
  34. package/content/platform/commission/guides/batch-update-rules.mdx +58 -0
  35. package/content/platform/commission/guides/create-a-rate.mdx +72 -0
  36. package/content/platform/commission/guides/refresh-order-commission-lines.mdx +55 -0
  37. package/content/platform/commission/overview.mdx +86 -0
  38. package/content/platform/commission/reference/data-models.mdx +75 -0
  39. package/content/platform/commission/reference/events.mdx +58 -0
  40. package/content/platform/commission/reference/links.mdx +45 -0
  41. package/content/platform/commission/reference/service.mdx +51 -0
  42. package/content/platform/commission/reference/workflows.mdx +40 -0
  43. package/content/platform/offer/concepts/pricing-and-inventory.mdx +72 -0
  44. package/content/platform/offer/concepts/shipping.mdx +48 -0
  45. package/content/platform/offer/concepts/what-is-an-offer.mdx +65 -0
  46. package/content/platform/offer/guides/bulk-create-offers.mdx +84 -0
  47. package/content/platform/offer/guides/create-an-offer.mdx +83 -0
  48. package/content/platform/offer/guides/manage-offer-inventory.mdx +53 -0
  49. package/content/platform/offer/overview.mdx +84 -0
  50. package/content/platform/offer/reference/data-models.mdx +56 -0
  51. package/content/platform/offer/reference/events.mdx +39 -0
  52. package/content/platform/offer/reference/links.mdx +60 -0
  53. package/content/platform/offer/reference/service.mdx +53 -0
  54. package/content/platform/offer/reference/workflows.mdx +38 -0
  55. package/content/platform/order-group/concepts/computed-totals.mdx +59 -0
  56. package/content/platform/order-group/concepts/order-splitting.mdx +61 -0
  57. package/content/platform/order-group/concepts/the-order-group.mdx +64 -0
  58. package/content/platform/order-group/guides/list-order-groups.mdx +67 -0
  59. package/content/platform/order-group/guides/retrieve-an-order-group.mdx +63 -0
  60. package/content/platform/order-group/guides/split-a-cart.mdx +58 -0
  61. package/content/platform/order-group/overview.mdx +83 -0
  62. package/content/platform/order-group/reference/data-models.mdx +40 -0
  63. package/content/platform/order-group/reference/events.mdx +37 -0
  64. package/content/platform/order-group/reference/links.mdx +45 -0
  65. package/content/platform/order-group/reference/service.mdx +50 -0
  66. package/content/platform/order-group/reference/workflows.mdx +39 -0
  67. package/content/platform/payout/concepts/account-lifecycle.mdx +75 -0
  68. package/content/platform/payout/concepts/accounts-and-onboarding.mdx +70 -0
  69. package/content/platform/payout/concepts/payout-pipeline.mdx +99 -0
  70. package/content/platform/payout/guides/create-a-payout-account.mdx +59 -0
  71. package/content/platform/payout/guides/process-a-provider-webhook.mdx +74 -0
  72. package/content/platform/payout/guides/start-provider-onboarding.mdx +50 -0
  73. package/content/platform/payout/overview.mdx +86 -0
  74. package/content/platform/payout/reference/data-models.mdx +61 -0
  75. package/content/platform/payout/reference/events.mdx +48 -0
  76. package/content/platform/payout/reference/links.mdx +36 -0
  77. package/content/platform/payout/reference/service.mdx +53 -0
  78. package/content/platform/payout/reference/workflows.mdx +32 -0
  79. package/content/platform/product-edit/concepts/change-actions.mdx +66 -0
  80. package/content/platform/product-edit/concepts/change-pipeline.mdx +69 -0
  81. package/content/platform/product-edit/concepts/status-and-auto-confirm.mdx +66 -0
  82. package/content/platform/product-edit/guides/confirm-or-decline-a-change.mdx +76 -0
  83. package/content/platform/product-edit/guides/edit-a-product.mdx +74 -0
  84. package/content/platform/product-edit/guides/request-a-revision.mdx +54 -0
  85. package/content/platform/product-edit/overview.mdx +85 -0
  86. package/content/platform/product-edit/reference/data-models.mdx +65 -0
  87. package/content/platform/product-edit/reference/events.mdx +47 -0
  88. package/content/platform/product-edit/reference/links.mdx +39 -0
  89. package/content/platform/product-edit/reference/service.mdx +43 -0
  90. package/content/platform/product-edit/reference/workflows.mdx +49 -0
  91. package/content/platform/review/concepts/product-vs-seller-reviews.mdx +63 -0
  92. package/content/platform/review/concepts/ratings-and-moderation.mdx +64 -0
  93. package/content/platform/review/concepts/the-review-model.mdx +56 -0
  94. package/content/platform/review/guides/compute-aggregate-ratings.mdx +57 -0
  95. package/content/platform/review/guides/create-a-review.mdx +55 -0
  96. package/content/platform/review/guides/moderate-a-review.mdx +58 -0
  97. package/content/platform/review/guides/respond-to-a-review.mdx +61 -0
  98. package/content/platform/review/overview.mdx +87 -0
  99. package/content/platform/review/reference/data-models.mdx +36 -0
  100. package/content/platform/review/reference/events.mdx +61 -0
  101. package/content/platform/review/reference/links.mdx +43 -0
  102. package/content/platform/review/reference/service.mdx +54 -0
  103. package/content/platform/review/reference/workflows.mdx +31 -0
  104. package/content/platform/store/concepts/lifecycle.mdx +62 -0
  105. package/content/platform/store/concepts/store-entity.mdx +53 -0
  106. package/content/platform/store/concepts/team.mdx +50 -0
  107. package/content/platform/store/guides/create-a-store.mdx +55 -0
  108. package/content/platform/store/guides/manage-the-team.mdx +55 -0
  109. package/content/platform/store/guides/moderate-a-store.mdx +59 -0
  110. package/content/platform/store/overview.mdx +86 -0
  111. package/content/platform/store/reference/data-models.mdx +89 -0
  112. package/content/platform/store/reference/events.mdx +43 -0
  113. package/content/platform/store/reference/links.mdx +71 -0
  114. package/content/platform/store/reference/service.mdx +51 -0
  115. package/content/platform/store/reference/workflows.mdx +35 -0
  116. package/content/references/api/admin/commission-rates/create-commission-rate.mdx +1 -1
  117. package/content/references/api/admin/commission-rates/list-commission-rates.mdx +2 -2
  118. package/content/references/api/admin/commission-rates/update-commission-rate.mdx +1 -1
  119. package/content/references/api/admin/offers/batch-create-offers.mdx +3 -3
  120. package/content/references/api/admin/order-groups/list-order-groups.mdx +1 -1
  121. package/content/references/api/admin/product-attributes/create-attribute-value.mdx +2 -2
  122. package/content/references/api/admin/product-attributes/create-product-attribute.mdx +1 -1
  123. package/content/references/api/admin/product-attributes/update-product-attribute.mdx +1 -1
  124. package/content/references/api/admin/product-changes/confirm-product-change.mdx +1 -1
  125. package/content/references/api/admin/products/batch-product-attributes.mdx +1 -1
  126. package/content/references/api/admin/products/create-product.mdx +1 -1
  127. package/content/references/api/admin/products/preview-product.mdx +1 -1
  128. package/content/references/api/admin.mdx +4 -5
  129. package/content/references/api/conventions.mdx +9 -7
  130. package/content/references/api/store/carts/add-line-item.mdx +1 -1
  131. package/content/references/api/store/offers/list-offers.mdx +1 -1
  132. package/content/references/api/store/order-groups/list-order-groups.mdx +1 -1
  133. package/content/references/api/store.mdx +4 -13
  134. package/content/references/api/vendor/members/accept-member-invite.mdx +1 -1
  135. package/content/references/api/vendor/offers/batch-create-offers.mdx +4 -0
  136. package/content/references/api/vendor/offers/batch-offer-inventory-items.mdx +2 -0
  137. package/content/references/api/vendor/offers/create-offer.mdx +13 -1
  138. package/content/references/api/vendor/offers/list-offers.mdx +4 -0
  139. package/content/references/api/vendor/offers/retrieve-offer.mdx +4 -0
  140. package/content/references/api/vendor/offers/update-offer.mdx +12 -0
  141. package/content/references/api/vendor/payout-accounts/create-onboarding.mdx +1 -1
  142. package/content/references/api/vendor/products/batch-product-attributes.mdx +1 -1
  143. package/content/references/api/vendor/products/create-product-variant.mdx +1 -1
  144. package/content/references/api/vendor/products/create-product.mdx +1 -1
  145. package/content/references/api/vendor/products/delete-product.mdx +1 -1
  146. package/content/references/api/vendor/products/update-product.mdx +1 -1
  147. package/content/references/api/vendor/sellers/create-seller.mdx +2 -2
  148. package/content/references/api/vendor/sellers/list-sellers.mdx +1 -1
  149. package/content/references/api/vendor.mdx +6 -5
  150. package/content/references/configuration.mdx +16 -33
  151. package/content/references/overview.mdx +34 -52
  152. package/content/references/panel-extensions/create-page.mdx +194 -0
  153. package/content/references/panel-extensions/custom-fields.mdx +256 -0
  154. package/content/references/panel-extensions/overview.mdx +102 -0
  155. package/content/references/panel-extensions/widgets.mdx +212 -0
  156. package/content/resources/ai/mcp.mdx +2 -2
  157. package/content/resources/ai/overview.mdx +21 -16
  158. package/content/resources/ai/skills.mdx +67 -0
  159. package/content/resources/best-practices/api-routes.mdx +55 -43
  160. package/content/resources/best-practices/custom-fields.mdx +116 -92
  161. package/content/resources/best-practices/frontend.mdx +62 -50
  162. package/content/resources/best-practices/module-links.mdx +48 -34
  163. package/content/resources/best-practices/modules.mdx +53 -27
  164. package/content/resources/best-practices/overview.mdx +45 -17
  165. package/content/resources/best-practices/subscribers-and-jobs.mdx +37 -24
  166. package/content/resources/best-practices/types.mdx +38 -23
  167. package/content/resources/best-practices/workflows.mdx +33 -21
  168. package/content/resources/customization/custom-fields.mdx +15 -15
  169. package/content/resources/customization/extend-a-workflow.mdx +7 -4
  170. package/content/resources/customization/extending-panels.mdx +55 -52
  171. package/content/resources/deployment/medusa-cloud.mdx +21 -20
  172. package/content/resources/deployment/self-host.mdx +123 -0
  173. package/content/resources/integrations/overview.mdx +38 -0
  174. package/content/resources/integrations/stripe-connect.mdx +39 -38
  175. package/content/resources/tutorials/add-a-block.mdx +25 -18
  176. package/content/resources/tutorials/add-a-widget.mdx +32 -23
  177. package/content/resources/tutorials/add-order-detail-button.mdx +33 -20
  178. package/content/resources/tutorials/attributes-and-variant-axes.mdx +28 -27
  179. package/content/resources/tutorials/build-a-block.mdx +26 -15
  180. package/content/resources/tutorials/custom-api-route.mdx +32 -20
  181. package/content/resources/tutorials/custom-panel-page.mdx +21 -12
  182. package/content/resources/tutorials/customize-navigation.mdx +30 -23
  183. package/content/resources/tutorials/extend-forms-and-tables.mdx +36 -28
  184. package/content/resources/tutorials/extend-onboarding.mdx +38 -35
  185. package/content/resources/tutorials/master-products-and-offers.mdx +28 -23
  186. package/content/telemetry.mdx +3 -3
  187. package/content/user-guide/admin/attributes/how-tos/create-an-attribute.mdx +64 -0
  188. package/content/user-guide/admin/attributes/how-tos/manage-possible-values.mdx +40 -0
  189. package/content/user-guide/admin/attributes/overview.mdx +22 -0
  190. package/content/user-guide/admin/commissions/how-tos/create-a-commission-rule.mdx +63 -0
  191. package/content/user-guide/admin/commissions/how-tos/edit-the-global-commission.mdx +48 -0
  192. package/content/user-guide/admin/commissions/how-tos/manage-a-commission-rule.mdx +45 -0
  193. package/content/user-guide/admin/commissions/overview.mdx +25 -0
  194. package/content/user-guide/admin/overview.mdx +20 -12
  195. package/content/user-guide/admin/product-requests/how-tos/review-a-new-product.mdx +58 -0
  196. package/content/user-guide/admin/product-requests/how-tos/review-a-product-edit.mdx +48 -0
  197. package/content/user-guide/admin/product-requests/overview.mdx +25 -0
  198. package/content/user-guide/vendor/offers/how-tos/create-an-offer.mdx +59 -0
  199. package/content/user-guide/vendor/offers/how-tos/update-prices-and-stock.mdx +40 -0
  200. package/content/user-guide/vendor/offers/overview.mdx +22 -0
  201. package/content/user-guide/vendor/onboarding.mdx +79 -0
  202. package/content/user-guide/vendor/orders/how-tos/fulfill-an-order.mdx +49 -0
  203. package/content/user-guide/vendor/orders/how-tos/mark-an-order-as-delivered.mdx +33 -0
  204. package/content/user-guide/vendor/orders/how-tos/process-a-return.mdx +42 -0
  205. package/content/user-guide/vendor/orders/how-tos/refund-an-order.mdx +38 -0
  206. package/content/user-guide/vendor/orders/how-tos/ship-an-order.mdx +40 -0
  207. package/content/user-guide/vendor/orders/overview.mdx +31 -0
  208. package/content/user-guide/vendor/overview.mdx +23 -12
  209. package/content/user-guide/vendor/products/how-tos/edit-a-product.mdx +44 -0
  210. package/content/user-guide/vendor/products/how-tos/submit-a-product.mdx +63 -0
  211. package/content/user-guide/vendor/products/overview.mdx +22 -0
  212. package/llms.txt +176 -142
  213. package/package.json +1 -1
  214. package/content/learn/concepts.mdx +0 -84
  215. package/content/learn/installation.mdx +0 -117
  216. package/content/learn/mirakl-alternative.mdx +0 -86
  217. package/content/migration/from-1-x-to-2-0.mdx +0 -152
  218. package/content/migration/from-2-0-to-2-1.mdx +0 -105
  219. package/content/migration/overview.mdx +0 -58
  220. package/content/references/api/store/search/search.mdx +0 -136
  221. package/content/references/modules/commission.mdx +0 -106
  222. package/content/references/modules/custom-fields.mdx +0 -45
  223. package/content/references/modules/media.mdx +0 -55
  224. package/content/references/modules/offer.mdx +0 -64
  225. package/content/references/modules/payout.mdx +0 -121
  226. package/content/references/modules/product-attribute.mdx +0 -111
  227. package/content/references/modules/product-edit.mdx +0 -80
  228. package/content/references/modules/search.mdx +0 -112
  229. package/content/references/modules/seller.mdx +0 -175
  230. package/content/references/panel-extension-api.mdx +0 -337
  231. package/content/references/workflows/cart/add-seller-shipping-method-to-cart.mdx +0 -48
  232. package/content/references/workflows/cart/complete-cart-with-split-orders.mdx +0 -36
  233. package/content/references/workflows/cart/list-seller-shipping-options-for-cart.mdx +0 -39
  234. package/content/references/workflows/cart/update-cart-seller-promotions.mdx +0 -42
  235. package/content/references/workflows/commission/batch-commission-rules.mdx +0 -49
  236. package/content/references/workflows/commission/create-commission-rates.mdx +0 -41
  237. package/content/references/workflows/commission/delete-commission-rates.mdx +0 -34
  238. package/content/references/workflows/commission/refresh-order-commission-lines.mdx +0 -30
  239. package/content/references/workflows/commission/update-commission-rates.mdx +0 -35
  240. package/content/references/workflows/media/set-category-images.mdx +0 -41
  241. package/content/references/workflows/media/set-collection-images.mdx +0 -41
  242. package/content/references/workflows/member/accept-member-invite.mdx +0 -33
  243. package/content/references/workflows/member/add-seller-member.mdx +0 -30
  244. package/content/references/workflows/member/create-member-invites.mdx +0 -34
  245. package/content/references/workflows/member/delete-member-invite.mdx +0 -24
  246. package/content/references/workflows/member/remove-seller-member.mdx +0 -28
  247. package/content/references/workflows/member/resend-member-invite.mdx +0 -28
  248. package/content/references/workflows/member/update-member-role.mdx +0 -28
  249. package/content/references/workflows/member/update-member.mdx +0 -35
  250. package/content/references/workflows/offer/batch-offer-inventory-items.mdx +0 -62
  251. package/content/references/workflows/offer/create-offers.mdx +0 -65
  252. package/content/references/workflows/offer/delete-offers.mdx +0 -35
  253. package/content/references/workflows/offer/update-offers.mdx +0 -53
  254. package/content/references/workflows/order/cancel-order-fulfillment.mdx +0 -34
  255. package/content/references/workflows/order/confirm-claim-request.mdx +0 -25
  256. package/content/references/workflows/order/confirm-exchange-request.mdx +0 -25
  257. package/content/references/workflows/order/confirm-order-edit-request.mdx +0 -25
  258. package/content/references/workflows/order/confirm-return-receive.mdx +0 -25
  259. package/content/references/workflows/order/create-order-fulfillment.mdx +0 -45
  260. package/content/references/workflows/order-group/get-order-group-detail.mdx +0 -29
  261. package/content/references/workflows/order-group/get-order-groups-list.mdx +0 -38
  262. package/content/references/workflows/overview.mdx +0 -72
  263. package/content/references/workflows/payout/create-onboarding.mdx +0 -36
  264. package/content/references/workflows/payout/create-payout-account.mdx +0 -33
  265. package/content/references/workflows/payout/create-payout.mdx +0 -30
  266. package/content/references/workflows/payout/process-payout-for-webhook.mdx +0 -34
  267. package/content/references/workflows/product/confirm-products.mdx +0 -48
  268. package/content/references/workflows/product/create-products.mdx +0 -63
  269. package/content/references/workflows/product/link-sellers-to-product-category.mdx +0 -40
  270. package/content/references/workflows/product/link-sellers-to-product.mdx +0 -40
  271. package/content/references/workflows/product/reject-product.mdx +0 -48
  272. package/content/references/workflows/product/request-product-change.mdx +0 -48
  273. package/content/references/workflows/product-attribute/add-product-attributes-to-product.mdx +0 -49
  274. package/content/references/workflows/product-attribute/create-and-link-product-attributes-to-product.mdx +0 -46
  275. package/content/references/workflows/product-attribute/create-product-attribute-values.mdx +0 -43
  276. package/content/references/workflows/product-attribute/create-product-attributes.mdx +0 -56
  277. package/content/references/workflows/product-attribute/delete-product-attribute-values.mdx +0 -30
  278. package/content/references/workflows/product-attribute/delete-product-attributes.mdx +0 -30
  279. package/content/references/workflows/product-attribute/remove-product-attributes-from-product.mdx +0 -29
  280. package/content/references/workflows/product-attribute/update-product-attribute-values.mdx +0 -44
  281. package/content/references/workflows/product-attribute/update-product-attributes-on-product.mdx +0 -41
  282. package/content/references/workflows/product-attribute/update-product-attributes.mdx +0 -48
  283. package/content/references/workflows/product-attribute/upsert-product-attribute-values.mdx +0 -43
  284. package/content/references/workflows/product-edit/auto-confirm-product-change.mdx +0 -39
  285. package/content/references/workflows/product-edit/cancel-product-change.mdx +0 -49
  286. package/content/references/workflows/product-edit/confirm-product-change.mdx +0 -57
  287. package/content/references/workflows/product-edit/create-product-change.mdx +0 -72
  288. package/content/references/workflows/product-edit/reject-product-change.mdx +0 -54
  289. package/content/references/workflows/product-edit/stage-product-change.mdx +0 -75
  290. package/content/references/workflows/seller/approve-seller.mdx +0 -36
  291. package/content/references/workflows/seller/create-seller-account.mdx +0 -59
  292. package/content/references/workflows/seller/create-seller-defaults.mdx +0 -22
  293. package/content/references/workflows/seller/create-sellers.mdx +0 -65
  294. package/content/references/workflows/seller/delete-seller-professional-details.mdx +0 -37
  295. package/content/references/workflows/seller/delete-sellers.mdx +0 -24
  296. package/content/references/workflows/seller/invite-seller.mdx +0 -28
  297. package/content/references/workflows/seller/suspend-seller.mdx +0 -37
  298. package/content/references/workflows/seller/terminate-seller.mdx +0 -37
  299. package/content/references/workflows/seller/unsuspend-seller.mdx +0 -36
  300. package/content/references/workflows/seller/unterminate-seller.mdx +0 -36
  301. package/content/references/workflows/seller/update-seller-address.mdx +0 -55
  302. package/content/references/workflows/seller/update-seller-payment-details.mdx +0 -52
  303. package/content/references/workflows/seller/update-seller-professional-details.mdx +0 -48
  304. package/content/references/workflows/seller/update-sellers.mdx +0 -57
  305. package/content/resources/ai/llms.mdx +0 -74
  306. package/content/resources/integrations/notifications.mdx +0 -39
  307. package/content/resources/integrations/search.mdx +0 -122
  308. package/content/resources/tutorials/configure-commissions.mdx +0 -127
  309. package/content/resources/tutorials/first-marketplace.mdx +0 -45
  310. package/content/resources/tutorials/handle-product-requests.mdx +0 -80
  311. package/content/resources/tutorials/import-export-products.mdx +0 -96
  312. package/content/resources/tutorials/seller-payouts-stripe.mdx +0 -89
  313. package/content/resources/tutorials/store-setup-checklist.mdx +0 -214
  314. package/content/tools/api-client.mdx +0 -155
  315. package/content/tools/cli.mdx +0 -196
  316. package/content/tools/dashboard-sdk.mdx +0 -35
@@ -4,7 +4,7 @@ api: "GET /admin/order-groups"
4
4
  description: "Retrieve a paginated list of order groups."
5
5
  ---
6
6
 
7
- Returns order groups the customer-facing wrappers around per-seller orders created from a multi-seller cart.
7
+ Returns order groups, the customer-facing wrappers around per-seller orders created from a multi-seller cart.
8
8
 
9
9
  <Note>
10
10
  Filtering by `seller_id` narrows results to order groups that contain at
@@ -4,7 +4,7 @@ api: "POST /admin/product-attributes/{id}/values"
4
4
  description: "Create or update values on a product attribute."
5
5
  ---
6
6
 
7
- Upserts the given values on the attribute items with an `id` update an existing value, items without one create a new value.
7
+ Upserts the given values on the attribute. Items with an `id` update an existing value, items without one create a new value.
8
8
 
9
9
  ## Path parameters
10
10
 
@@ -13,7 +13,7 @@ Upserts the given values on the attribute — items with an `id` update an exist
13
13
  ## Body parameters
14
14
 
15
15
  <ParamField body="values" type="object[]" required>
16
- Values to create or update one of two shapes per item.
16
+ Values to create or update, one of two shapes per item.
17
17
  <Expandable title="update existing value (by id)">
18
18
  <ParamField body="id" type="string" required>The value's ID.</ParamField>
19
19
  <ParamField body="name" type="string">Value name.</ParamField>
@@ -7,7 +7,7 @@ description: "Create a catalog product attribute."
7
7
  Creates a shared attribute that products across the catalog can use.
8
8
 
9
9
  <Note>
10
- `is_variant_axis` is only valid for `multi_select` attributes axis attributes provide the value sets that variants are generated from.
10
+ `is_variant_axis` is only valid for `multi_select` attributes. Axis attributes provide the value sets that variants are generated from.
11
11
  </Note>
12
12
 
13
13
  ## Body parameters
@@ -7,7 +7,7 @@ description: "Update a catalog product attribute."
7
7
  Updates the attribute's details; only the provided fields are changed.
8
8
 
9
9
  <Note>
10
- `type` is immutable sending a `type` different from the attribute's current type returns an error.
10
+ `type` is immutable. Sending a `type` different from the attribute's current type returns an error.
11
11
  </Note>
12
12
 
13
13
  ## Path parameters
@@ -18,7 +18,7 @@ Applies the pending change set to the product and marks the change as confirmed.
18
18
 
19
19
  <ResponseField name="id" type="string">The confirmed product change's ID.</ResponseField>
20
20
  <ResponseField name="object" type="string">Always `product_change`.</ResponseField>
21
- <ResponseField name="deleted" type="boolean">Always `true` the change is no longer pending.</ResponseField>
21
+ <ResponseField name="deleted" type="boolean">Always `true`. The change is no longer pending.</ResponseField>
22
22
 
23
23
  <RequestExample>
24
24
  ```bash cURL
@@ -13,7 +13,7 @@ Applies attribute changes to the product in the order `remove` → `add` → `up
13
13
  ## Body parameters
14
14
 
15
15
  <ParamField body="add" type="object[]">
16
- Attributes to attach one of two shapes per item.
16
+ Attributes to attach, one of two shapes per item.
17
17
  <Expandable title="existing attribute (by id)">
18
18
  <ParamField body="id" type="string" required>ID of an existing catalog attribute.</ParamField>
19
19
  <ParamField body="value_ids" type="string[]">IDs of attribute values to select.</ParamField>
@@ -50,7 +50,7 @@ Pass `seller_ids` to set which sellers may sell the product. The `attributes` ar
50
50
  </Expandable>
51
51
  </ParamField>
52
52
  <ParamField body="attributes" type="object[]">
53
- Unified attribute input one of two shapes per item.
53
+ Unified attribute input, one of two shapes per item.
54
54
  <Expandable title="existing attribute (by id)">
55
55
  <ParamField body="id" type="string" required>ID of an existing catalog attribute.</ParamField>
56
56
  <ParamField body="value_ids" type="string[]">IDs of attribute values to select.</ParamField>
@@ -7,7 +7,7 @@ description: "Retrieve the pending change set for a product."
7
7
  Returns the product's pending change request with its individual change actions, or `null` if no change is pending.
8
8
 
9
9
  <Note>
10
- The response contains the pending `product_change` record and its `actions` the raw edits awaiting review not a merged product payload.
10
+ The response contains the pending `product_change` record and its `actions` (the raw edits awaiting review), not a merged product payload.
11
11
  </Note>
12
12
 
13
13
  ## Path parameters
@@ -1,11 +1,11 @@
1
1
  ---
2
2
  title: "Admin API"
3
- description: "Operator routes under /admin/* sellers, commissions, payouts, master catalog, and marketplace-wide orders."
3
+ description: "Operator routes under /admin/* for sellers, commissions, payouts, master catalog, and marketplace-wide orders."
4
4
  ---
5
5
 
6
- The Admin API is the marketplace operator's surface. It extends Medusa's standard admin routes with the marketplace domains below; everything else (regions, currencies, users, API keys, …) comes from Medusa core unchanged.
6
+ The Admin API is the marketplace operator's surface.
7
7
 
8
- Authentication and shared conventions are covered in [API conventions](/rc/references/api/conventions).
8
+ It extends Medusa's standard admin routes with the marketplace domains below. Everything else, such as regions, currencies, users, or API keys, comes from Medusa core unchanged. Authentication and shared conventions are covered in [API conventions](/rc/references/api/conventions).
9
9
 
10
10
  ## Sellers
11
11
 
@@ -52,7 +52,7 @@ Authentication and shared conventions are covered in [API conventions](/rc/refer
52
52
 
53
53
  ## Products (master catalog)
54
54
 
55
- Products are shared catalog records see the [master products model](/rc/references/modules/product-edit#the-master-products-model).
55
+ Products are shared catalog records. See [master products](/platform/catalog/concepts/master-products).
56
56
 
57
57
  | Method | Path | Purpose |
58
58
  | --- | --- | --- |
@@ -130,5 +130,4 @@ Mercur extends the Medusa RMA routes so they respect seller boundaries:
130
130
 
131
131
  <CardGroup cols={2}>
132
132
  <Card title="Vendor API" href="/rc/references/api/vendor" />
133
- <Card title="API Client" href="/rc/tools/api-client" />
134
133
  </CardGroup>
@@ -1,9 +1,11 @@
1
1
  ---
2
2
  title: "API conventions"
3
- description: "Authentication, seller scoping, pagination, field selection, and webhooks shared by every Mercur API surface."
3
+ description: "Authentication, seller scoping, pagination, field selection, and webhooks shared by every Mercur API surface."
4
4
  ---
5
5
 
6
- Mercur exposes three HTTP surfaces on the Medusa server. They share the same conventions for authentication, pagination, and field selection.
6
+ Every Mercur API surface follows the same rules for authentication, pagination, and field selection.
7
+
8
+ Mercur exposes three HTTP surfaces on the Medusa server. They share the conventions below, so once you learn one surface the others behave the same way.
7
9
 
8
10
  | Surface | Base path | Audience | Authentication |
9
11
  | --- | --- | --- | --- |
@@ -11,27 +13,27 @@ Mercur exposes three HTTP surfaces on the Medusa server. They share the same con
11
13
  | [Vendor API](/rc/references/api/vendor) | `/vendor/*` | Sellers | Member auth + seller scoping (below) |
12
14
  | [Store API](/rc/references/api/store) | `/store/*` | Storefront | Mostly public; customer auth where noted |
13
15
 
14
- All requests and responses are JSON. The recommended way to call these APIs is the typed [`@mercurjs/client`](/rc/tools/api-client) every route below maps 1:1 to a client call.
16
+ All requests and responses are JSON. Call these APIs with the typed `@mercurjs/client`. Every route below maps 1:1 to a client call.
15
17
 
16
18
  ## Authentication
17
19
 
18
20
  ### Admin
19
21
 
20
- Admin routes use standard Medusa admin authentication log in via `/auth/user/emailpass`, then send the session cookie or a `Authorization: Bearer <token>` header.
22
+ Admin routes use standard Medusa admin authentication. Log in via `/auth/user/emailpass`, then send the session cookie or an `Authorization: Bearer <token>` header.
21
23
 
22
24
  ### Vendor
23
25
 
24
26
  Vendor routes authenticate the **member** actor (`/auth/member/emailpass` to obtain a token) and are additionally scoped to a single seller:
25
27
 
26
- 1. The request must carry an `x-seller-id` header (or a seller selected in the session via `POST /vendor/sellers/select`).
27
- 2. Middleware verifies the authenticated member belongs to that seller and populates the request's seller context every query and mutation on the surface is automatically filtered to that seller.
28
+ 1. The request must carry an `x-seller-id` header, or a seller selected in the session via `POST /vendor/sellers/select`.
29
+ 2. Middleware verifies the authenticated member belongs to that seller and populates the request's seller context. Every query and mutation on the surface is then filtered to that seller automatically.
28
30
  3. The member's RBAC roles are resolved for the selected seller.
29
31
 
30
32
  A handful of vendor routes are public by design: seller registration (`POST /vendor/sellers`), invite acceptance (`POST /vendor/members/invites/accept`), `GET /vendor/stores`, and `GET /vendor/feature-flags`.
31
33
 
32
34
  ### Store
33
35
 
34
- Store routes are public. Customer authentication (session or bearer) is **required** for `/store/order-groups` and **optional** for `/store/offers`, `/store/products`, and `/store/search` (it enriches the pricing context when present). Public seller routes only return sellers whose status is `open` and who are not inside a scheduled closure window.
36
+ Store routes are public. Customer authentication (session or bearer) is **required** for `/store/order-groups` and **optional** for `/store/offers` and `/store/products`, where it enriches the pricing context when present. Public seller routes only return sellers whose status is `open` and who are not inside a scheduled closure window.
35
37
 
36
38
  ## Pagination
37
39
 
@@ -4,7 +4,7 @@ api: "POST /store/carts/{id}/line-items"
4
4
  description: "Add a seller offer to the cart as a line item."
5
5
  ---
6
6
 
7
- Adds an item to the cart by offer Mercur resolves the offer's variant and stamps the `offer_id` on the line item so the cart can later split into per-seller orders.
7
+ Adds an item to the cart by offer. Mercur resolves the offer's variant and stamps the `offer_id` on the line item so the cart can later split into per-seller orders.
8
8
 
9
9
  <Note>
10
10
  Unlike vanilla Medusa, this route takes an `offer_id` instead of a `variant_id`; an unknown offer returns a `404`.
@@ -7,7 +7,7 @@ description: "Retrieve seller offers with per-offer calculated prices."
7
7
  Returns a paginated list of offers from visible sellers whose products are published.
8
8
 
9
9
  <Note>
10
- Customer authentication is optional. When a customer token is provided, the customer's group memberships enter the pricing context used for `calculated_price`. Prices are computed per offer (each offer scopes the variant's price set by an `offer_id` rule) only when `calculated_price` is in `fields` and a pricing context (`region_id`, `country_code`, or `cart_id`) resolves. Requesting `inventory_quantity` or `in_stock` requires a single sales channel either configured on the publishable key or passed as `sales_channel_id`.
10
+ Customer authentication is optional. When a customer token is provided, the customer's group memberships enter the pricing context used for `calculated_price`. Prices are computed per offer (each offer scopes the variant's price set by an `offer_id` rule) only when `calculated_price` is in `fields` and a pricing context (`region_id`, `country_code`, or `cart_id`) resolves. Requesting `inventory_quantity` or `in_stock` requires a single sales channel: either configured on the publishable key or passed as `sales_channel_id`.
11
11
  </Note>
12
12
 
13
13
  ## Query parameters
@@ -4,7 +4,7 @@ api: "GET /store/order-groups"
4
4
  description: "Retrieve the authenticated customer's order groups."
5
5
  ---
6
6
 
7
- Returns a paginated list of the logged-in customer's order groups the multi-seller wrappers created when a cart is completed.
7
+ Returns a paginated list of the logged-in customer's order groups, the multi-seller wrappers created when a cart is completed.
8
8
 
9
9
  <Note>
10
10
  Customer authentication is required (`Authorization: Bearer <customer_token>` or a session cookie); results are always scoped to the authenticated customer.
@@ -1,11 +1,11 @@
1
1
  ---
2
2
  title: "Store API"
3
- description: "Storefront routes under /store/* discovery, multi-vendor carts, checkout, and order groups."
3
+ description: "Storefront routes under /store/* for discovery, multi-vendor carts, checkout, and order groups."
4
4
  ---
5
5
 
6
- The Store API is what a storefront talks to. It extends Medusa's store routes with marketplace discovery (sellers, offers, search) and replaces the cart completion flow with the multi-vendor order-group split.
6
+ The Store API is what a storefront talks to.
7
7
 
8
- Most routes are public; customer authentication requirements are noted per group. See [API conventions](/rc/references/api/conventions) for pagination and field selection.
8
+ It extends Medusa's store routes with marketplace discovery (sellers and offers) and replaces the cart completion flow with the multi-vendor order-group split. Most routes are public, and customer authentication requirements are noted per group. See [API conventions](/rc/references/api/conventions) for pagination and field selection.
9
9
 
10
10
  ## Products and discovery
11
11
 
@@ -16,14 +16,6 @@ Most routes are public; customer authentication requirements are noted per group
16
16
  | `GET` | `/store/product-categories[/:id]` | Category tree with media and icons |
17
17
  | `GET` | `/store/product-attributes[/:id]` | Filterable attributes for building facet UIs |
18
18
 
19
- ## Search
20
-
21
- | Method | Path | Purpose |
22
- | --- | --- | --- |
23
- | `POST` | `/store/search` | Query the search index across products and offers |
24
-
25
- Request body: `q`, `limit` (default 12, max 100), `offset`, pricing context (`region_id`, `country_code`, `province`), and provider-owned `filters`. Response: `{ hits, count, limit, offset, facets }` with pre-labelled collection, category, and attribute facets. See the [Search module](/rc/references/modules/search) for document shapes and filter semantics.
26
-
27
19
  ## Sellers
28
20
 
29
21
  | Method | Path | Purpose |
@@ -48,7 +40,7 @@ Mercur overrides the cart routes so a single cart can span multiple sellers:
48
40
  | `POST` | `/store/carts/:id/shipping-methods` | Add per-seller shipping methods |
49
41
  | `GET` | `/store/shipping-options` | Shipping options available for the cart, grouped by seller |
50
42
  | `POST` | `/store/carts/:id/promotions` | Apply promotions |
51
- | `POST` | `/store/carts/:id/complete` | Complete the cart splits it into per-seller orders under an order group |
43
+ | `POST` | `/store/carts/:id/complete` | Complete the cart, splitting it into per-seller orders under an order group |
52
44
 
53
45
  ## Order groups
54
46
 
@@ -63,5 +55,4 @@ Customer authentication **required**.
63
55
 
64
56
  <CardGroup cols={2}>
65
57
  <Card title="Order groups" href="/rc/learn/order-groups" />
66
- <Card title="Search module" href="/rc/references/modules/search" />
67
58
  </CardGroup>
@@ -7,7 +7,7 @@ description: "Accept a seller team invite using its token."
7
7
  Accepts a member invite and joins the inviting seller's team.
8
8
 
9
9
  <Note>
10
- This is a public route no `Authorization` or `x-seller-id` header is required. The invite is identified by the `invite_token` sent in the invitation email.
10
+ This is a public route: no `Authorization` or `x-seller-id` header is required. The invite is identified by the `invite_token` sent in the invitation email.
11
11
  </Note>
12
12
 
13
13
  ## Body parameters
@@ -46,6 +46,8 @@ Creates multiple offers at once; the whole batch is validated and processed toge
46
46
  </ParamField>
47
47
  <ParamField body="ean" type="string">EAN barcode.</ParamField>
48
48
  <ParamField body="upc" type="string">UPC barcode.</ParamField>
49
+ <ParamField body="manage_inventory" type="boolean" default="true">Whether stock is tracked for the offer. Set to `false` to sell without inventory checks.</ParamField>
50
+ <ParamField body="allow_backorder" type="boolean" default="false">Whether the offer can be purchased when it is out of stock.</ParamField>
49
51
  <ParamField body="metadata" type="object">Custom key-value pairs.</ParamField>
50
52
  </Expandable>
51
53
  </ParamField>
@@ -57,6 +59,8 @@ Creates multiple offers at once; the whole batch is validated and processed toge
57
59
  <ResponseField name="id" type="string">The offer's ID.</ResponseField>
58
60
  <ResponseField name="variant_id" type="string">ID of the listed product variant.</ResponseField>
59
61
  <ResponseField name="sku" type="string">The seller's SKU for the listing.</ResponseField>
62
+ <ResponseField name="manage_inventory" type="boolean">Whether stock is tracked for the offer.</ResponseField>
63
+ <ResponseField name="allow_backorder" type="boolean">Whether the offer can be purchased when it is out of stock.</ResponseField>
60
64
  <ResponseField name="prices" type="object[]">The offer's prices.</ResponseField>
61
65
  <ResponseField name="inventory_items" type="object[]">Linked inventory items.</ResponseField>
62
66
  </Expandable>
@@ -52,6 +52,8 @@ Manages the inventory items backing an offer in one request and returns the refr
52
52
  <Expandable title="properties">
53
53
  <ResponseField name="id" type="string">The offer's ID.</ResponseField>
54
54
  <ResponseField name="sku" type="string">The seller's SKU for the listing.</ResponseField>
55
+ <ResponseField name="manage_inventory" type="boolean">Whether stock is tracked for the offer.</ResponseField>
56
+ <ResponseField name="allow_backorder" type="boolean">Whether the offer can be purchased when it is out of stock.</ResponseField>
55
57
  <ResponseField name="inventory_items" type="object[]">The offer's inventory items after the batch, with `id`, `inventory_item_id`, `required_quantity`, and `sku`.</ResponseField>
56
58
  </Expandable>
57
59
  </ResponseField>
@@ -4,7 +4,7 @@ api: "POST /vendor/offers"
4
4
  description: "Create a listing for a product variant."
5
5
  ---
6
6
 
7
- Creates the seller's offer for a variant the seller's SKU, shipping profile, prices, and backing inventory.
7
+ Creates the seller's offer for a variant: the seller's SKU, shipping profile, prices, and backing inventory.
8
8
 
9
9
  <Note>
10
10
  A product can be listed by many sellers; the offer is what carries the seller's own price and stock for a variant.
@@ -64,6 +64,14 @@ Creates the seller's offer for a variant — the seller's SKU, shipping profile,
64
64
  UPC barcode.
65
65
  </ParamField>
66
66
 
67
+ <ParamField body="manage_inventory" type="boolean" default="true">
68
+ Whether stock is tracked for the offer. Set to `false` to sell without inventory checks.
69
+ </ParamField>
70
+
71
+ <ParamField body="allow_backorder" type="boolean" default="false">
72
+ Whether the offer can be purchased when it is out of stock.
73
+ </ParamField>
74
+
67
75
  <ParamField body="metadata" type="object">
68
76
  Custom key-value pairs.
69
77
  </ParamField>
@@ -78,6 +86,8 @@ Creates the seller's offer for a variant — the seller's SKU, shipping profile,
78
86
  <ResponseField name="product_id" type="string">ID of the parent product.</ResponseField>
79
87
  <ResponseField name="shipping_profile_id" type="string">ID of the shipping profile.</ResponseField>
80
88
  <ResponseField name="sku" type="string">The seller's SKU for this listing.</ResponseField>
89
+ <ResponseField name="manage_inventory" type="boolean">Whether stock is tracked for the offer.</ResponseField>
90
+ <ResponseField name="allow_backorder" type="boolean">Whether the offer can be purchased when it is out of stock.</ResponseField>
81
91
  <ResponseField name="prices" type="object[]">Offer prices with `id`, `amount`, `currency_code`, `min_quantity`, `max_quantity`, and `price_rules`.</ResponseField>
82
92
  <ResponseField name="inventory_items" type="object[]">Linked inventory items with `id`, `inventory_item_id`, `required_quantity`, and `sku`.</ResponseField>
83
93
  </Expandable>
@@ -129,6 +139,8 @@ const { offer } = await client.vendor.offers.mutate({
129
139
  "product_id": "prod_01HXYZ",
130
140
  "shipping_profile_id": "sp_01HXYZ",
131
141
  "sku": "ACME-SHIRT-M",
142
+ "manage_inventory": true,
143
+ "allow_backorder": false,
132
144
  "prices": [
133
145
  { "id": "price_01HXYZ", "amount": 2500, "currency_code": "usd" }
134
146
  ],
@@ -72,6 +72,8 @@ Returns the seller's offers with variant, shipping profile, prices, and linked i
72
72
  <ResponseField name="sku" type="string">The seller's SKU for this listing.</ResponseField>
73
73
  <ResponseField name="ean" type="string">EAN barcode.</ResponseField>
74
74
  <ResponseField name="upc" type="string">UPC barcode.</ResponseField>
75
+ <ResponseField name="manage_inventory" type="boolean">Whether stock is tracked for the offer.</ResponseField>
76
+ <ResponseField name="allow_backorder" type="boolean">Whether the offer can be purchased when it is out of stock.</ResponseField>
75
77
  <ResponseField name="seller" type="object">The seller with `id`, `name`, and `handle`.</ResponseField>
76
78
  <ResponseField name="product_variant" type="object">The variant with `id`, `title`, and `sku`.</ResponseField>
77
79
  <ResponseField name="shipping_profile" type="object">The shipping profile with `id` and `name`.</ResponseField>
@@ -109,6 +111,8 @@ const { offers, count } = await client.vendor.offers.query({
109
111
  "product_id": "prod_01HXYZ",
110
112
  "shipping_profile_id": "sp_01HXYZ",
111
113
  "sku": "ACME-SHIRT-M",
114
+ "manage_inventory": true,
115
+ "allow_backorder": false,
112
116
  "prices": [
113
117
  { "id": "price_01HXYZ", "amount": 2500, "currency_code": "usd" }
114
118
  ],
@@ -30,6 +30,8 @@ Returns a single offer owned by the seller; requesting another seller's offer fa
30
30
  <ResponseField name="sku" type="string">The seller's SKU for this listing.</ResponseField>
31
31
  <ResponseField name="ean" type="string">EAN barcode.</ResponseField>
32
32
  <ResponseField name="upc" type="string">UPC barcode.</ResponseField>
33
+ <ResponseField name="manage_inventory" type="boolean">Whether stock is tracked for the offer.</ResponseField>
34
+ <ResponseField name="allow_backorder" type="boolean">Whether the offer can be purchased when it is out of stock.</ResponseField>
33
35
  <ResponseField name="seller" type="object">The seller with `id`, `name`, and `handle`.</ResponseField>
34
36
  <ResponseField name="product_variant" type="object">The variant with `id`, `title`, and `sku`.</ResponseField>
35
37
  <ResponseField name="shipping_profile" type="object">The shipping profile with `id` and `name`.</ResponseField>
@@ -62,6 +64,8 @@ const { offer } = await client.vendor.offers.$id.query({
62
64
  "variant_id": "variant_01HXYZ",
63
65
  "product_id": "prod_01HXYZ",
64
66
  "sku": "ACME-SHIRT-M",
67
+ "manage_inventory": true,
68
+ "allow_backorder": false,
65
69
  "prices": [
66
70
  { "id": "price_01HXYZ", "amount": 2500, "currency_code": "usd" }
67
71
  ],
@@ -22,6 +22,14 @@ Updates the offer directly (no change request) and returns the refreshed offer.
22
22
  ID of the shipping profile used to fulfill the offer.
23
23
  </ParamField>
24
24
 
25
+ <ParamField body="manage_inventory" type="boolean">
26
+ Whether stock is tracked for the offer. Set to `false` to sell without inventory checks.
27
+ </ParamField>
28
+
29
+ <ParamField body="allow_backorder" type="boolean">
30
+ Whether the offer can be purchased when it is out of stock.
31
+ </ParamField>
32
+
25
33
  <ParamField body="prices" type="object[]">
26
34
  Prices to upsert; include `id` to update an existing price, omit it to add one.
27
35
  <Expandable title="properties">
@@ -45,6 +53,8 @@ Updates the offer directly (no change request) and returns the refreshed offer.
45
53
  <ResponseField name="id" type="string">The offer's ID.</ResponseField>
46
54
  <ResponseField name="sku" type="string">The seller's SKU for this listing.</ResponseField>
47
55
  <ResponseField name="shipping_profile_id" type="string">ID of the shipping profile.</ResponseField>
56
+ <ResponseField name="manage_inventory" type="boolean">Whether stock is tracked for the offer.</ResponseField>
57
+ <ResponseField name="allow_backorder" type="boolean">Whether the offer can be purchased when it is out of stock.</ResponseField>
48
58
  <ResponseField name="prices" type="object[]">The offer's prices after the update.</ResponseField>
49
59
  <ResponseField name="inventory_items" type="object[]">Linked inventory items.</ResponseField>
50
60
  </Expandable>
@@ -73,6 +83,8 @@ const { offer } = await client.vendor.offers.$id.mutate({
73
83
  "offer": {
74
84
  "id": "offer_01HXYZ",
75
85
  "sku": "ACME-SHIRT-M",
86
+ "manage_inventory": true,
87
+ "allow_backorder": false,
76
88
  "prices": [
77
89
  { "id": "price_01HXYZ", "amount": 2300, "currency_code": "usd" }
78
90
  ]
@@ -4,7 +4,7 @@ api: "POST /vendor/payout-accounts/{id}/onboarding"
4
4
  description: "Start or refresh provider onboarding for a payout account."
5
5
  ---
6
6
 
7
- Creates an onboarding session with the payout provider for Stripe Connect, the returned `data` contains the hosted onboarding link.
7
+ Creates an onboarding session with the payout provider. For Stripe Connect, the returned `data` contains the hosted onboarding link.
8
8
 
9
9
  ## Path parameters
10
10
 
@@ -44,7 +44,7 @@ Stages attribute operations as a pending change request instead of applying them
44
44
  <Expandable title="properties">
45
45
  <ParamField body="id" type="string" required>The attribute's ID.</ParamField>
46
46
  <ParamField body="title" type="string">New attribute title.</ParamField>
47
- <ParamField body="add" type="(string | object)[]">Values to select plain strings or `{ "value": "..." }` objects.</ParamField>
47
+ <ParamField body="add" type="(string | object)[]">Values to select, plain strings or `{ "value": "..." }` objects.</ParamField>
48
48
  <ParamField body="remove" type="string[]">Value IDs to deselect.</ParamField>
49
49
  <ParamField body="value" type="string | number | boolean">New scalar value for `text`, `unit`, or `toggle` attributes.</ParamField>
50
50
  </Expandable>
@@ -7,7 +7,7 @@ description: "Stage the addition of a variant to a product."
7
7
  Stages a `VARIANT_ADD` operation as a pending change request instead of creating the variant directly.
8
8
 
9
9
  <Note>
10
- The endpoint responds with `202 Accepted` and a `product_change` record; the variant appears on the product once the change is confirmed. The staged variant is always created with `manage_inventory: false` stock is tracked on offers.
10
+ The endpoint responds with `202 Accepted` and a `product_change` record; the variant appears on the product once the change is confirmed. The staged variant is always created with `manage_inventory: false`. Stock is tracked on offers.
11
11
  </Note>
12
12
 
13
13
  ## Path parameters
@@ -7,7 +7,7 @@ description: "Create a new product owned by the seller."
7
7
  Creates a product; when no status is provided it is created with status `proposed`.
8
8
 
9
9
  <Note>
10
- When the product request flow is enabled, `status` may only be `draft` or `proposed` publishing requires operator approval.
10
+ When the product request flow is enabled, `status` may only be `draft` or `proposed`. Publishing requires operator approval.
11
11
  </Note>
12
12
 
13
13
  ## Query parameters
@@ -4,7 +4,7 @@ api: "DELETE /vendor/products/{id}"
4
4
  description: "Stage a product deletion as a change request."
5
5
  ---
6
6
 
7
- Does not delete the product directly it stages a pending `PRODUCT_DELETE` change request that an operator confirms or declines.
7
+ Does not delete the product directly. It stages a pending `PRODUCT_DELETE` change request that an operator confirms or declines.
8
8
 
9
9
  <Note>
10
10
  The endpoint responds with `202 Accepted` and a `product_change` record; the product remains until the change is confirmed.
@@ -4,7 +4,7 @@ api: "POST /vendor/products/{id}"
4
4
  description: "Stage an update to a product as a change request."
5
5
  ---
6
6
 
7
- Does not modify the product directly it stages a pending change request that an operator confirms or declines.
7
+ Does not modify the product directly. It stages a pending change request that an operator confirms or declines.
8
8
 
9
9
  <Note>
10
10
  The endpoint responds with `202 Accepted` and a `product_change` record, not the updated product. Use [Preview Product Change](/rc/references/api/vendor/products/preview-product) to inspect the pending change and [Cancel Product Change](/rc/references/api/vendor/products/cancel-product-change) to withdraw it.
@@ -7,7 +7,7 @@ description: "Register a new seller account with its first member."
7
7
  Creates a seller account, optionally with an initial address, professional details, and payment details.
8
8
 
9
9
  <Note>
10
- This is a public route no `Authorization` or `x-seller-id` header is required. When called without an authenticated member, `member_email` is required so the owner member can be created.
10
+ This is a public route: no `Authorization` or `x-seller-id` header is required. When called without an authenticated member, `member_email` is required so the owner member can be created.
11
11
  </Note>
12
12
 
13
13
  ## Body parameters
@@ -33,7 +33,7 @@ Creates a seller account, optionally with an initial address, professional detai
33
33
  </ParamField>
34
34
 
35
35
  <ParamField body="member_email" type="string">
36
- Email for the owner member required when there is no authenticated member.
36
+ Email for the owner member, required when there is no authenticated member.
37
37
  </ParamField>
38
38
 
39
39
  <ParamField body="first_name" type="string">
@@ -7,7 +7,7 @@ description: "List the seller accounts the authenticated member belongs to."
7
7
  Returns the member's seller memberships (excluding terminated sellers), each with the related seller and role.
8
8
 
9
9
  <Note>
10
- This route requires only the `Authorization` header no `x-seller-id` since it is used before a seller is selected.
10
+ This route requires only the `Authorization` header (no `x-seller-id`) since it is used before a seller is selected.
11
11
  </Note>
12
12
 
13
13
  ## Query parameters
@@ -1,9 +1,11 @@
1
1
  ---
2
2
  title: "Vendor API"
3
- description: "Seller-scoped routes under /vendor/* every request operates on the authenticated member's selected seller."
3
+ description: "Seller-scoped routes under /vendor/* where every request operates on the authenticated member's selected seller."
4
4
  ---
5
5
 
6
- The Vendor API is the seller's surface. Every route is scoped to one seller through the member authentication and `x-seller-id` mechanism described in [API conventions](/rc/references/api/conventions#vendor) — a seller can never read or mutate another seller's data.
6
+ The Vendor API is the seller's surface.
7
+
8
+ Every route is scoped to one seller through the member authentication and `x-seller-id` mechanism described in [API conventions](/rc/references/api/conventions#vendor). A seller can never read or mutate another seller's data.
7
9
 
8
10
  ## Account and team
9
11
 
@@ -24,7 +26,7 @@ The Vendor API is the seller's surface. Every route is scoped to one seller thro
24
26
 
25
27
  ## Products and offers
26
28
 
27
- Products are shared master records: updates stage a [change request](/rc/references/modules/product-edit) rather than writing directly, and the list shows products the seller created plus published, unrestricted products.
29
+ Products are shared master records. Updates stage a [change request](/platform/product-edit/overview) rather than writing directly, and the list shows products the seller created plus published, unrestricted products.
28
30
 
29
31
  | Method | Path | Purpose |
30
32
  | --- | --- | --- |
@@ -43,7 +45,7 @@ Products are shared master records: updates stage a [change request](/rc/referen
43
45
 
44
46
  ### Catalog taxonomy (read-only)
45
47
 
46
- `GET /vendor/product-categories[/:id]`, `/vendor/product-tags[/:id]`, `/vendor/product-types[/:id]`, `/vendor/product-attributes[/:id]`, `/vendor/collections[/:id]` plus `POST /vendor/product-categories/:id/products` and `POST /vendor/collections/:id/products` to place own products.
48
+ `GET /vendor/product-categories[/:id]`, `/vendor/product-tags[/:id]`, `/vendor/product-types[/:id]`, `/vendor/product-attributes[/:id]`, and `/vendor/collections[/:id]`. Use `POST /vendor/product-categories/:id/products` and `POST /vendor/collections/:id/products` to place own products.
47
49
 
48
50
  ## Orders and fulfillment
49
51
 
@@ -146,5 +148,4 @@ Full RMA suites exist per domain, following the same action pattern Medusa uses
146
148
 
147
149
  <CardGroup cols={2}>
148
150
  <Card title="Store API" href="/rc/references/api/store" />
149
- <Card title="API Client" href="/rc/tools/api-client" />
150
151
  </CardGroup>