@mercurjs/docs 2.2.0-canary.40

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 (283) hide show
  1. package/README.md +24 -0
  2. package/content/blocks.mdx +209 -0
  3. package/content/learn/architecture.mdx +215 -0
  4. package/content/learn/attributes.mdx +89 -0
  5. package/content/learn/blocks.mdx +99 -0
  6. package/content/learn/commissions.mdx +175 -0
  7. package/content/learn/concepts.mdx +84 -0
  8. package/content/learn/installation.mdx +117 -0
  9. package/content/learn/introduction.mdx +71 -0
  10. package/content/learn/offers.mdx +78 -0
  11. package/content/learn/order-groups.mdx +114 -0
  12. package/content/learn/payouts.mdx +175 -0
  13. package/content/learn/product-requests.mdx +82 -0
  14. package/content/learn/products.mdx +79 -0
  15. package/content/learn/registry.mdx +155 -0
  16. package/content/learn/seller-members.mdx +62 -0
  17. package/content/learn/sellers.mdx +118 -0
  18. package/content/migration/from-1-x-to-2-0.mdx +152 -0
  19. package/content/migration/from-2-0-to-2-1.mdx +105 -0
  20. package/content/migration/overview.mdx +58 -0
  21. package/content/references/api/admin/commission-rates/batch-commission-rules.mdx +70 -0
  22. package/content/references/api/admin/commission-rates/create-commission-rate.mdx +95 -0
  23. package/content/references/api/admin/commission-rates/delete-commission-rate.mdx +40 -0
  24. package/content/references/api/admin/commission-rates/list-commission-rates.mdx +92 -0
  25. package/content/references/api/admin/commission-rates/retrieve-commission-rate.mdx +70 -0
  26. package/content/references/api/admin/commission-rates/update-commission-rate.mdx +84 -0
  27. package/content/references/api/admin/members/list-members.mdx +61 -0
  28. package/content/references/api/admin/offers/batch-create-offers.mdx +130 -0
  29. package/content/references/api/admin/offers/delete-offer.mdx +40 -0
  30. package/content/references/api/admin/offers/list-offers.mdx +106 -0
  31. package/content/references/api/admin/offers/retrieve-offer.mdx +82 -0
  32. package/content/references/api/admin/order-groups/list-order-groups.mdx +77 -0
  33. package/content/references/api/admin/order-groups/retrieve-order-group.mdx +56 -0
  34. package/content/references/api/admin/orders/get-order-commission-lines.mdx +65 -0
  35. package/content/references/api/admin/orders/get-order-order-group.mdx +56 -0
  36. package/content/references/api/admin/orders/list-orders.mdx +79 -0
  37. package/content/references/api/admin/payouts/list-payouts.mdx +75 -0
  38. package/content/references/api/admin/payouts/retrieve-payout.mdx +62 -0
  39. package/content/references/api/admin/product-attributes/create-attribute-value.mdx +76 -0
  40. package/content/references/api/admin/product-attributes/create-product-attribute.mdx +99 -0
  41. package/content/references/api/admin/product-attributes/delete-attribute-value.mdx +52 -0
  42. package/content/references/api/admin/product-attributes/delete-product-attribute.mdx +40 -0
  43. package/content/references/api/admin/product-attributes/list-product-attributes.mdx +91 -0
  44. package/content/references/api/admin/product-attributes/retrieve-product-attribute.mdx +81 -0
  45. package/content/references/api/admin/product-attributes/update-attribute-value.mdx +66 -0
  46. package/content/references/api/admin/product-attributes/update-product-attribute.mdx +76 -0
  47. package/content/references/api/admin/product-changes/cancel-product-change.mdx +68 -0
  48. package/content/references/api/admin/product-changes/confirm-product-change.mdx +47 -0
  49. package/content/references/api/admin/products/batch-product-attributes.mdx +96 -0
  50. package/content/references/api/admin/products/confirm-product.mdx +59 -0
  51. package/content/references/api/admin/products/create-product-variant.mdx +78 -0
  52. package/content/references/api/admin/products/create-product.mdx +169 -0
  53. package/content/references/api/admin/products/delete-product-variant.mdx +48 -0
  54. package/content/references/api/admin/products/delete-product.mdx +40 -0
  55. package/content/references/api/admin/products/list-product-variants.mdx +91 -0
  56. package/content/references/api/admin/products/list-products.mdx +109 -0
  57. package/content/references/api/admin/products/preview-product.mdx +78 -0
  58. package/content/references/api/admin/products/reject-product.mdx +59 -0
  59. package/content/references/api/admin/products/request-product-changes.mdx +59 -0
  60. package/content/references/api/admin/products/retrieve-product-variant.mdx +73 -0
  61. package/content/references/api/admin/products/retrieve-product.mdx +96 -0
  62. package/content/references/api/admin/products/set-product-sellers.mdx +47 -0
  63. package/content/references/api/admin/products/update-product-variant.mdx +89 -0
  64. package/content/references/api/admin/products/update-product.mdx +133 -0
  65. package/content/references/api/admin/sellers/add-seller-member.mdx +63 -0
  66. package/content/references/api/admin/sellers/approve-seller.mdx +54 -0
  67. package/content/references/api/admin/sellers/create-seller.mdx +100 -0
  68. package/content/references/api/admin/sellers/delete-member-invite.mdx +42 -0
  69. package/content/references/api/admin/sellers/delete-professional-details.mdx +52 -0
  70. package/content/references/api/admin/sellers/invite-seller-member.mdx +63 -0
  71. package/content/references/api/admin/sellers/list-member-invites.mdx +71 -0
  72. package/content/references/api/admin/sellers/list-seller-members.mdx +71 -0
  73. package/content/references/api/admin/sellers/list-seller-products.mdx +85 -0
  74. package/content/references/api/admin/sellers/list-sellers.mdx +96 -0
  75. package/content/references/api/admin/sellers/remove-seller-member.mdx +42 -0
  76. package/content/references/api/admin/sellers/resend-member-invite.mdx +55 -0
  77. package/content/references/api/admin/sellers/retrieve-seller.mdx +81 -0
  78. package/content/references/api/admin/sellers/suspend-seller.mdx +60 -0
  79. package/content/references/api/admin/sellers/terminate-seller.mdx +60 -0
  80. package/content/references/api/admin/sellers/unsuspend-seller.mdx +52 -0
  81. package/content/references/api/admin/sellers/unterminate-seller.mdx +52 -0
  82. package/content/references/api/admin/sellers/update-seller.mdx +83 -0
  83. package/content/references/api/admin/sellers/upsert-payment-details.mdx +88 -0
  84. package/content/references/api/admin/sellers/upsert-professional-details.mdx +78 -0
  85. package/content/references/api/admin/sellers/upsert-seller-address.mdx +91 -0
  86. package/content/references/api/admin.mdx +134 -0
  87. package/content/references/api/conventions.mdx +109 -0
  88. package/content/references/api/store/carts/add-line-item.mdx +115 -0
  89. package/content/references/api/store/carts/add-shipping-methods.mdx +84 -0
  90. package/content/references/api/store/carts/apply-promotions.mdx +83 -0
  91. package/content/references/api/store/carts/complete-cart.mdx +98 -0
  92. package/content/references/api/store/offers/list-offers.mdx +161 -0
  93. package/content/references/api/store/offers/retrieve-offer.mdx +112 -0
  94. package/content/references/api/store/order-groups/list-order-groups.mdx +105 -0
  95. package/content/references/api/store/order-groups/retrieve-order-group.mdx +78 -0
  96. package/content/references/api/store/product-attributes/list-product-attributes.mdx +134 -0
  97. package/content/references/api/store/product-attributes/retrieve-product-attribute.mdx +78 -0
  98. package/content/references/api/store/product-categories/list-product-categories.mdx +126 -0
  99. package/content/references/api/store/product-categories/retrieve-product-category.mdx +79 -0
  100. package/content/references/api/store/products/list-products.mdx +184 -0
  101. package/content/references/api/store/products/retrieve-product.mdx +107 -0
  102. package/content/references/api/store/search/search.mdx +136 -0
  103. package/content/references/api/store/sellers/list-sellers.mdx +105 -0
  104. package/content/references/api/store/sellers/retrieve-seller.mdx +62 -0
  105. package/content/references/api/store/shipping-options/list-shipping-options.mdx +74 -0
  106. package/content/references/api/store.mdx +67 -0
  107. package/content/references/api/vendor/members/accept-member-invite.mdx +65 -0
  108. package/content/references/api/vendor/members/retrieve-current-member.mdx +51 -0
  109. package/content/references/api/vendor/members/update-current-member.mdx +70 -0
  110. package/content/references/api/vendor/offers/batch-create-offers.mdx +123 -0
  111. package/content/references/api/vendor/offers/batch-offer-inventory-items.mdx +103 -0
  112. package/content/references/api/vendor/offers/create-offer.mdx +141 -0
  113. package/content/references/api/vendor/offers/delete-offer.mdx +51 -0
  114. package/content/references/api/vendor/offers/list-offers.mdx +125 -0
  115. package/content/references/api/vendor/offers/retrieve-offer.mdx +74 -0
  116. package/content/references/api/vendor/offers/update-offer.mdx +82 -0
  117. package/content/references/api/vendor/orders/cancel-fulfillment.mdx +63 -0
  118. package/content/references/api/vendor/orders/cancel-order.mdx +56 -0
  119. package/content/references/api/vendor/orders/complete-order.mdx +55 -0
  120. package/content/references/api/vendor/orders/create-fulfillment.mdx +76 -0
  121. package/content/references/api/vendor/orders/create-shipment.mdx +99 -0
  122. package/content/references/api/vendor/orders/get-order-commission-lines.mdx +66 -0
  123. package/content/references/api/vendor/orders/list-order-changes.mdx +75 -0
  124. package/content/references/api/vendor/orders/list-orders.mdx +103 -0
  125. package/content/references/api/vendor/orders/mark-fulfillment-delivered.mdx +62 -0
  126. package/content/references/api/vendor/orders/preview-order.mdx +65 -0
  127. package/content/references/api/vendor/orders/retrieve-order.mdx +84 -0
  128. package/content/references/api/vendor/payout-accounts/create-onboarding.mdx +68 -0
  129. package/content/references/api/vendor/payout-accounts/create-payout-account.mdx +59 -0
  130. package/content/references/api/vendor/payout-accounts/retrieve-payout-account-by-id.mdx +60 -0
  131. package/content/references/api/vendor/payout-accounts/retrieve-payout-account.mdx +77 -0
  132. package/content/references/api/vendor/payouts/list-payouts.mdx +90 -0
  133. package/content/references/api/vendor/payouts/retrieve-payout.mdx +63 -0
  134. package/content/references/api/vendor/product-attributes/list-product-attributes.mdx +135 -0
  135. package/content/references/api/vendor/product-attributes/retrieve-product-attribute.mdx +71 -0
  136. package/content/references/api/vendor/product-variants/list-variants.mdx +136 -0
  137. package/content/references/api/vendor/products/batch-product-attributes.mdx +104 -0
  138. package/content/references/api/vendor/products/cancel-product-change.mdx +62 -0
  139. package/content/references/api/vendor/products/create-product-variant.mdx +92 -0
  140. package/content/references/api/vendor/products/create-product.mdx +197 -0
  141. package/content/references/api/vendor/products/delete-product-variant.mdx +68 -0
  142. package/content/references/api/vendor/products/delete-product.mdx +62 -0
  143. package/content/references/api/vendor/products/list-product-variants.mdx +114 -0
  144. package/content/references/api/vendor/products/list-products.mdx +163 -0
  145. package/content/references/api/vendor/products/preview-product.mdx +61 -0
  146. package/content/references/api/vendor/products/retrieve-product-variant.mdx +76 -0
  147. package/content/references/api/vendor/products/retrieve-product.mdx +69 -0
  148. package/content/references/api/vendor/products/update-product-variant.mdx +104 -0
  149. package/content/references/api/vendor/products/update-product.mdx +148 -0
  150. package/content/references/api/vendor/sellers/create-seller.mdx +150 -0
  151. package/content/references/api/vendor/sellers/delete-professional-details.mdx +54 -0
  152. package/content/references/api/vendor/sellers/invite-seller-member.mdx +67 -0
  153. package/content/references/api/vendor/sellers/list-member-invites.mdx +82 -0
  154. package/content/references/api/vendor/sellers/list-seller-members.mdx +80 -0
  155. package/content/references/api/vendor/sellers/list-sellers.mdx +71 -0
  156. package/content/references/api/vendor/sellers/remove-seller-member.mdx +48 -0
  157. package/content/references/api/vendor/sellers/retrieve-current-seller-member.mdx +59 -0
  158. package/content/references/api/vendor/sellers/retrieve-current-seller.mdx +69 -0
  159. package/content/references/api/vendor/sellers/select-seller.mdx +44 -0
  160. package/content/references/api/vendor/sellers/update-current-seller.mdx +108 -0
  161. package/content/references/api/vendor/sellers/update-member-role.mdx +51 -0
  162. package/content/references/api/vendor/sellers/upsert-payment-details.mdx +74 -0
  163. package/content/references/api/vendor/sellers/upsert-professional-details.mdx +70 -0
  164. package/content/references/api/vendor/sellers/upsert-seller-address.mdx +81 -0
  165. package/content/references/api/vendor.mdx +150 -0
  166. package/content/references/configuration.mdx +155 -0
  167. package/content/references/modules/commission.mdx +106 -0
  168. package/content/references/modules/custom-fields.mdx +45 -0
  169. package/content/references/modules/media.mdx +55 -0
  170. package/content/references/modules/offer.mdx +64 -0
  171. package/content/references/modules/payout.mdx +121 -0
  172. package/content/references/modules/product-attribute.mdx +111 -0
  173. package/content/references/modules/product-edit.mdx +80 -0
  174. package/content/references/modules/search.mdx +112 -0
  175. package/content/references/modules/seller.mdx +175 -0
  176. package/content/references/overview.mdx +70 -0
  177. package/content/references/workflows/cart/add-seller-shipping-method-to-cart.mdx +44 -0
  178. package/content/references/workflows/cart/complete-cart-with-split-orders.mdx +36 -0
  179. package/content/references/workflows/cart/list-seller-shipping-options-for-cart.mdx +39 -0
  180. package/content/references/workflows/cart/update-cart-seller-promotions.mdx +42 -0
  181. package/content/references/workflows/commission/batch-commission-rules.mdx +45 -0
  182. package/content/references/workflows/commission/create-commission-rates.mdx +41 -0
  183. package/content/references/workflows/commission/delete-commission-rates.mdx +34 -0
  184. package/content/references/workflows/commission/refresh-order-commission-lines.mdx +30 -0
  185. package/content/references/workflows/commission/update-commission-rates.mdx +35 -0
  186. package/content/references/workflows/media/set-category-images.mdx +41 -0
  187. package/content/references/workflows/media/set-collection-images.mdx +41 -0
  188. package/content/references/workflows/member/accept-member-invite.mdx +33 -0
  189. package/content/references/workflows/member/add-seller-member.mdx +30 -0
  190. package/content/references/workflows/member/create-member-invites.mdx +34 -0
  191. package/content/references/workflows/member/delete-member-invite.mdx +24 -0
  192. package/content/references/workflows/member/remove-seller-member.mdx +28 -0
  193. package/content/references/workflows/member/resend-member-invite.mdx +28 -0
  194. package/content/references/workflows/member/update-member-role.mdx +28 -0
  195. package/content/references/workflows/member/update-member.mdx +35 -0
  196. package/content/references/workflows/offer/batch-offer-inventory-items.mdx +58 -0
  197. package/content/references/workflows/offer/create-offers.mdx +63 -0
  198. package/content/references/workflows/offer/delete-offers.mdx +35 -0
  199. package/content/references/workflows/offer/update-offers.mdx +51 -0
  200. package/content/references/workflows/order/cancel-order-fulfillment.mdx +34 -0
  201. package/content/references/workflows/order/confirm-claim-request.mdx +25 -0
  202. package/content/references/workflows/order/confirm-exchange-request.mdx +25 -0
  203. package/content/references/workflows/order/confirm-order-edit-request.mdx +25 -0
  204. package/content/references/workflows/order/confirm-return-receive.mdx +25 -0
  205. package/content/references/workflows/order/create-order-fulfillment.mdx +45 -0
  206. package/content/references/workflows/order-group/get-order-group-detail.mdx +29 -0
  207. package/content/references/workflows/order-group/get-order-groups-list.mdx +36 -0
  208. package/content/references/workflows/overview.mdx +72 -0
  209. package/content/references/workflows/payout/create-onboarding.mdx +36 -0
  210. package/content/references/workflows/payout/create-payout-account.mdx +33 -0
  211. package/content/references/workflows/payout/create-payout.mdx +30 -0
  212. package/content/references/workflows/payout/process-payout-for-webhook.mdx +32 -0
  213. package/content/references/workflows/product/confirm-products.mdx +46 -0
  214. package/content/references/workflows/product/create-products.mdx +63 -0
  215. package/content/references/workflows/product/link-sellers-to-product-category.mdx +40 -0
  216. package/content/references/workflows/product/link-sellers-to-product.mdx +40 -0
  217. package/content/references/workflows/product/reject-product.mdx +46 -0
  218. package/content/references/workflows/product/request-product-change.mdx +46 -0
  219. package/content/references/workflows/product-attribute/add-product-attributes-to-product.mdx +49 -0
  220. package/content/references/workflows/product-attribute/create-and-link-product-attributes-to-product.mdx +46 -0
  221. package/content/references/workflows/product-attribute/create-product-attribute-values.mdx +43 -0
  222. package/content/references/workflows/product-attribute/create-product-attributes.mdx +56 -0
  223. package/content/references/workflows/product-attribute/delete-product-attribute-values.mdx +30 -0
  224. package/content/references/workflows/product-attribute/delete-product-attributes.mdx +30 -0
  225. package/content/references/workflows/product-attribute/remove-product-attributes-from-product.mdx +29 -0
  226. package/content/references/workflows/product-attribute/update-product-attribute-values.mdx +44 -0
  227. package/content/references/workflows/product-attribute/update-product-attributes-on-product.mdx +41 -0
  228. package/content/references/workflows/product-attribute/update-product-attributes.mdx +48 -0
  229. package/content/references/workflows/product-attribute/upsert-product-attribute-values.mdx +43 -0
  230. package/content/references/workflows/product-edit/auto-confirm-product-change.mdx +39 -0
  231. package/content/references/workflows/product-edit/cancel-product-change.mdx +49 -0
  232. package/content/references/workflows/product-edit/confirm-product-change.mdx +57 -0
  233. package/content/references/workflows/product-edit/create-product-change.mdx +72 -0
  234. package/content/references/workflows/product-edit/reject-product-change.mdx +54 -0
  235. package/content/references/workflows/product-edit/stage-product-change.mdx +75 -0
  236. package/content/references/workflows/seller/approve-seller.mdx +34 -0
  237. package/content/references/workflows/seller/create-seller-account.mdx +59 -0
  238. package/content/references/workflows/seller/create-seller-defaults.mdx +22 -0
  239. package/content/references/workflows/seller/create-sellers.mdx +65 -0
  240. package/content/references/workflows/seller/delete-seller-professional-details.mdx +37 -0
  241. package/content/references/workflows/seller/delete-sellers.mdx +24 -0
  242. package/content/references/workflows/seller/invite-seller.mdx +28 -0
  243. package/content/references/workflows/seller/suspend-seller.mdx +35 -0
  244. package/content/references/workflows/seller/terminate-seller.mdx +35 -0
  245. package/content/references/workflows/seller/unsuspend-seller.mdx +34 -0
  246. package/content/references/workflows/seller/unterminate-seller.mdx +34 -0
  247. package/content/references/workflows/seller/update-seller-address.mdx +55 -0
  248. package/content/references/workflows/seller/update-seller-payment-details.mdx +52 -0
  249. package/content/references/workflows/seller/update-seller-professional-details.mdx +48 -0
  250. package/content/references/workflows/seller/update-sellers.mdx +57 -0
  251. package/content/resources/ai/llms.mdx +74 -0
  252. package/content/resources/ai/mcp.mdx +152 -0
  253. package/content/resources/ai/overview.mdx +97 -0
  254. package/content/resources/customization/custom-fields.mdx +182 -0
  255. package/content/resources/customization/extend-a-workflow.mdx +39 -0
  256. package/content/resources/customization/extending-panels.mdx +309 -0
  257. package/content/resources/deployment/medusa-cloud.mdx +167 -0
  258. package/content/resources/integrations/notifications.mdx +39 -0
  259. package/content/resources/integrations/search.mdx +122 -0
  260. package/content/resources/integrations/stripe-connect.mdx +395 -0
  261. package/content/resources/tutorials/add-a-block.mdx +74 -0
  262. package/content/resources/tutorials/attributes-and-variant-axes.mdx +111 -0
  263. package/content/resources/tutorials/build-a-block.mdx +134 -0
  264. package/content/resources/tutorials/configure-commissions.mdx +127 -0
  265. package/content/resources/tutorials/custom-api-route.mdx +142 -0
  266. package/content/resources/tutorials/custom-panel-page.mdx +78 -0
  267. package/content/resources/tutorials/first-marketplace.mdx +45 -0
  268. package/content/resources/tutorials/handle-product-requests.mdx +80 -0
  269. package/content/resources/tutorials/import-export-products.mdx +96 -0
  270. package/content/resources/tutorials/master-products-and-offers.mdx +89 -0
  271. package/content/resources/tutorials/recompose-a-page.mdx +129 -0
  272. package/content/resources/tutorials/replace-panel-components.mdx +116 -0
  273. package/content/resources/tutorials/seller-payouts-stripe.mdx +89 -0
  274. package/content/telemetry.mdx +67 -0
  275. package/content/tools/api-client.mdx +155 -0
  276. package/content/tools/cli.mdx +196 -0
  277. package/content/tools/dashboard-sdk.mdx +35 -0
  278. package/content/user-guide/admin/overview.mdx +23 -0
  279. package/content/user-guide/admin/stores.mdx +193 -0
  280. package/content/user-guide/vendor/overview.mdx +23 -0
  281. package/content/user-guide/vendor/stores.mdx +209 -0
  282. package/llms.txt +307 -0
  283. package/package.json +33 -0
