@mercurjs/docs 2.2.0-canary.40

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

@@ -0,0 +1,42 @@
+---
+title: "Remove Seller Member"
+api: "DELETE /admin/sellers/{id}/members/{member_id}"
+description: "Remove a member from a seller's team."
+---
+
+Unlinks the seller member from the seller.
+
+## 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">ID of the removed seller member.</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/admin/sellers/sel_01HXYZABCDEF/members/selmem_01HXYZSMBB' \
+  -H 'Authorization: Bearer <token>'
+```
+
+```ts JS Client
+const result = await client.admin.sellers.$id.members.$memberId.delete({
+  $id: "sel_01HXYZABCDEF",
+  $memberId: "selmem_01HXYZSMBB",
+})
+```
+</RequestExample>
+
+<ResponseExample>
+```json 200
+{
+  "id": "selmem_01HXYZSMBB",
+  "object": "seller_member",
+  "deleted": true
+}
+```
+</ResponseExample>

package/content/references/api/admin/sellers/resend-member-invite.mdx

@@ -0,0 +1,55 @@
+---
+title: "Resend Member Invite"
+api: "POST /admin/sellers/{id}/members/invites/{invite_id}/resend"
+description: "Resend a seller's member invite."
+---
+
+Regenerates the invite token, extends its expiry, and re-sends the invite email.
+
+## Path parameters
+
+<ParamField path="id" type="string" required>The seller's ID.</ParamField>
+<ParamField path="invite_id" type="string" required>The invite's ID.</ParamField>
+
+## Response
+
+<ResponseField name="member_invite" type="object">
+  <Expandable title="properties">
+    <ResponseField name="id" type="string">The invite's ID.</ResponseField>
+    <ResponseField name="email" type="string">Invited email address.</ResponseField>
+    <ResponseField name="role_id" type="string">Role assigned on acceptance.</ResponseField>
+    <ResponseField name="accepted" type="boolean">Whether the invite was accepted.</ResponseField>
+    <ResponseField name="token" type="string">The regenerated invite token.</ResponseField>
+    <ResponseField name="expires_at" type="string">The new expiry date.</ResponseField>
+  </Expandable>
+</ResponseField>
+
+<RequestExample>
+```bash cURL
+curl -X POST 'http://localhost:9000/admin/sellers/sel_01HXYZABCDEF/members/invites/meminv_01HXYZINVAA/resend' \
+  -H 'Authorization: Bearer <token>'
+```
+
+```ts JS Client
+const { member_invite } =
+  await client.admin.sellers.$id.members.invites.$inviteId.resend.mutate({
+    $id: "sel_01HXYZABCDEF",
+    $inviteId: "meminv_01HXYZINVAA",
+  })
+```
+</RequestExample>
+
+<ResponseExample>
+```json 200
+{
+  "member_invite": {
+    "id": "meminv_01HXYZINVAA",
+    "email": "new.member@acme.co",
+    "role_id": "role_01HXYZROLEAA",
+    "accepted": false,
+    "token": "inv_token_def456",
+    "expires_at": "2026-06-29T09:00:00.000Z"
+  }
+}
+```
+</ResponseExample>

package/content/references/api/admin/sellers/retrieve-seller.mdx

@@ -0,0 +1,81 @@
+---
+title: "Retrieve Seller"
+api: "GET /admin/sellers/{id}"
+description: "Retrieve a seller by ID."
+---
+
+Returns a single seller, including address, payment details, professional details, payout account, and members.
+
+## Path parameters
+
+<ParamField path="id" type="string" required>The seller's ID.</ParamField>
+
+## Query parameters
+
+<ParamField query="fields" type="string">Comma-separated list of fields to include, prefix with `+`/`-` to add or remove from defaults.</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">Display name of the seller.</ResponseField>
+    <ResponseField name="handle" type="string">Unique URL-safe handle.</ResponseField>
+    <ResponseField name="email" type="string">Contact email of the seller.</ResponseField>
+    <ResponseField name="phone" type="string">Contact phone number.</ResponseField>
+    <ResponseField name="description" type="string">Seller description.</ResponseField>
+    <ResponseField name="logo" type="string">URL of the seller's logo.</ResponseField>
+    <ResponseField name="banner" type="string">URL of the seller's banner image.</ResponseField>
+    <ResponseField name="website_url" type="string">The seller's website URL.</ResponseField>
+    <ResponseField name="currency_code" type="string">The seller's currency code.</ResponseField>
+    <ResponseField name="status" type="string">One of `open`, `pending_approval`, `suspended`, `terminated`.</ResponseField>
+    <ResponseField name="status_reason" type="string">Reason recorded with the latest status change.</ResponseField>
+    <ResponseField name="approved_at" type="string">When the seller was approved.</ResponseField>
+    <ResponseField name="rejected_at" type="string">When the seller was rejected.</ResponseField>
+    <ResponseField name="is_premium" type="boolean">Whether the seller is marked as premium.</ResponseField>
+    <ResponseField name="address" type="object">The seller's address.</ResponseField>
+    <ResponseField name="payment_details" type="object">The seller's bank payment details.</ResponseField>
+    <ResponseField name="professional_details" type="object">The seller's legal and tax details.</ResponseField>
+    <ResponseField name="payout_account" type="object">The seller's payout account with status and onboarding data.</ResponseField>
+    <ResponseField name="members" type="object[]">The seller's members.</ResponseField>
+    <ResponseField name="metadata" type="object">Custom key-value data.</ResponseField>
+    <ResponseField name="created_at" type="string">Creation timestamp.</ResponseField>
+    <ResponseField name="updated_at" type="string">Last update timestamp.</ResponseField>
+  </Expandable>
+</ResponseField>
+
+<RequestExample>
+```bash cURL
+curl 'http://localhost:9000/admin/sellers/sel_01HXYZABCDEF' \
+  -H 'Authorization: Bearer <token>'
+```
+
+```ts JS Client
+const { seller } = await client.admin.sellers.$id.query({
+  $id: "sel_01HXYZABCDEF",
+})
+```
+</RequestExample>
+
+<ResponseExample>
+```json 200
+{
+  "seller": {
+    "id": "sel_01HXYZABCDEF",
+    "name": "Acme",
+    "handle": "acme",
+    "email": "hello@acme.co",
+    "currency_code": "usd",
+    "status": "open",
+    "approved_at": "2026-06-02T09:30:00.000Z",
+    "is_premium": false,
+    "address": null,
+    "payment_details": null,
+    "professional_details": null,
+    "members": [],
+    "created_at": "2026-06-01T10:00:00.000Z",
+    "updated_at": "2026-06-02T09:30:00.000Z"
+  }
+}
+```
+</ResponseExample>

package/content/references/api/admin/sellers/suspend-seller.mdx

@@ -0,0 +1,60 @@
+---
+title: "Suspend Seller"
+api: "POST /admin/sellers/{id}/suspend"
+description: "Suspend a seller."
+---
+
+Sets the seller's status to `suspended`, optionally recording a reason.
+
+## Path parameters
+
+<ParamField path="id" type="string" required>The seller's ID.</ParamField>
+
+## Query parameters
+
+<ParamField query="fields" type="string">Comma-separated list of fields to include, prefix with `+`/`-` to add or remove from defaults.</ParamField>
+
+## Body parameters
+
+<ParamField body="reason" type="string">Reason for the suspension, stored in `status_reason`.</ParamField>
+
+## Response
+
+<ResponseField name="seller" type="object">
+  <Expandable title="properties">
+    <ResponseField name="id" type="string">The seller's ID.</ResponseField>
+    <ResponseField name="status" type="string">The seller's status, `suspended` after this call.</ResponseField>
+    <ResponseField name="status_reason" type="string">The recorded suspension reason.</ResponseField>
+    <ResponseField name="updated_at" type="string">Last update timestamp.</ResponseField>
+  </Expandable>
+</ResponseField>
+
+<RequestExample>
+```bash cURL
+curl -X POST 'http://localhost:9000/admin/sellers/sel_01HXYZABCDEF/suspend' \
+  -H 'Authorization: Bearer <token>' \
+  -H 'Content-Type: application/json' \
+  -d '{"reason": "Policy violation"}'
+```
+
+```ts JS Client
+const { seller } = await client.admin.sellers.$id.suspend.mutate({
+  $id: "sel_01HXYZABCDEF",
+  reason: "Policy violation",
+})
+```
+</RequestExample>
+
+<ResponseExample>
+```json 200
+{
+  "seller": {
+    "id": "sel_01HXYZABCDEF",
+    "name": "Acme",
+    "status": "suspended",
+    "status_reason": "Policy violation",
+    "updated_at": "2026-06-05T11:00:00.000Z"
+  }
+}
+```
+</ResponseExample>

package/content/references/api/admin/sellers/terminate-seller.mdx

@@ -0,0 +1,60 @@
+---
+title: "Terminate Seller"
+api: "POST /admin/sellers/{id}/terminate"
+description: "Terminate a seller account."
+---
+
+Sets the seller's status to `terminated`, optionally recording a reason.
+
+## Path parameters
+
+<ParamField path="id" type="string" required>The seller's ID.</ParamField>
+
+## Query parameters
+
+<ParamField query="fields" type="string">Comma-separated list of fields to include, prefix with `+`/`-` to add or remove from defaults.</ParamField>
+
+## Body parameters
+
+<ParamField body="reason" type="string">Reason for the termination, stored in `status_reason`.</ParamField>
+
+## Response
+
+<ResponseField name="seller" type="object">
+  <Expandable title="properties">
+    <ResponseField name="id" type="string">The seller's ID.</ResponseField>
+    <ResponseField name="status" type="string">The seller's status, `terminated` after this call.</ResponseField>
+    <ResponseField name="status_reason" type="string">The recorded termination reason.</ResponseField>
+    <ResponseField name="updated_at" type="string">Last update timestamp.</ResponseField>
+  </Expandable>
+</ResponseField>
+
+<RequestExample>
+```bash cURL
+curl -X POST 'http://localhost:9000/admin/sellers/sel_01HXYZABCDEF/terminate' \
+  -H 'Authorization: Bearer <token>' \
+  -H 'Content-Type: application/json' \
+  -d '{"reason": "Account closed by operator"}'
+```
+
+```ts JS Client
+const { seller } = await client.admin.sellers.$id.terminate.mutate({
+  $id: "sel_01HXYZABCDEF",
+  reason: "Account closed by operator",
+})
+```
+</RequestExample>
+
+<ResponseExample>
+```json 200
+{
+  "seller": {
+    "id": "sel_01HXYZABCDEF",
+    "name": "Acme",
+    "status": "terminated",
+    "status_reason": "Account closed by operator",
+    "updated_at": "2026-06-10T16:45:00.000Z"
+  }
+}
+```
+</ResponseExample>

package/content/references/api/admin/sellers/unsuspend-seller.mdx

@@ -0,0 +1,52 @@
+---
+title: "Unsuspend Seller"
+api: "POST /admin/sellers/{id}/unsuspend"
+description: "Lift a seller's suspension."
+---
+
+Restores a suspended seller to `open`.
+
+## Path parameters
+
+<ParamField path="id" type="string" required>The seller's ID.</ParamField>
+
+## Query parameters
+
+<ParamField query="fields" type="string">Comma-separated list of fields to include, prefix with `+`/`-` to add or remove from defaults.</ParamField>
+
+## Response
+
+<ResponseField name="seller" type="object">
+  <Expandable title="properties">
+    <ResponseField name="id" type="string">The seller's ID.</ResponseField>
+    <ResponseField name="status" type="string">The seller's status, `open` after this call.</ResponseField>
+    <ResponseField name="updated_at" type="string">Last update timestamp.</ResponseField>
+  </Expandable>
+</ResponseField>
+
+<RequestExample>
+```bash cURL
+curl -X POST 'http://localhost:9000/admin/sellers/sel_01HXYZABCDEF/unsuspend' \
+  -H 'Authorization: Bearer <token>'
+```
+
+```ts JS Client
+const { seller } = await client.admin.sellers.$id.unsuspend.mutate({
+  $id: "sel_01HXYZABCDEF",
+})
+```
+</RequestExample>
+
+<ResponseExample>
+```json 200
+{
+  "seller": {
+    "id": "sel_01HXYZABCDEF",
+    "name": "Acme",
+    "status": "open",
+    "status_reason": null,
+    "updated_at": "2026-06-06T08:15:00.000Z"
+  }
+}
+```
+</ResponseExample>

package/content/references/api/admin/sellers/unterminate-seller.mdx

@@ -0,0 +1,52 @@
+---
+title: "Unterminate Seller"
+api: "POST /admin/sellers/{id}/unterminate"
+description: "Reverse a seller termination."
+---
+
+Restores a terminated seller to `open`.
+
+## Path parameters
+
+<ParamField path="id" type="string" required>The seller's ID.</ParamField>
+
+## Query parameters
+
+<ParamField query="fields" type="string">Comma-separated list of fields to include, prefix with `+`/`-` to add or remove from defaults.</ParamField>
+
+## Response
+
+<ResponseField name="seller" type="object">
+  <Expandable title="properties">
+    <ResponseField name="id" type="string">The seller's ID.</ResponseField>
+    <ResponseField name="status" type="string">The seller's status, `open` after this call.</ResponseField>
+    <ResponseField name="updated_at" type="string">Last update timestamp.</ResponseField>
+  </Expandable>
+</ResponseField>
+
+<RequestExample>
+```bash cURL
+curl -X POST 'http://localhost:9000/admin/sellers/sel_01HXYZABCDEF/unterminate' \
+  -H 'Authorization: Bearer <token>'
+```
+
+```ts JS Client
+const { seller } = await client.admin.sellers.$id.unterminate.mutate({
+  $id: "sel_01HXYZABCDEF",
+})
+```
+</RequestExample>
+
+<ResponseExample>
+```json 200
+{
+  "seller": {
+    "id": "sel_01HXYZABCDEF",
+    "name": "Acme",
+    "status": "open",
+    "status_reason": null,
+    "updated_at": "2026-06-11T09:00:00.000Z"
+  }
+}
+```
+</ResponseExample>

package/content/references/api/admin/sellers/update-seller.mdx

@@ -0,0 +1,83 @@
+---
+title: "Update Seller"
+api: "POST /admin/sellers/{id}"
+description: "Update a seller's details."
+---
+
+Updates the seller and returns the updated record.
+
+## Path parameters
+
+<ParamField path="id" type="string" required>The seller's ID.</ParamField>
+
+## Query parameters
+
+<ParamField query="fields" type="string">Comma-separated list of fields to include, prefix with `+`/`-` to add or remove from defaults.</ParamField>
+
+## Body parameters
+
+<ParamField body="name" type="string">Display name of the seller.</ParamField>
+<ParamField body="handle" type="string">Unique URL-safe handle.</ParamField>
+<ParamField body="email" type="string">Contact email of the seller.</ParamField>
+<ParamField body="phone" type="string">Contact phone number.</ParamField>
+<ParamField body="description" type="string">Seller description.</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="external_id" type="string">ID of the seller in an external system.</ParamField>
+<ParamField body="status" type="string">One of `open`, `pending_approval`, `suspended`, `terminated`.</ParamField>
+<ParamField body="status_reason" type="string">Reason recorded with the status.</ParamField>
+<ParamField body="is_premium" type="boolean">Whether the seller is marked as premium.</ParamField>
+<ParamField body="closed_from" type="string">Start of a temporary store closure.</ParamField>
+<ParamField body="closed_to" type="string">End of a temporary store closure.</ParamField>
+<ParamField body="closure_note" type="string">Note shown while the store is closed.</ParamField>
+<ParamField body="metadata" type="object">Custom key-value data.</ParamField>
+<ParamField body="additional_data" type="object">Extra data passed to workflow hooks.</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">Display name of the seller.</ResponseField>
+    <ResponseField name="handle" type="string">Unique URL-safe handle.</ResponseField>
+    <ResponseField name="email" type="string">Contact email of the seller.</ResponseField>
+    <ResponseField name="status" type="string">One of `open`, `pending_approval`, `suspended`, `terminated`.</ResponseField>
+    <ResponseField name="is_premium" type="boolean">Whether the seller is marked as premium.</ResponseField>
+    <ResponseField name="updated_at" type="string">Last update timestamp.</ResponseField>
+  </Expandable>
+</ResponseField>
+
+<RequestExample>
+```bash cURL
+curl -X POST 'http://localhost:9000/admin/sellers/sel_01HXYZABCDEF' \
+  -H 'Authorization: Bearer <token>' \
+  -H 'Content-Type: application/json' \
+  -d '{"description": "Handmade goods.", "is_premium": true}'
+```
+
+```ts JS Client
+const { seller } = await client.admin.sellers.$id.mutate({
+  $id: "sel_01HXYZABCDEF",
+  description: "Handmade goods.",
+  is_premium: true,
+})
+```
+</RequestExample>
+
+<ResponseExample>
+```json 200
+{
+  "seller": {
+    "id": "sel_01HXYZABCDEF",
+    "name": "Acme",
+    "handle": "acme",
+    "email": "hello@acme.co",
+    "description": "Handmade goods.",
+    "status": "open",
+    "is_premium": true,
+    "updated_at": "2026-06-03T14:20:00.000Z"
+  }
+}
+```
+</ResponseExample>

package/content/references/api/admin/sellers/upsert-payment-details.mdx

@@ -0,0 +1,88 @@
+---
+title: "Upsert Payment Details"
+api: "POST /admin/sellers/{id}/payment-details"
+description: "Create or update a seller's bank payment details."
+---
+
+Creates the seller's payment details if none exist, otherwise updates them.
+
+## Path parameters
+
+<ParamField path="id" type="string" required>The seller's ID.</ParamField>
+
+## Query parameters
+
+<ParamField query="fields" type="string">Comma-separated list of fields to include, prefix with `+`/`-` to add or remove from defaults.</ParamField>
+
+## Body parameters
+
+<ParamField body="country_code" type="string">Two-letter ISO country code of the bank account.</ParamField>
+<ParamField body="holder_name" type="string">Name of the account holder.</ParamField>
+<ParamField body="bank_name" type="string">Name of the bank.</ParamField>
+<ParamField body="iban" type="string">IBAN of the account.</ParamField>
+<ParamField body="bic" type="string">BIC / SWIFT code.</ParamField>
+<ParamField body="routing_number" type="string">Routing number for US accounts.</ParamField>
+<ParamField body="account_number" type="string">Account number.</ParamField>
+<ParamField body="additional_data" type="object">Extra data passed to workflow hooks.</ParamField>
+
+## Response
+
+<ResponseField name="seller" type="object">
+  <Expandable title="properties">
+    <ResponseField name="id" type="string">The seller's ID.</ResponseField>
+    <ResponseField name="payment_details" type="object">
+      <Expandable title="properties">
+        <ResponseField name="country_code" type="string">Two-letter ISO country code of the bank account.</ResponseField>
+        <ResponseField name="holder_name" type="string">Name of the account holder.</ResponseField>
+        <ResponseField name="bank_name" type="string">Name of the bank.</ResponseField>
+        <ResponseField name="iban" type="string">IBAN of the account.</ResponseField>
+        <ResponseField name="bic" type="string">BIC / SWIFT code.</ResponseField>
+      </Expandable>
+    </ResponseField>
+    <ResponseField name="updated_at" type="string">Last update timestamp.</ResponseField>
+  </Expandable>
+</ResponseField>
+
+<RequestExample>
+```bash cURL
+curl -X POST 'http://localhost:9000/admin/sellers/sel_01HXYZABCDEF/payment-details' \
+  -H 'Authorization: Bearer <token>' \
+  -H 'Content-Type: application/json' \
+  -d '{
+    "country_code": "de",
+    "holder_name": "Acme GmbH",
+    "iban": "DE89370400440532013000",
+    "bic": "COBADEFFXXX"
+  }'
+```
+
+```ts JS Client
+const { seller } = await client.admin.sellers.$id.paymentDetails.mutate({
+  $id: "sel_01HXYZABCDEF",
+  country_code: "de",
+  holder_name: "Acme GmbH",
+  iban: "DE89370400440532013000",
+  bic: "COBADEFFXXX",
+})
+```
+</RequestExample>
+
+<ResponseExample>
+```json 200
+{
+  "seller": {
+    "id": "sel_01HXYZABCDEF",
+    "name": "Acme",
+    "status": "open",
+    "payment_details": {
+      "country_code": "de",
+      "holder_name": "Acme GmbH",
+      "bank_name": null,
+      "iban": "DE89370400440532013000",
+      "bic": "COBADEFFXXX"
+    },
+    "updated_at": "2026-06-12T11:00:00.000Z"
+  }
+}
+```
+</ResponseExample>

package/content/references/api/admin/sellers/upsert-professional-details.mdx

@@ -0,0 +1,78 @@
+---
+title: "Upsert Professional Details"
+api: "POST /admin/sellers/{id}/professional-details"
+description: "Create or update a seller's legal and tax details."
+---
+
+Creates the seller's professional details if none exist, otherwise updates them.
+
+## Path parameters
+
+<ParamField path="id" type="string" required>The seller's ID.</ParamField>
+
+## Query parameters
+
+<ParamField query="fields" type="string">Comma-separated list of fields to include, prefix with `+`/`-` to add or remove from defaults.</ParamField>
+
+## Body parameters
+
+<ParamField body="corporate_name" type="string">Registered corporate name.</ParamField>
+<ParamField body="registration_number" type="string">Company registration number.</ParamField>
+<ParamField body="tax_id" type="string">Tax identification number.</ParamField>
+<ParamField body="additional_data" type="object">Extra data passed to workflow hooks.</ParamField>
+
+## Response
+
+<ResponseField name="seller" type="object">
+  <Expandable title="properties">
+    <ResponseField name="id" type="string">The seller's ID.</ResponseField>
+    <ResponseField name="professional_details" type="object">
+      <Expandable title="properties">
+        <ResponseField name="corporate_name" type="string">Registered corporate name.</ResponseField>
+        <ResponseField name="registration_number" type="string">Company registration number.</ResponseField>
+        <ResponseField name="tax_id" type="string">Tax identification number.</ResponseField>
+      </Expandable>
+    </ResponseField>
+    <ResponseField name="updated_at" type="string">Last update timestamp.</ResponseField>
+  </Expandable>
+</ResponseField>
+
+<RequestExample>
+```bash cURL
+curl -X POST 'http://localhost:9000/admin/sellers/sel_01HXYZABCDEF/professional-details' \
+  -H 'Authorization: Bearer <token>' \
+  -H 'Content-Type: application/json' \
+  -d '{
+    "corporate_name": "Acme GmbH",
+    "registration_number": "HRB 123456",
+    "tax_id": "DE123456789"
+  }'
+```
+
+```ts JS Client
+const { seller } = await client.admin.sellers.$id.professionalDetails.mutate({
+  $id: "sel_01HXYZABCDEF",
+  corporate_name: "Acme GmbH",
+  registration_number: "HRB 123456",
+  tax_id: "DE123456789",
+})
+```
+</RequestExample>
+
+<ResponseExample>
+```json 200
+{
+  "seller": {
+    "id": "sel_01HXYZABCDEF",
+    "name": "Acme",
+    "status": "open",
+    "professional_details": {
+      "corporate_name": "Acme GmbH",
+      "registration_number": "HRB 123456",
+      "tax_id": "DE123456789"
+    },
+    "updated_at": "2026-06-12T11:30:00.000Z"
+  }
+}
+```
+</ResponseExample>