@mercurjs/docs 2.2.0-canary.40

package/content/references/api/vendor/sellers/list-member-invites.mdx

@@ -0,0 +1,82 @@
+---
+title: "List Member Invites"
+api: "GET /vendor/sellers/{id}/members/invites"
+description: "List the seller's pending member invites."
+---
+
+Returns the seller's member invites that have not been accepted yet.
+
+## Path parameters
+
+<ParamField path="id" type="string" required>
+  The seller's ID.
+</ParamField>
+
+## Query parameters
+
+<ParamField query="limit" type="number" default="50">
+  Maximum number of items to return.
+</ParamField>
+
+<ParamField query="offset" type="number" default="0">
+  Number of items to skip.
+</ParamField>
+
+<ParamField query="order" type="string">
+  Field to sort by, prefixed with `-` for descending order.
+</ParamField>
+
+<ParamField query="fields" type="string">
+  Comma-separated fields to include in the response.
+</ParamField>
+
+## Response
+
+<ResponseField name="member_invites" type="object[]">
+  <Expandable title="properties">
+    <ResponseField name="id" type="string">The invite's ID.</ResponseField>
+    <ResponseField name="email" type="string">The invited email.</ResponseField>
+    <ResponseField name="accepted" type="boolean">Always `false` in this list.</ResponseField>
+    <ResponseField name="role_id" type="string">The role granted on acceptance.</ResponseField>
+    <ResponseField name="expires_at" type="string">Expiration timestamp.</ResponseField>
+    <ResponseField name="created_at" type="string">Creation timestamp.</ResponseField>
+  </Expandable>
+</ResponseField>
+
+<ResponseField name="count" type="number">Total number of pending invites.</ResponseField>
+<ResponseField name="offset" type="number">Number of items skipped.</ResponseField>
+<ResponseField name="limit" type="number">Maximum number of items returned.</ResponseField>
+
+<RequestExample>
+```bash cURL
+curl 'http://localhost:9000/vendor/sellers/sel_01HXYZ/members/invites' \
+  -H 'Authorization: Bearer <token>' \
+  -H 'x-seller-id: <seller_id>'
+```
+
+```ts JS Client
+const { member_invites } = await client.vendor.sellers.$id.members.invites.query({
+  $id: "sel_01HXYZ",
+})
+```
+</RequestExample>
+
+<ResponseExample>
+```json 200
+{
+  "member_invites": [
+    {
+      "id": "meminv_01HXYZ",
+      "email": "teammate@acme.com",
+      "accepted": false,
+      "role_id": "role_seller_order_management",
+      "expires_at": "2026-01-22T10:00:00.000Z",
+      "created_at": "2026-01-15T10:00:00.000Z"
+    }
+  ],
+  "count": 1,
+  "offset": 0,
+  "limit": 50
+}
+```
+</ResponseExample>

package/content/references/api/vendor/sellers/list-seller-members.mdx