@@ -0,0 +1,76 @@
1
+ ---
2
+ title: "Retrieve Product Variant"
3
+ api: "GET /vendor/products/{id}/variants/{variant_id}"
4
+ description: "Retrieve a single variant of a product."
5
+ ---
6
+
7
+ Returns a variant scoped to the given product.
8
+
9
+ ## Path parameters
10
+
11
+ <ParamField path="id" type="string" required>
12
+ The product's ID.
13
+ </ParamField>
14
+
15
+ <ParamField path="variant_id" type="string" required>
16
+ The variant's ID.
17
+ </ParamField>
18
+
19
+ ## Query parameters
20
+
21
+ <ParamField query="fields" type="string">
22
+ Comma-separated fields to include in the response. Prefix with `+`/`-` to add to or remove from the defaults.
23
+ </ParamField>
24
+
25
+ ## Response
26
+
27
+ <ResponseField name="variant" type="object">
28
+ <Expandable title="properties">
29
+ <ResponseField name="id" type="string">The variant's ID.</ResponseField>
30
+ <ResponseField name="title" type="string">The variant's title.</ResponseField>
31
+ <ResponseField name="sku" type="string">The variant's SKU.</ResponseField>
32
+ <ResponseField name="ean" type="string">EAN barcode.</ResponseField>
33
+ <ResponseField name="upc" type="string">UPC barcode.</ResponseField>
34
+ <ResponseField name="barcode" type="string">Generic barcode.</ResponseField>
35
+ <ResponseField name="product_id" type="string">ID of the parent product.</ResponseField>
36
+ <ResponseField name="manage_inventory" type="boolean">Whether inventory is managed for the variant.</ResponseField>
37
+ <ResponseField name="allow_backorder" type="boolean">Whether backorders are allowed.</ResponseField>
38
+ <ResponseField name="variant_rank" type="number">Sort rank of the variant.</ResponseField>
39
+ <ResponseField name="options" type="object[]">Selected option values with `id`, `value`, and the parent `option`.</ResponseField>
40
+ <ResponseField name="images" type="object[]">Variant images with `id`, `url`, and `rank`.</ResponseField>
41
+ <ResponseField name="metadata" type="object">Custom key-value pairs.</ResponseField>
42
+ </Expandable>
43
+ </ResponseField>
44
+
45
+ <RequestExample>
46
+ ```bash cURL
47
+ curl 'http://localhost:9000/vendor/products/prod_01HXYZ/variants/variant_01HXYZ' \
48
+ -H 'Authorization: Bearer <token>' \
49
+ -H 'x-seller-id: <seller_id>'
50
+ ```
51
+
52
+ ```ts JS Client
53
+ const { variant } = await client.vendor.products.$id.variants.$variant_id.query({
54
+ $id: "prod_01HXYZ",
55
+ $variant_id: "variant_01HXYZ",
56
+ })
57
+ ```
58
+ </RequestExample>
59
+
60
+ <ResponseExample>
61
+ ```json 200
62
+ {
63
+ "variant": {
64
+ "id": "variant_01HXYZ",
65
+ "title": "M",
66
+ "sku": "ACME-SHIRT-M",
67
+ "product_id": "prod_01HXYZ",
68
+ "manage_inventory": false,
69
+ "allow_backorder": false,
70
+ "options": [
71
+ { "id": "optval_01HXYZ", "value": "M", "option": { "id": "opt_01HXYZ", "title": "Size" } }
72
+ ]
73
+ }
74
+ }
75
+ ```
76
+ </ResponseExample>
@@ -0,0 +1,69 @@
1
+ ---
2
+ title: "Retrieve Product"
3
+ api: "GET /vendor/products/{id}"
4
+ description: "Retrieve a product by its ID."
5
+ ---
6
+
7
+ Returns a single product with its images, variants, and attribute assignments.
8
+
9
+ ## Path parameters
10
+
11
+ <ParamField path="id" type="string" required>
12
+ The product's ID.
13
+ </ParamField>
14
+
15
+ ## Query parameters
16
+
17
+ <ParamField query="fields" type="string">
18
+ Comma-separated fields to include in the response. Prefix with `+`/`-` to add to or remove from the defaults. Include `variants.offers` to attach the seller's offers to each variant.
19
+ </ParamField>
20
+
21
+ ## Response
22
+
23
+ <ResponseField name="product" type="object">
24
+ <Expandable title="properties">
25
+ <ResponseField name="id" type="string">The product's ID.</ResponseField>
26
+ <ResponseField name="title" type="string">The product's title.</ResponseField>
27
+ <ResponseField name="subtitle" type="string">The product's subtitle.</ResponseField>
28
+ <ResponseField name="description" type="string">The product's description.</ResponseField>
29
+ <ResponseField name="status" type="string">One of `draft`, `proposed`, `published`, `rejected`.</ResponseField>
30
+ <ResponseField name="handle" type="string">The product's URL handle.</ResponseField>
31
+ <ResponseField name="thumbnail" type="string">URL of the product's thumbnail image.</ResponseField>
32
+ <ResponseField name="images" type="object[]">Images with `id`, `url`, and `rank`.</ResponseField>
33
+ <ResponseField name="collection" type="object">The associated collection with `id`, `title`, and `handle`.</ResponseField>
34
+ <ResponseField name="categories" type="object[]">Associated categories with `id`, `name`, and `handle`.</ResponseField>
35
+ <ResponseField name="variants" type="object[]">Variants with `id`, `title`, `sku`, `manage_inventory`, `allow_backorder`, and `variant_rank`.</ResponseField>
36
+ <ResponseField name="attributes" type="object[]">Product attributes grouped per attribute with their selected values.</ResponseField>
37
+ <ResponseField name="metadata" type="object">Custom key-value pairs.</ResponseField>
38
+ </Expandable>
39
+ </ResponseField>
40
+
41
+ <RequestExample>
42
+ ```bash cURL
43
+ curl 'http://localhost:9000/vendor/products/prod_01HXYZ' \
44
+ -H 'Authorization: Bearer <token>' \
45
+ -H 'x-seller-id: <seller_id>'
46
+ ```
47
+
48
+ ```ts JS Client
49
+ const { product } = await client.vendor.products.$id.query({
50
+ $id: "prod_01HXYZ",
51
+ })
52
+ ```
53
+ </RequestExample>
54
+
55
+ <ResponseExample>
56
+ ```json 200
57
+ {
58
+ "product": {
59
+ "id": "prod_01HXYZ",
60
+ "title": "Acme T-Shirt",
61
+ "status": "published",
62
+ "handle": "acme-t-shirt",
63
+ "variants": [
64
+ { "id": "variant_01HXYZ", "title": "M", "sku": "ACME-SHIRT-M" }
65
+ ]
66
+ }
67
+ }
68
+ ```
69
+ </ResponseExample>
@@ -0,0 +1,104 @@
1
+ ---
2
+ title: "Update Product Variant"
3
+ api: "POST /vendor/products/{id}/variants/{variant_id}"
4
+ description: "Stage an update to a product variant as a change request."
5
+ ---
6
+
7
+ Stages a `VARIANT_UPDATE` operation as a pending change request instead of updating the variant directly.
8
+
9
+ <Note>
10
+ The endpoint responds with `202 Accepted` and a `product_change` record, not the updated variant.
11
+ </Note>
12
+
13
+ ## Path parameters
14
+
15
+ <ParamField path="id" type="string" required>
16
+ The product's ID.
17
+ </ParamField>
18
+
19
+ <ParamField path="variant_id" type="string" required>
20
+ The variant's ID.
21
+ </ParamField>
22
+
23
+ ## Body parameters
24
+
25
+ <ParamField body="title" type="string">The variant's title.</ParamField>
26
+ <ParamField body="sku" type="string">The variant's SKU.</ParamField>
27
+ <ParamField body="ean" type="string">EAN barcode.</ParamField>
28
+ <ParamField body="upc" type="string">UPC barcode.</ParamField>
29
+ <ParamField body="isbn" type="string">ISBN code.</ParamField>
30
+ <ParamField body="asin" type="string">Amazon ASIN.</ParamField>
31
+ <ParamField body="gtin" type="string">GTIN code.</ParamField>
32
+ <ParamField body="barcode" type="string">Generic barcode.</ParamField>
33
+ <ParamField body="hs_code" type="string">Harmonized System code.</ParamField>
34
+ <ParamField body="mid_code" type="string">Manufacturer ID code.</ParamField>
35
+ <ParamField body="thumbnail" type="string">Variant thumbnail URL.</ParamField>
36
+ <ParamField body="variant_rank" type="number">Sort rank of the variant.</ParamField>
37
+ <ParamField body="weight" type="number">Weight of the variant.</ParamField>
38
+ <ParamField body="length" type="number">Length of the variant.</ParamField>
39
+ <ParamField body="height" type="number">Height of the variant.</ParamField>
40
+ <ParamField body="width" type="number">Width of the variant.</ParamField>
41
+ <ParamField body="origin_country" type="string">Country of origin.</ParamField>
42
+ <ParamField body="material" type="string">Material of the variant.</ParamField>
43
+ <ParamField body="allow_backorder" type="boolean">Whether backorders are allowed.</ParamField>
44
+ <ParamField body="manage_inventory" type="boolean">Whether inventory is managed for the variant.</ParamField>
45
+ <ParamField body="metadata" type="object">Custom key-value pairs.</ParamField>
46
+ <ParamField body="options" type="object">Option title to value mapping, e.g. `{"Size": "M"}`.</ParamField>
47
+
48
+ <ParamField body="images" type="object">
49
+ <Expandable title="properties">
50
+ <ParamField body="add" type="string[]">Image URLs to attach to the variant.</ParamField>
51
+ <ParamField body="remove" type="string[]">Image IDs to detach from the variant.</ParamField>
52
+ </Expandable>
53
+ </ParamField>
54
+
55
+ ## Response
56
+
57
+ <ResponseField name="product_change" type="object">
58
+ <Expandable title="properties">
59
+ <ResponseField name="id" type="string">The change request's ID.</ResponseField>
60
+ <ResponseField name="product_id" type="string">ID of the product the change targets.</ResponseField>
61
+ <ResponseField name="status" type="string">One of `pending`, `confirmed`, `declined`, `canceled`.</ResponseField>
62
+ <ResponseField name="actions" type="object[]">Staged operations, each with `id`, `action` (`VARIANT_UPDATE`), `details`, `ordering`, and `applied`.</ResponseField>
63
+ </Expandable>
64
+ </ResponseField>
65
+
66
+ <RequestExample>
67
+ ```bash cURL
68
+ curl -X POST 'http://localhost:9000/vendor/products/prod_01HXYZ/variants/variant_01HXYZ' \
69
+ -H 'Authorization: Bearer <token>' \
70
+ -H 'x-seller-id: <seller_id>' \
71
+ -H 'Content-Type: application/json' \
72
+ -d '{"sku": "ACME-SHIRT-M-V2", "weight": 200}'
73
+ ```
74
+
75
+ ```ts JS Client
76
+ const { product_change } =
77
+ await client.vendor.products.$id.variants.$variant_id.mutate({
78
+ $id: "prod_01HXYZ",
79
+ $variant_id: "variant_01HXYZ",
80
+ sku: "ACME-SHIRT-M-V2",
81
+ weight: 200,
82
+ })
83
+ ```
84
+ </RequestExample>
85
+
86
+ <ResponseExample>
87
+ ```json 202
88
+ {
89
+ "product_change": {
90
+ "id": "prodch_01HXYZ",
91
+ "product_id": "prod_01HXYZ",
92
+ "status": "pending",
93
+ "actions": [
94
+ {
95
+ "id": "prodchact_01HXYZ",
96
+ "action": "VARIANT_UPDATE",
97
+ "details": { "variant_id": "variant_01HXYZ", "fields": { "sku": "ACME-SHIRT-M-V2" } },
98
+ "applied": false
99
+ }
100
+ ]
101
+ }
102
+ }
103
+ ```
104
+ </ResponseExample>
@@ -0,0 +1,148 @@
1
+ ---
2
+ title: "Update Product"
3
+ api: "POST /vendor/products/{id}"
4
+ description: "Stage an update to a product as a change request."
5
+ ---
6
+
7
+ Does not modify the product directly — it stages a pending change request that an operator confirms or declines.
8
+
9
+ <Note>
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.
11
+ </Note>
12
+
13
+ ## Path parameters
14
+
15
+ <ParamField path="id" type="string" required>
16
+ The product's ID.
17
+ </ParamField>
18
+
19
+ ## Body parameters
20
+
21
+ <ParamField body="title" type="string">The product's title.</ParamField>
22
+ <ParamField body="subtitle" type="string">The product's subtitle.</ParamField>
23
+ <ParamField body="description" type="string">The product's description.</ParamField>
24
+ <ParamField body="discountable" type="boolean">Whether discounts can apply to the product.</ParamField>
25
+ <ParamField body="is_giftcard" type="boolean">Whether the product is a gift card.</ParamField>
26
+
27
+ <ParamField body="images" type="object[]">
28
+ <Expandable title="properties">
29
+ <ParamField body="id" type="string">Existing image ID to keep.</ParamField>
30
+ <ParamField body="url" type="string" required>Image URL.</ParamField>
31
+ </Expandable>
32
+ </ParamField>
33
+
34
+ <ParamField body="thumbnail" type="string">URL of the product's thumbnail image.</ParamField>
35
+ <ParamField body="handle" type="string">The product's URL handle.</ParamField>
36
+ <ParamField body="external_id" type="string">ID of the product in an external system.</ParamField>
37
+ <ParamField body="type_id" type="string">ID of the product type.</ParamField>
38
+ <ParamField body="collection_id" type="string">ID of the collection the product belongs to.</ParamField>
39
+
40
+ <ParamField body="categories" type="object[]">
41
+ <Expandable title="properties">
42
+ <ParamField body="id" type="string" required>Category ID.</ParamField>
43
+ </Expandable>
44
+ </ParamField>
45
+
46
+ <ParamField body="tags" type="object[]">
47
+ <Expandable title="properties">
48
+ <ParamField body="id" type="string" required>Tag ID.</ParamField>
49
+ </Expandable>
50
+ </ParamField>
51
+
52
+ <ParamField body="options" type="object[]">
53
+ <Expandable title="properties">
54
+ <ParamField body="title" type="string" required>Option title.</ParamField>
55
+ <ParamField body="values" type="string[]" required>Allowed option values.</ParamField>
56
+ </Expandable>
57
+ </ParamField>
58
+
59
+ <ParamField body="variants" type="object[]">
60
+ Variant updates staged with the change.
61
+ <Expandable title="properties">
62
+ <ParamField body="id" type="string">Existing variant ID to update.</ParamField>
63
+ <ParamField body="title" type="string">Variant title.</ParamField>
64
+ <ParamField body="sku" type="string">Variant SKU.</ParamField>
65
+ <ParamField body="ean" type="string">EAN barcode.</ParamField>
66
+ <ParamField body="upc" type="string">UPC barcode.</ParamField>
67
+ <ParamField body="isbn" type="string">ISBN code.</ParamField>
68
+ <ParamField body="asin" type="string">Amazon ASIN.</ParamField>
69
+ <ParamField body="gtin" type="string">GTIN code.</ParamField>
70
+ <ParamField body="barcode" type="string">Generic barcode.</ParamField>
71
+ <ParamField body="hs_code" type="string">Harmonized System code.</ParamField>
72
+ <ParamField body="mid_code" type="string">Manufacturer ID code.</ParamField>
73
+ <ParamField body="thumbnail" type="string">Variant thumbnail URL.</ParamField>
74
+ <ParamField body="variant_rank" type="number">Sort rank of the variant.</ParamField>
75
+ <ParamField body="weight" type="number">Weight of the variant.</ParamField>
76
+ <ParamField body="length" type="number">Length of the variant.</ParamField>
77
+ <ParamField body="height" type="number">Height of the variant.</ParamField>
78
+ <ParamField body="width" type="number">Width of the variant.</ParamField>
79
+ <ParamField body="origin_country" type="string">Country of origin.</ParamField>
80
+ <ParamField body="material" type="string">Material of the variant.</ParamField>
81
+ <ParamField body="metadata" type="object">Custom key-value pairs.</ParamField>
82
+ <ParamField body="options" type="object">Option title to value mapping.</ParamField>
83
+ </Expandable>
84
+ </ParamField>
85
+
86
+ <ParamField body="weight" type="number">Weight of the product.</ParamField>
87
+ <ParamField body="length" type="number">Length of the product.</ParamField>
88
+ <ParamField body="height" type="number">Height of the product.</ParamField>
89
+ <ParamField body="width" type="number">Width of the product.</ParamField>
90
+ <ParamField body="hs_code" type="string">Harmonized System code.</ParamField>
91
+ <ParamField body="mid_code" type="string">Manufacturer ID code.</ParamField>
92
+ <ParamField body="origin_country" type="string">Country of origin.</ParamField>
93
+ <ParamField body="material" type="string">Material of the product.</ParamField>
94
+ <ParamField body="metadata" type="object">Custom key-value pairs.</ParamField>
95
+ <ParamField body="additional_data" type="object">Extra data passed to workflow hooks.</ParamField>
96
+
97
+ ## Response
98
+
99
+ <ResponseField name="product_change" type="object">
100
+ <Expandable title="properties">
101
+ <ResponseField name="id" type="string">The change request's ID.</ResponseField>
102
+ <ResponseField name="product_id" type="string">ID of the product the change targets.</ResponseField>
103
+ <ResponseField name="status" type="string">One of `pending`, `confirmed`, `declined`, `canceled`.</ResponseField>
104
+ <ResponseField name="created_by" type="string">ID of the seller that staged the change.</ResponseField>
105
+ <ResponseField name="actions" type="object[]">Staged operations, each with `id`, `action` (e.g. `UPDATE`), `details`, `ordering`, and `applied`.</ResponseField>
106
+ <ResponseField name="internal_note" type="string">Internal note attached to the change.</ResponseField>
107
+ <ResponseField name="external_note" type="string">Note from the operator, e.g. a revision request.</ResponseField>
108
+ </Expandable>
109
+ </ResponseField>
110
+
111
+ <RequestExample>
112
+ ```bash cURL
113
+ curl -X POST 'http://localhost:9000/vendor/products/prod_01HXYZ' \
114
+ -H 'Authorization: Bearer <token>' \
115
+ -H 'x-seller-id: <seller_id>' \
116
+ -H 'Content-Type: application/json' \
117
+ -d '{"title": "Acme T-Shirt v2", "description": "Softer fabric."}'
118
+ ```
119
+
120
+ ```ts JS Client
121
+ const { product_change } = await client.vendor.products.$id.mutate({
122
+ $id: "prod_01HXYZ",
123
+ title: "Acme T-Shirt v2",
124
+ description: "Softer fabric.",
125
+ })
126
+ ```
127
+ </RequestExample>
128
+
129
+ <ResponseExample>
130
+ ```json 202
131
+ {
132
+ "product_change": {
133
+ "id": "prodch_01HXYZ",
134
+ "product_id": "prod_01HXYZ",
135
+ "status": "pending",
136
+ "created_by": "sel_01HXYZ",
137
+ "actions": [
138
+ {
139
+ "id": "prodchact_01HXYZ",
140
+ "action": "UPDATE",
141
+ "details": { "title": "Acme T-Shirt v2" },
142
+ "applied": false
143
+ }
144
+ ]
145
+ }
146
+ }
147
+ ```
148
+ </ResponseExample>
@@ -0,0 +1,150 @@
1
+ ---
2
+ title: "Create Seller"
3
+ api: "POST /vendor/sellers"
4
+ description: "Register a new seller account with its first member."
5
+ ---
6
+
7
+ Creates a seller account, optionally with an initial address, professional details, and payment details.
8
+
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.
11
+ </Note>
12
+
13
+ ## Body parameters
14
+
15
+ <ParamField body="name" type="string" required>
16
+ The seller's display name.
17
+ </ParamField>
18
+
19
+ <ParamField body="email" type="string" required>
20
+ The seller's contact email.
21
+ </ParamField>
22
+
23
+ <ParamField body="currency_code" type="string" required>
24
+ The seller's default currency code (e.g. `usd`).
25
+ </ParamField>
26
+
27
+ <ParamField body="handle" type="string">
28
+ Unique handle for the seller's storefront URL.
29
+ </ParamField>
30
+
31
+ <ParamField body="phone" type="string">
32
+ The seller's contact phone number.
33
+ </ParamField>
34
+
35
+ <ParamField body="member_email" type="string">
36
+ Email for the owner member — required when there is no authenticated member.
37
+ </ParamField>
38
+
39
+ <ParamField body="first_name" type="string">
40
+ First name of the owner member.
41
+ </ParamField>
42
+
43
+ <ParamField body="last_name" type="string">
44
+ Last name of the owner member.
45
+ </ParamField>
46
+
47
+ <ParamField body="description" type="string">
48
+ Description of the seller's store.
49
+ </ParamField>
50
+
51
+ <ParamField body="address" type="object">
52
+ The seller's address.
53
+ <Expandable title="properties">
54
+ <ParamField body="name" type="string">Address label.</ParamField>
55
+ <ParamField body="company" type="string">Company name.</ParamField>
56
+ <ParamField body="first_name" type="string">Contact first name.</ParamField>
57
+ <ParamField body="last_name" type="string">Contact last name.</ParamField>
58
+ <ParamField body="address_1" type="string">Street address.</ParamField>
59
+ <ParamField body="address_2" type="string">Apartment, suite, etc.</ParamField>
60
+ <ParamField body="city" type="string">City.</ParamField>
61
+ <ParamField body="country_code" type="string">Two-letter country code.</ParamField>
62
+ <ParamField body="province" type="string">Province or state.</ParamField>
63
+ <ParamField body="postal_code" type="string">Postal code.</ParamField>
64
+ <ParamField body="phone" type="string">Phone number.</ParamField>
65
+ </Expandable>
66
+ </ParamField>
67
+
68
+ <ParamField body="professional_details" type="object">
69
+ The seller's business registration details.
70
+ <Expandable title="properties">
71
+ <ParamField body="corporate_name" type="string">Registered corporate name.</ParamField>
72
+ <ParamField body="registration_number" type="string">Business registration number.</ParamField>
73
+ <ParamField body="tax_id" type="string">Tax identification number.</ParamField>
74
+ </Expandable>
75
+ </ParamField>
76
+
77
+ <ParamField body="payment_details" type="object">
78
+ The seller's bank account details.
79
+ <Expandable title="properties">
80
+ <ParamField body="country_code" type="string">Bank country code.</ParamField>
81
+ <ParamField body="holder_name" type="string">Account holder name.</ParamField>
82
+ <ParamField body="bank_name" type="string">Bank name.</ParamField>
83
+ <ParamField body="iban" type="string">IBAN.</ParamField>
84
+ <ParamField body="bic" type="string">BIC / SWIFT code.</ParamField>
85
+ <ParamField body="routing_number" type="string">Routing number.</ParamField>
86
+ <ParamField body="account_number" type="string">Account number.</ParamField>
87
+ </Expandable>
88
+ </ParamField>
89
+
90
+ <ParamField body="metadata" type="object">
91
+ Custom key-value pairs.
92
+ </ParamField>
93
+
94
+ <ParamField body="additional_data" type="object">
95
+ Custom data passed to workflow hooks.
96
+ </ParamField>
97
+
98
+ ## Response
99
+
100
+ <ResponseField name="seller" type="object">
101
+ <Expandable title="properties">
102
+ <ResponseField name="id" type="string">The seller's ID.</ResponseField>
103
+ <ResponseField name="name" type="string">The seller's name.</ResponseField>
104
+ <ResponseField name="handle" type="string">The seller's handle.</ResponseField>
105
+ <ResponseField name="email" type="string">The seller's email.</ResponseField>
106
+ <ResponseField name="status" type="enum">One of `open`, `pending_approval`, `suspended`, `terminated`.</ResponseField>
107
+ <ResponseField name="currency_code" type="string">The seller's default currency.</ResponseField>
108
+ </Expandable>
109
+ </ResponseField>
110
+
111
+ <RequestExample>
112
+ ```bash cURL
113
+ curl -X POST 'http://localhost:9000/vendor/sellers' \
114
+ -H 'Content-Type: application/json' \
115
+ -d '{
116
+ "name": "Acme Store",
117
+ "email": "store@acme.com",
118
+ "currency_code": "usd",
119
+ "member_email": "owner@acme.com",
120
+ "first_name": "Jane",
121
+ "last_name": "Doe"
122
+ }'
123
+ ```
124
+
125
+ ```ts JS Client
126
+ const { seller } = await client.vendor.sellers.mutate({
127
+ name: "Acme Store",
128
+ email: "store@acme.com",
129
+ currency_code: "usd",
130
+ member_email: "owner@acme.com",
131
+ first_name: "Jane",
132
+ last_name: "Doe",
133
+ })
134
+ ```
135
+ </RequestExample>
136
+
137
+ <ResponseExample>
138
+ ```json 201
139
+ {
140
+ "seller": {
141
+ "id": "sel_01HXYZ",
142
+ "name": "Acme Store",
143
+ "handle": "acme-store",
144
+ "email": "store@acme.com",
145
+ "status": "pending_approval",
146
+ "currency_code": "usd"
147
+ }
148
+ }
149
+ ```
150
+ </ResponseExample>
@@ -0,0 +1,54 @@
1
+ ---
2
+ title: "Delete Professional Details"
3
+ api: "DELETE /vendor/sellers/{id}/professional-details"
4
+ description: "Remove the seller's business registration details."
5
+ ---
6
+
7
+ Deletes the seller's professional details and returns the full seller object.
8
+
9
+ ## Path parameters
10
+
11
+ <ParamField path="id" type="string" required>
12
+ The seller's ID.
13
+ </ParamField>
14
+
15
+ ## Query parameters
16
+
17
+ <ParamField query="fields" type="string">
18
+ Comma-separated fields to include in the response.
19
+ </ParamField>
20
+
21
+ ## Response
22
+
23
+ <ResponseField name="seller" type="object">
24
+ <Expandable title="properties">
25
+ <ResponseField name="id" type="string">The seller's ID.</ResponseField>
26
+ <ResponseField name="professional_details" type="object">`null` after deletion.</ResponseField>
27
+ </Expandable>
28
+ </ResponseField>
29
+
30
+ <RequestExample>
31
+ ```bash cURL
32
+ curl -X DELETE 'http://localhost:9000/vendor/sellers/sel_01HXYZ/professional-details' \
33
+ -H 'Authorization: Bearer <token>' \
34
+ -H 'x-seller-id: <seller_id>'
35
+ ```
36
+
37
+ ```ts JS Client
38
+ const { seller } = await client.vendor.sellers.$id.professionalDetails.delete({
39
+ $id: "sel_01HXYZ",
40
+ })
41
+ ```
42
+ </RequestExample>
43
+
44
+ <ResponseExample>
45
+ ```json 200
46
+ {
47
+ "seller": {
48
+ "id": "sel_01HXYZ",
49
+ "name": "Acme Store",
50
+ "professional_details": null
51
+ }
52
+ }
53
+ ```
54
+ </ResponseExample>
@@ -0,0 +1,67 @@
1
+ ---
2
+ title: "Invite Seller Member"
3
+ api: "POST /vendor/sellers/{id}/members"
4
+ description: "Invite a new member to the seller's team."
5
+ ---
6
+
7
+ Creates a member invite for the given email and role.
8
+
9
+ ## Path parameters
10
+
11
+ <ParamField path="id" type="string" required>
12
+ The seller's ID.
13
+ </ParamField>
14
+
15
+ ## Body parameters
16
+
17
+ <ParamField body="email" type="string" required>
18
+ Email address to send the invite to.
19
+ </ParamField>
20
+
21
+ <ParamField body="role_id" type="enum" required>
22
+ The role assigned on acceptance. One of `role_seller_administration`, `role_seller_inventory_management`, `role_seller_order_management`, `role_seller_accounting`, `role_seller_support`.
23
+ </ParamField>
24
+
25
+ ## Response
26
+
27
+ <ResponseField name="member_invite" type="object">
28
+ <Expandable title="properties">
29
+ <ResponseField name="id" type="string">The invite's ID.</ResponseField>
30
+ <ResponseField name="email" type="string">The invited email.</ResponseField>
31
+ <ResponseField name="role_id" type="string">The role granted on acceptance.</ResponseField>
32
+ <ResponseField name="accepted" type="boolean">Whether the invite has been accepted.</ResponseField>
33
+ <ResponseField name="expires_at" type="string">Expiration timestamp.</ResponseField>
34
+ </Expandable>
35
+ </ResponseField>
36
+
37
+ <RequestExample>
38
+ ```bash cURL
39
+ curl -X POST 'http://localhost:9000/vendor/sellers/sel_01HXYZ/members' \
40
+ -H 'Authorization: Bearer <token>' \
41
+ -H 'x-seller-id: <seller_id>' \
42
+ -H 'Content-Type: application/json' \
43
+ -d '{"email": "teammate@acme.com", "role_id": "role_seller_order_management"}'
44
+ ```
45
+
46
+ ```ts JS Client
47
+ const { member_invite } = await client.vendor.sellers.$id.members.mutate({
48
+ $id: "sel_01HXYZ",
49
+ email: "teammate@acme.com",
50
+ role_id: "role_seller_order_management",
51
+ })
52
+ ```
53
+ </RequestExample>
54
+
55
+ <ResponseExample>
56
+ ```json 201
57
+ {
58
+ "member_invite": {
59
+ "id": "meminv_01HXYZ",
60
+ "email": "teammate@acme.com",
61
+ "role_id": "role_seller_order_management",
62
+ "accepted": false,
63
+ "expires_at": "2026-01-22T10:00:00.000Z"
64
+ }
65
+ }
66
+ ```
67
+ </ResponseExample>