@@ -0,0 +1,80 @@
+---
+title: "List Seller Members"
+api: "GET /vendor/sellers/{id}/members"
+description: "List the members of a seller account."
+---
+
+Returns the seller's team members with their roles.
+
+## Path parameters
+
+<ParamField path="id" type="string" required>
+  The seller's ID.
+</ParamField>
+
+## Query parameters
+
+<ParamField query="limit" type="number" default="50">
+  Maximum number of items to return.
+</ParamField>
+
+<ParamField query="offset" type="number" default="0">
+  Number of items to skip.
+</ParamField>
+
+<ParamField query="order" type="string">
+  Field to sort by, prefixed with `-` for descending order.
+</ParamField>
+
+<ParamField query="fields" type="string">
+  Comma-separated fields to include in the response.
+</ParamField>
+
+## Response
+
+<ResponseField name="seller_members" type="object[]">
+  <Expandable title="properties">
+    <ResponseField name="id" type="string">The seller member's ID.</ResponseField>
+    <ResponseField name="is_owner" type="boolean">Whether the member owns the seller account.</ResponseField>
+    <ResponseField name="member" type="object">The member's profile (name, email, etc.).</ResponseField>
+    <ResponseField name="rbac_role" type="object">The member's role for this seller.</ResponseField>
+    <ResponseField name="created_at" type="string">Creation timestamp.</ResponseField>
+  </Expandable>
+</ResponseField>
+
+<ResponseField name="count" type="number">Total number of members.</ResponseField>
+<ResponseField name="offset" type="number">Number of items skipped.</ResponseField>
+<ResponseField name="limit" type="number">Maximum number of items returned.</ResponseField>
+
+<RequestExample>
+```bash cURL
+curl 'http://localhost:9000/vendor/sellers/sel_01HXYZ/members' \
+  -H 'Authorization: Bearer <token>' \
+  -H 'x-seller-id: <seller_id>'
+```
+
+```ts JS Client
+const { seller_members } = await client.vendor.sellers.$id.members.query({
+  $id: "sel_01HXYZ",
+})
+```
+</RequestExample>
+
+<ResponseExample>
+```json 200
+{
+  "seller_members": [
+    {
+      "id": "selmem_01HXYZ",
+      "is_owner": true,
+      "member": { "id": "mem_01HXYZ", "first_name": "Jane", "last_name": "Doe", "email": "owner@acme.com" },
+      "rbac_role": { "id": "role_seller_administration", "name": "Administration" },
+      "created_at": "2026-01-15T10:00:00.000Z"
+    }
+  ],
+  "count": 1,
+  "offset": 0,
+  "limit": 50
+}
+```
+</ResponseExample>

package/content/references/api/vendor/sellers/list-sellers.mdx

@@ -0,0 +1,71 @@
+---
+title: "List Sellers"
+api: "GET /vendor/sellers"
+description: "List the seller accounts the authenticated member belongs to."
+---
+
+Returns the member's seller memberships (excluding terminated sellers), each with the related seller and role.
+
+<Note>
+  This route requires only the `Authorization` header — no `x-seller-id` — since it is used before a seller is selected.
+</Note>
+
+## Query parameters
+
+<ParamField query="limit" type="number" default="50">
+  Maximum number of items to return.
+</ParamField>
+
+<ParamField query="offset" type="number" default="0">
+  Number of items to skip.
+</ParamField>
+
+<ParamField query="order" type="string">
+  Field to sort by, prefixed with `-` for descending order.
+</ParamField>
+
+<ParamField query="fields" type="string">
+  Comma-separated fields to include in the response.
+</ParamField>
+
+## Response
+
+<ResponseField name="seller_members" type="object[]">
+  <Expandable title="properties">
+    <ResponseField name="id" type="string">The seller member's ID.</ResponseField>
+    <ResponseField name="seller" type="object">The related seller.</ResponseField>
+    <ResponseField name="rbac_role" type="object">The member's role for this seller.</ResponseField>
+  </Expandable>
+</ResponseField>
+
+<ResponseField name="count" type="number">Total number of memberships.</ResponseField>
+<ResponseField name="offset" type="number">Number of items skipped.</ResponseField>
+<ResponseField name="limit" type="number">Maximum number of items returned.</ResponseField>
+
+<RequestExample>
+```bash cURL
+curl 'http://localhost:9000/vendor/sellers' \
+  -H 'Authorization: Bearer <token>'
+```
+
+```ts JS Client
+const { seller_members } = await client.vendor.sellers.query()
+```
+</RequestExample>
+
+<ResponseExample>
+```json 200
+{
+  "seller_members": [
+    {
+      "id": "selmem_01HXYZ",
+      "seller": { "id": "sel_01HXYZ", "name": "Acme Store", "status": "open" },
+      "rbac_role": { "id": "role_seller_administration", "name": "Administration" }
+    }
+  ],
+  "count": 1,
+  "offset": 0,
+  "limit": 50
+}
+```
+</ResponseExample>

package/content/references/api/vendor/sellers/remove-seller-member.mdx

@@ -0,0 +1,48 @@
+---
+title: "Remove Seller Member"
+api: "DELETE /vendor/sellers/{id}/members/{member_id}"
+description: "Remove a member from the seller's team."
+---
+
+Removes the seller member and returns a deletion confirmation.
+
+## Path parameters
+
+<ParamField path="id" type="string" required>
+  The seller's ID.
+</ParamField>
+
+<ParamField path="member_id" type="string" required>
+  The seller member's ID.
+</ParamField>
+
+## Response
+
+<ResponseField name="id" type="string">The removed seller member's ID.</ResponseField>
+<ResponseField name="object" type="string">Always `seller_member`.</ResponseField>
+<ResponseField name="deleted" type="boolean">Whether the member was removed.</ResponseField>
+
+<RequestExample>
+```bash cURL
+curl -X DELETE 'http://localhost:9000/vendor/sellers/sel_01HXYZ/members/selmem_01HXYZ' \
+  -H 'Authorization: Bearer <token>' \
+  -H 'x-seller-id: <seller_id>'
+```
+
+```ts JS Client
+const { deleted } = await client.vendor.sellers.$id.members.$member_id.delete({
+  $id: "sel_01HXYZ",
+  $member_id: "selmem_01HXYZ",
+})
+```
+</RequestExample>
+
+<ResponseExample>
+```json 200
+{
+  "id": "selmem_01HXYZ",
+  "object": "seller_member",
+  "deleted": true
+}
+```
+</ResponseExample>

package/content/references/api/vendor/sellers/retrieve-current-seller-member.mdx

@@ -0,0 +1,59 @@
+---
+title: "Retrieve Current Seller Member"
+api: "GET /vendor/sellers/{id}/members/me"
+description: "Retrieve the authenticated member's membership in a seller."
+---
+
+Returns the seller member record linking the authenticated member to the given seller.
+
+## Path parameters
+
+<ParamField path="id" type="string" required>
+  The seller's ID.
+</ParamField>
+
+## Query parameters
+
+<ParamField query="fields" type="string">
+  Comma-separated fields to include in the response.
+</ParamField>
+
+## Response
+
+<ResponseField name="seller_member" type="object">
+  <Expandable title="properties">
+    <ResponseField name="id" type="string">The seller member's ID.</ResponseField>
+    <ResponseField name="is_owner" type="boolean">Whether the member owns the seller account.</ResponseField>
+    <ResponseField name="member" type="object">The member's profile.</ResponseField>
+    <ResponseField name="rbac_role" type="object">The member's role for this seller.</ResponseField>
+    <ResponseField name="created_at" type="string">Creation timestamp.</ResponseField>
+  </Expandable>
+</ResponseField>
+
+<RequestExample>
+```bash cURL
+curl 'http://localhost:9000/vendor/sellers/sel_01HXYZ/members/me' \
+  -H 'Authorization: Bearer <token>' \
+  -H 'x-seller-id: <seller_id>'
+```
+
+```ts JS Client
+const { seller_member } = await client.vendor.sellers.$id.members.me.query({
+  $id: "sel_01HXYZ",
+})
+```
+</RequestExample>
+
+<ResponseExample>
+```json 200
+{
+  "seller_member": {
+    "id": "selmem_01HXYZ",
+    "is_owner": true,
+    "member": { "id": "mem_01HXYZ", "first_name": "Jane", "last_name": "Doe" },
+    "rbac_role": { "id": "role_seller_administration", "name": "Administration" },
+    "created_at": "2026-01-15T10:00:00.000Z"
+  }
+}
+```
+</ResponseExample>

package/content/references/api/vendor/sellers/retrieve-current-seller.mdx

@@ -0,0 +1,69 @@
+---
+title: "Retrieve Current Seller"
+api: "GET /vendor/sellers/me"
+description: "Retrieve the seller the request is scoped to."
+---
+
+Returns the seller identified by the current seller context (`x-seller-id` header or session), including address, payment details, and professional details.
+
+## Query parameters
+
+<ParamField query="fields" type="string">
+  Comma-separated fields to include in the response.
+</ParamField>
+
+## Response
+
+<ResponseField name="seller" type="object">
+  <Expandable title="properties">
+    <ResponseField name="id" type="string">The seller's ID.</ResponseField>
+    <ResponseField name="name" type="string">The seller's name.</ResponseField>
+    <ResponseField name="handle" type="string">The seller's handle.</ResponseField>
+    <ResponseField name="email" type="string">The seller's email.</ResponseField>
+    <ResponseField name="phone" type="string">The seller's phone.</ResponseField>
+    <ResponseField name="description" type="string">Store description.</ResponseField>
+    <ResponseField name="logo" type="string">Logo URL.</ResponseField>
+    <ResponseField name="banner" type="string">Banner URL.</ResponseField>
+    <ResponseField name="website_url" type="string">Website URL.</ResponseField>
+    <ResponseField name="currency_code" type="string">Default currency.</ResponseField>
+    <ResponseField name="status" type="enum">One of `open`, `pending_approval`, `suspended`, `terminated`.</ResponseField>
+    <ResponseField name="approved_at" type="string">Approval timestamp.</ResponseField>
+    <ResponseField name="rejected_at" type="string">Rejection timestamp.</ResponseField>
+    <ResponseField name="is_premium" type="boolean">Whether the seller has premium status.</ResponseField>
+    <ResponseField name="closed_from" type="string">Start of a temporary store closure.</ResponseField>
+    <ResponseField name="closed_to" type="string">End of a temporary store closure.</ResponseField>
+    <ResponseField name="closure_note" type="string">Closure message shown to customers.</ResponseField>
+    <ResponseField name="address" type="object">The seller's address.</ResponseField>
+    <ResponseField name="payment_details" type="object">The seller's bank details.</ResponseField>
+    <ResponseField name="professional_details" type="object">The seller's business registration details.</ResponseField>
+    <ResponseField name="metadata" type="object">Custom key-value pairs.</ResponseField>
+  </Expandable>
+</ResponseField>
+
+<RequestExample>
+```bash cURL
+curl 'http://localhost:9000/vendor/sellers/me' \
+  -H 'Authorization: Bearer <token>' \
+  -H 'x-seller-id: <seller_id>'
+```
+
+```ts JS Client
+const { seller } = await client.vendor.sellers.me.query()
+```
+</RequestExample>
+
+<ResponseExample>
+```json 200
+{
+  "seller": {
+    "id": "sel_01HXYZ",
+    "name": "Acme Store",
+    "handle": "acme-store",
+    "email": "store@acme.com",
+    "status": "open",
+    "currency_code": "usd",
+    "address": { "city": "New York", "country_code": "us" }
+  }
+}
+```
+</ResponseExample>

package/content/references/api/vendor/sellers/select-seller.mdx

@@ -0,0 +1,44 @@
+---
+title: "Select Seller"
+api: "POST /vendor/sellers/select"
+description: "Set the active seller for the member's session."
+---
+
+Stores the chosen seller in the session after verifying the member belongs to it.
+
+<Note>
+  Requires only the `Authorization` header. Session-based clients get the seller stored server-side; token-based clients should send `x-seller-id` on subsequent requests instead.
+</Note>
+
+## Body parameters
+
+<ParamField body="seller_id" type="string" required>
+  The ID of the seller to activate for this session.
+</ParamField>
+
+## Response
+
+<ResponseField name="success" type="boolean">
+  Whether the seller was selected.
+</ResponseField>
+
+<RequestExample>
+```bash cURL
+curl -X POST 'http://localhost:9000/vendor/sellers/select' \
+  -H 'Authorization: Bearer <token>' \
+  -H 'Content-Type: application/json' \
+  -d '{"seller_id": "sel_01HXYZ"}'
+```
+
+```ts JS Client
+const { success } = await client.vendor.sellers.select.mutate({
+  seller_id: "sel_01HXYZ",
+})
+```
+</RequestExample>
+
+<ResponseExample>
+```json 200
+{ "success": true }
+```
+</ResponseExample>

package/content/references/api/vendor/sellers/update-current-seller.mdx

@@ -0,0 +1,108 @@
+---
+title: "Update Current Seller"
+api: "POST /vendor/sellers/me"
+description: "Update the seller the request is scoped to."
+---
+
+Updates the current seller's profile and returns the full seller object.
+
+## Body parameters
+
+<ParamField body="name" type="string">
+  The seller's display name.
+</ParamField>
+
+<ParamField body="handle" type="string">
+  Unique handle for the seller's storefront URL.
+</ParamField>
+
+<ParamField body="email" type="string">
+  The seller's contact email.
+</ParamField>
+
+<ParamField body="phone" type="string">
+  The seller's contact phone number.
+</ParamField>
+
+<ParamField body="description" type="string">
+  Description of the seller's store.
+</ParamField>
+
+<ParamField body="logo" type="string">
+  URL of the seller's logo.
+</ParamField>
+
+<ParamField body="banner" type="string">
+  URL of the seller's banner image.
+</ParamField>
+
+<ParamField body="website_url" type="string">
+  The seller's website URL.
+</ParamField>
+
+<ParamField body="closed_from" type="string">
+  Start date of a temporary store closure (ISO 8601).
+</ParamField>
+
+<ParamField body="closed_to" type="string">
+  End date of a temporary store closure (ISO 8601).
+</ParamField>
+
+<ParamField body="closure_note" type="string">
+  Message shown to customers while the store is closed.
+</ParamField>
+
+<ParamField body="metadata" type="object">
+  Custom key-value pairs.
+</ParamField>
+
+<ParamField body="additional_data" type="object">
+  Custom data passed to workflow hooks.
+</ParamField>
+
+## Query parameters
+
+<ParamField query="fields" type="string">
+  Comma-separated fields to include in the response.
+</ParamField>
+
+## Response
+
+<ResponseField name="seller" type="object">
+  <Expandable title="properties">
+    <ResponseField name="id" type="string">The seller's ID.</ResponseField>
+    <ResponseField name="name" type="string">The seller's name.</ResponseField>
+    <ResponseField name="handle" type="string">The seller's handle.</ResponseField>
+    <ResponseField name="status" type="enum">One of `open`, `pending_approval`, `suspended`, `terminated`.</ResponseField>
+  </Expandable>
+</ResponseField>
+
+<RequestExample>
+```bash cURL
+curl -X POST 'http://localhost:9000/vendor/sellers/me' \
+  -H 'Authorization: Bearer <token>' \
+  -H 'x-seller-id: <seller_id>' \
+  -H 'Content-Type: application/json' \
+  -d '{"description": "Handmade goods from Brooklyn."}'
+```
+
+```ts JS Client
+const { seller } = await client.vendor.sellers.me.mutate({
+  description: "Handmade goods from Brooklyn.",
+})
+```
+</RequestExample>
+
+<ResponseExample>
+```json 200
+{
+  "seller": {
+    "id": "sel_01HXYZ",
+    "name": "Acme Store",
+    "handle": "acme-store",
+    "description": "Handmade goods from Brooklyn.",
+    "status": "open"
+  }
+}
+```
+</ResponseExample>

package/content/references/api/vendor/sellers/update-member-role.mdx

@@ -0,0 +1,51 @@
+---
+title: "Update Member Role"
+api: "POST /vendor/sellers/{id}/members/{member_id}"
+description: "Change the role of a seller team member."
+---
+
+Updates the role assigned to a seller member.
+
+## Path parameters
+
+<ParamField path="id" type="string" required>
+  The seller's ID.
+</ParamField>
+
+<ParamField path="member_id" type="string" required>
+  The seller member's ID.
+</ParamField>
+
+## Body parameters
+
+<ParamField body="role_id" type="enum" required>
+  The new role. One of `role_seller_administration`, `role_seller_inventory_management`, `role_seller_order_management`, `role_seller_accounting`, `role_seller_support`.
+</ParamField>
+
+## Response
+
+An empty object on success.
+
+<RequestExample>
+```bash cURL
+curl -X POST 'http://localhost:9000/vendor/sellers/sel_01HXYZ/members/selmem_01HXYZ' \
+  -H 'Authorization: Bearer <token>' \
+  -H 'x-seller-id: <seller_id>' \
+  -H 'Content-Type: application/json' \
+  -d '{"role_id": "role_seller_accounting"}'
+```
+
+```ts JS Client
+await client.vendor.sellers.$id.members.$member_id.mutate({
+  $id: "sel_01HXYZ",
+  $member_id: "selmem_01HXYZ",
+  role_id: "role_seller_accounting",
+})
+```
+</RequestExample>
+
+<ResponseExample>
+```json 200
+{}
+```
+</ResponseExample>