@mercurjs/docs 2.2.0-canary.40

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

@@ -0,0 +1,103 @@
+---
+title: "List Orders"
+api: "GET /vendor/orders"
+description: "Retrieve a paginated list of the seller's orders."
+---
+
+Returns all non-draft orders belonging to the authenticated seller, with optional filtering by status, customer, region, and more.
+
+## Query parameters
+
+<ParamField query="limit" type="number" default="50">Maximum number of records to return.</ParamField>
+<ParamField query="offset" type="number" default="0">Number of records to skip.</ParamField>
+<ParamField query="order" type="string">Field to sort by, prefix with `-` for descending order.</ParamField>
+<ParamField query="fields" type="string">Comma-separated list of fields to include, prefix with `+`/`-` to add or remove from defaults.</ParamField>
+<ParamField query="q" type="string">Search term matched against order fields.</ParamField>
+<ParamField query="id" type="string | string[]">Filter by order ID(s).</ParamField>
+<ParamField query="status" type="string | string[]">Filter by order status.</ParamField>
+<ParamField query="customer_id" type="string | string[]">Filter by customer ID(s).</ParamField>
+<ParamField query="sales_channel_id" type="string | string[]">Filter by sales channel ID(s).</ParamField>
+<ParamField query="region_id" type="string | string[]">Filter by region ID(s).</ParamField>
+<ParamField query="currency_code" type="string | string[]">Filter by currency code(s).</ParamField>
+<ParamField query="fulfillment_status" type="string">Filter by fulfillment status.</ParamField>
+<ParamField query="payment_status" type="string">Filter by payment status.</ParamField>
+<ParamField query="created_at" type="object">Filter by creation date with operators like `$gte`, `$lte`.</ParamField>
+<ParamField query="updated_at" type="object">Filter by update date with operators like `$gte`, `$lte`.</ParamField>
+
+## Response
+
+<ResponseField name="orders" type="object[]">
+  <Expandable title="properties">
+    <ResponseField name="id" type="string">The order's ID.</ResponseField>
+    <ResponseField name="display_id" type="number">Human-readable order number.</ResponseField>
+    <ResponseField name="status" type="string">The order's status.</ResponseField>
+    <ResponseField name="email" type="string">The customer's email.</ResponseField>
+    <ResponseField name="currency_code" type="string">The order's currency code.</ResponseField>
+    <ResponseField name="region_id" type="string">ID of the order's region.</ResponseField>
+    <ResponseField name="customer_id" type="string">ID of the customer.</ResponseField>
+    <ResponseField name="sales_channel_id" type="string">ID of the sales channel.</ResponseField>
+    <ResponseField name="items" type="object[]">The order's line items, including variant, product, and offer data.</ResponseField>
+    <ResponseField name="shipping_address" type="object">The order's shipping address.</ResponseField>
+    <ResponseField name="billing_address" type="object">The order's billing address.</ResponseField>
+    <ResponseField name="shipping_methods" type="object[]">The order's shipping methods.</ResponseField>
+    <ResponseField name="payment_collections" type="object[]">Payment collections with payments and refunds.</ResponseField>
+    <ResponseField name="fulfillments" type="object[]">The order's fulfillments.</ResponseField>
+    <ResponseField name="returns" type="object[]">The order's returns with items and reasons.</ResponseField>
+    <ResponseField name="summary" type="object">Order totals summary.</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>
+    <ResponseField name="canceled_at" type="string">Cancellation timestamp, if canceled.</ResponseField>
+  </Expandable>
+</ResponseField>
+<ResponseField name="count" type="number">Total number of matching orders.</ResponseField>
+<ResponseField name="offset" type="number">Number of records skipped.</ResponseField>
+<ResponseField name="limit" type="number">Number of records returned.</ResponseField>
+
+<RequestExample>
+```bash cURL
+curl 'http://localhost:9000/vendor/orders?limit=20&order=-created_at' \
+  -H 'Authorization: Bearer <token>' \
+  -H 'x-seller-id: <seller_id>'
+```
+
+```ts JS Client
+const { orders, count } = await client.vendor.orders.query({
+  limit: 20,
+  order: "-created_at",
+})
+```
+</RequestExample>
+
+<ResponseExample>
+```json 200
+{
+  "orders": [
+    {
+      "id": "order_01HXYZABCDEF",
+      "display_id": 42,
+      "status": "pending",
+      "email": "jane@example.com",
+      "currency_code": "usd",
+      "region_id": "reg_01HXYZABCDEF",
+      "customer_id": "cus_01HXYZABCDEF",
+      "sales_channel_id": "sc_01HXYZABCDEF",
+      "items": [
+        {
+          "id": "ordli_01HXYZABCDEF",
+          "title": "T-Shirt / M",
+          "quantity": 1,
+          "unit_price": 2500
+        }
+      ],
+      "created_at": "2026-06-01T10:00:00.000Z",
+      "updated_at": "2026-06-01T10:00:00.000Z",
+      "canceled_at": null
+    }
+  ],
+  "count": 1,
+  "offset": 0,
+  "limit": 20
+}
+```
+</ResponseExample>

package/content/references/api/vendor/orders/mark-fulfillment-delivered.mdx

@@ -0,0 +1,62 @@
+---
+title: "Mark Fulfillment as Delivered"
+api: "POST /vendor/orders/{id}/fulfillments/{fulfillment_id}/mark-as-delivered"
+description: "Mark a fulfillment as delivered."
+---
+
+Marks the fulfillment as delivered and returns the updated order.
+
+## Path parameters
+
+<ParamField path="id" type="string" required>The order's ID.</ParamField>
+<ParamField path="fulfillment_id" type="string" required>The fulfillment's ID.</ParamField>
+
+## Query parameters
+
+<ParamField query="fields" type="string">Comma-separated list of fields to include in the returned order, prefix with `+`/`-` to add or remove from defaults.</ParamField>
+
+## Response
+
+<ResponseField name="order" type="object">
+  <Expandable title="properties">
+    <ResponseField name="id" type="string">The order's ID.</ResponseField>
+    <ResponseField name="status" type="string">The order's status.</ResponseField>
+    <ResponseField name="fulfillments" type="object[]">The order's fulfillments with `delivered_at` set.</ResponseField>
+    <ResponseField name="items" type="object[]">The order's line items.</ResponseField>
+  </Expandable>
+</ResponseField>
+
+<RequestExample>
+```bash cURL
+curl -X POST 'http://localhost:9000/vendor/orders/order_01HXYZABCDEF/fulfillments/ful_01HXYZABCDEF/mark-as-delivered' \
+  -H 'Authorization: Bearer <token>' \
+  -H 'x-seller-id: <seller_id>'
+```
+
+```ts JS Client
+const { order } =
+  await client.vendor.orders.$id.fulfillments.$fulfillment_id.markAsDelivered.mutate({
+    $id: "order_01HXYZABCDEF",
+    $fulfillment_id: "ful_01HXYZABCDEF",
+  })
+```
+</RequestExample>
+
+<ResponseExample>
+```json 200
+{
+  "order": {
+    "id": "order_01HXYZABCDEF",
+    "display_id": 42,
+    "status": "pending",
+    "fulfillments": [
+      {
+        "id": "ful_01HXYZABCDEF",
+        "shipped_at": "2026-06-04T10:00:00.000Z",
+        "delivered_at": "2026-06-06T09:30:00.000Z"
+      }
+    ]
+  }
+}
+```
+</ResponseExample>

package/content/references/api/vendor/orders/preview-order.mdx

@@ -0,0 +1,65 @@
+---
+title: "Preview Order"
+api: "GET /vendor/orders/{id}/preview"
+description: "Preview the order with its pending order change applied."
+---
+
+Returns a preview of the order as it would look once the currently active order change (e.g. a pending edit, return, or exchange) is confirmed.
+
+## Path parameters
+
+<ParamField path="id" type="string" required>The order's ID.</ParamField>
+
+## Response
+
+<ResponseField name="order" type="object">
+  <Expandable title="properties">
+    <ResponseField name="id" type="string">The order's ID.</ResponseField>
+    <ResponseField name="display_id" type="number">Human-readable order number.</ResponseField>
+    <ResponseField name="status" type="string">The order's status.</ResponseField>
+    <ResponseField name="items" type="object[]">Line items with pending change actions applied.</ResponseField>
+    <ResponseField name="shipping_methods" type="object[]">Shipping methods with pending change actions applied.</ResponseField>
+    <ResponseField name="order_change" type="object">The active order change being previewed.</ResponseField>
+    <ResponseField name="total" type="number">Projected order total after the change.</ResponseField>
+  </Expandable>
+</ResponseField>
+
+<RequestExample>
+```bash cURL
+curl 'http://localhost:9000/vendor/orders/order_01HXYZABCDEF/preview' \
+  -H 'Authorization: Bearer <token>' \
+  -H 'x-seller-id: <seller_id>'
+```
+
+```ts JS Client
+const { order } = await client.vendor.orders.$id.preview.query({
+  $id: "order_01HXYZABCDEF",
+})
+```
+</RequestExample>
+
+<ResponseExample>
+```json 200
+{
+  "order": {
+    "id": "order_01HXYZABCDEF",
+    "display_id": 42,
+    "status": "pending",
+    "items": [
+      {
+        "id": "ordli_01HXYZABCDEF",
+        "title": "T-Shirt / M",
+        "quantity": 1,
+        "unit_price": 2500
+      }
+    ],
+    "order_change": {
+      "id": "ordch_01HXYZABCDEF",
+      "change_type": "edit",
+      "status": "pending"
+    },
+    "total": 2500
+  }
+}
+```
+</ResponseExample>

package/content/references/api/vendor/orders/retrieve-order.mdx

@@ -0,0 +1,84 @@
+---
+title: "Retrieve Order"
+api: "GET /vendor/orders/{id}"
+description: "Retrieve a single order by ID."
+---
+
+Returns an order belonging to the authenticated seller, including items, addresses, payments, fulfillments, and returns.
+
+## Path parameters
+
+<ParamField path="id" type="string" required>The order'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="order" type="object">
+  <Expandable title="properties">
+    <ResponseField name="id" type="string">The order's ID.</ResponseField>
+    <ResponseField name="display_id" type="number">Human-readable order number.</ResponseField>
+    <ResponseField name="status" type="string">The order's status.</ResponseField>
+    <ResponseField name="email" type="string">The customer's email.</ResponseField>
+    <ResponseField name="currency_code" type="string">The order's currency code.</ResponseField>
+    <ResponseField name="region_id" type="string">ID of the order's region.</ResponseField>
+    <ResponseField name="customer_id" type="string">ID of the customer.</ResponseField>
+    <ResponseField name="sales_channel_id" type="string">ID of the sales channel.</ResponseField>
+    <ResponseField name="items" type="object[]">The order's line items, including variant, product, and offer data.</ResponseField>
+    <ResponseField name="shipping_address" type="object">The order's shipping address.</ResponseField>
+    <ResponseField name="billing_address" type="object">The order's billing address.</ResponseField>
+    <ResponseField name="shipping_methods" type="object[]">The order's shipping methods.</ResponseField>
+    <ResponseField name="payment_collections" type="object[]">Payment collections with payments and refunds.</ResponseField>
+    <ResponseField name="fulfillments" type="object[]">The order's fulfillments.</ResponseField>
+    <ResponseField name="returns" type="object[]">The order's returns with items and reasons.</ResponseField>
+    <ResponseField name="summary" type="object">Order totals summary.</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>
+    <ResponseField name="canceled_at" type="string">Cancellation timestamp, if canceled.</ResponseField>
+  </Expandable>
+</ResponseField>
+
+<RequestExample>
+```bash cURL
+curl 'http://localhost:9000/vendor/orders/order_01HXYZABCDEF' \
+  -H 'Authorization: Bearer <token>' \
+  -H 'x-seller-id: <seller_id>'
+```
+
+```ts JS Client
+const { order } = await client.vendor.orders.$id.query({
+  $id: "order_01HXYZABCDEF",
+})
+```
+</RequestExample>
+
+<ResponseExample>
+```json 200
+{
+  "order": {
+    "id": "order_01HXYZABCDEF",
+    "display_id": 42,
+    "status": "pending",
+    "email": "jane@example.com",
+    "currency_code": "usd",
+    "items": [
+      {
+        "id": "ordli_01HXYZABCDEF",
+        "title": "T-Shirt / M",
+        "quantity": 1,
+        "unit_price": 2500
+      }
+    ],
+    "summary": {
+      "current_order_total": 2500,
+      "paid_total": 2500
+    },
+    "created_at": "2026-06-01T10:00:00.000Z",
+    "updated_at": "2026-06-01T10:00:00.000Z"
+  }
+}
+```
+</ResponseExample>

package/content/references/api/vendor/payout-accounts/create-onboarding.mdx

@@ -0,0 +1,68 @@
+---
+title: "Create Onboarding"
+api: "POST /vendor/payout-accounts/{id}/onboarding"
+description: "Start or refresh provider onboarding for a payout account."
+---
+
+Creates an onboarding session with the payout provider — for Stripe Connect, the returned `data` contains the hosted onboarding link.
+
+## Path parameters
+
+<ParamField path="id" type="string" required>
+  The payout account's ID.
+</ParamField>
+
+## Body parameters
+
+<ParamField body="data" type="object">
+  Provider-specific data forwarded when creating the onboarding.
+</ParamField>
+
+<ParamField body="context" type="object">
+  Provider-specific context (e.g. `refresh_url` and `return_url` for Stripe Connect).
+</ParamField>
+
+## Response
+
+<ResponseField name="onboarding" type="object">
+  <Expandable title="properties">
+    <ResponseField name="id" type="string">The onboarding's ID.</ResponseField>
+    <ResponseField name="data" type="object">Provider-specific onboarding data, such as the hosted onboarding URL.</ResponseField>
+    <ResponseField name="context" type="object">The context used to create the onboarding.</ResponseField>
+    <ResponseField name="created_at" type="string">Creation timestamp.</ResponseField>
+    <ResponseField name="updated_at" type="string">Update timestamp.</ResponseField>
+  </Expandable>
+</ResponseField>
+
+<RequestExample>
+```bash cURL
+curl -X POST 'http://localhost:9000/vendor/payout-accounts/pacc_01HXYZ/onboarding' \
+  -H 'Authorization: Bearer <token>' \
+  -H 'x-seller-id: <seller_id>' \
+  -H 'Content-Type: application/json' \
+  -d '{"context": {"refresh_url": "https://vendor.example.com/payouts", "return_url": "https://vendor.example.com/payouts"}}'
+```
+
+```ts JS Client
+const { onboarding } = await client.vendor.payoutAccounts.$id.onboarding.mutate({
+  $id: "pacc_01HXYZ",
+  context: {
+    refresh_url: "https://vendor.example.com/payouts",
+    return_url: "https://vendor.example.com/payouts",
+  },
+})
+```
+</RequestExample>
+
+<ResponseExample>
+```json 201
+{
+  "onboarding": {
+    "id": "onb_01HXYZ",
+    "data": { "url": "https://connect.stripe.com/setup/s/..." },
+    "context": { "return_url": "https://vendor.example.com/payouts" },
+    "created_at": "2026-01-15T10:00:00.000Z"
+  }
+}
+```
+</ResponseExample>

package/content/references/api/vendor/payout-accounts/create-payout-account.mdx

@@ -0,0 +1,59 @@
+---
+title: "Create Payout Account"
+api: "POST /vendor/payout-accounts"
+description: "Create the seller's payout account with the configured provider."
+---
+
+Creates a payout account for the current seller through the configured payout provider (e.g. Stripe Connect).
+
+## Body parameters
+
+<ParamField body="data" type="object">
+  Provider-specific data forwarded when creating the account.
+</ParamField>
+
+<ParamField body="context" type="object">
+  Provider-specific context (e.g. `{ "country": "US" }` for Stripe Connect).
+</ParamField>
+
+## Response
+
+<ResponseField name="payout_account" type="object">
+  <Expandable title="properties">
+    <ResponseField name="id" type="string">The payout account's ID.</ResponseField>
+    <ResponseField name="status" type="enum">One of `pending`, `active`, `restricted`, `rejected`.</ResponseField>
+    <ResponseField name="data" type="object">Provider-specific account data.</ResponseField>
+    <ResponseField name="context" type="object">The context used to create the account.</ResponseField>
+    <ResponseField name="onboarding" type="object">The onboarding record, once created.</ResponseField>
+    <ResponseField name="created_at" type="string">Creation timestamp.</ResponseField>
+  </Expandable>
+</ResponseField>
+
+<RequestExample>
+```bash cURL
+curl -X POST 'http://localhost:9000/vendor/payout-accounts' \
+  -H 'Authorization: Bearer <token>' \
+  -H 'x-seller-id: <seller_id>' \
+  -H 'Content-Type: application/json' \
+  -d '{"context": {"country": "US"}}'
+```
+
+```ts JS Client
+const { payout_account } = await client.vendor.payoutAccounts.mutate({
+  context: { country: "US" },
+})
+```
+</RequestExample>
+
+<ResponseExample>
+```json 201
+{
+  "payout_account": {
+    "id": "pacc_01HXYZ",
+    "status": "pending",
+    "context": { "country": "US" },
+    "created_at": "2026-01-15T10:00:00.000Z"
+  }
+}
+```
+</ResponseExample>

package/content/references/api/vendor/payout-accounts/retrieve-payout-account-by-id.mdx

@@ -0,0 +1,60 @@
+---
+title: "Retrieve Payout Account"
+api: "GET /vendor/payout-accounts/{id}"
+description: "Retrieve one of the seller's payout accounts by ID."
+---
+
+Returns a payout account, verifying it belongs to the current seller.
+
+## Path parameters
+
+<ParamField path="id" type="string" required>
+  The payout account's ID.
+</ParamField>
+
+## Query parameters
+
+<ParamField query="fields" type="string">
+  Comma-separated fields to include in the response.
+</ParamField>
+
+## Response
+
+<ResponseField name="payout_account" type="object">
+  <Expandable title="properties">
+    <ResponseField name="id" type="string">The payout account's ID.</ResponseField>
+    <ResponseField name="status" type="enum">One of `pending`, `active`, `restricted`, `rejected`.</ResponseField>
+    <ResponseField name="data" type="object">Provider-specific account data.</ResponseField>
+    <ResponseField name="context" type="object">Context passed when the account was created.</ResponseField>
+    <ResponseField name="onboarding" type="object">The account's onboarding record (`id`, `data`, `context`).</ResponseField>
+    <ResponseField name="created_at" type="string">Creation timestamp.</ResponseField>
+    <ResponseField name="updated_at" type="string">Update timestamp.</ResponseField>
+  </Expandable>
+</ResponseField>
+
+<RequestExample>
+```bash cURL
+curl 'http://localhost:9000/vendor/payout-accounts/pacc_01HXYZ' \
+  -H 'Authorization: Bearer <token>' \
+  -H 'x-seller-id: <seller_id>'
+```
+
+```ts JS Client
+const { payout_account } = await client.vendor.payoutAccounts.$id.query({
+  $id: "pacc_01HXYZ",
+})
+```
+</RequestExample>
+
+<ResponseExample>
+```json 200
+{
+  "payout_account": {
+    "id": "pacc_01HXYZ",
+    "status": "active",
+    "onboarding": { "id": "onb_01HXYZ" },
+    "created_at": "2026-01-15T10:00:00.000Z"
+  }
+}
+```
+</ResponseExample>

package/content/references/api/vendor/payout-accounts/retrieve-payout-account.mdx

@@ -0,0 +1,77 @@
+---
+title: "List Payout Accounts"
+api: "GET /vendor/payout-accounts"
+description: "List the seller's payout accounts."
+---
+
+Returns the payout accounts linked to the current seller, each with its onboarding.
+
+<Note>
+  A seller typically has at most one payout account, so the first entry is usually the one you need.
+</Note>
+
+## Query parameters
+
+<ParamField query="limit" type="number" default="20">
+  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="payout_accounts" type="object[]">
+  <Expandable title="properties">
+    <ResponseField name="id" type="string">The payout account's ID.</ResponseField>
+    <ResponseField name="status" type="enum">One of `pending`, `active`, `restricted`, `rejected`.</ResponseField>
+    <ResponseField name="data" type="object">Provider-specific account data.</ResponseField>
+    <ResponseField name="context" type="object">Context passed when the account was created.</ResponseField>
+    <ResponseField name="onboarding" type="object">The account's onboarding record (`id`, `data`, `context`).</ResponseField>
+    <ResponseField name="created_at" type="string">Creation timestamp.</ResponseField>
+    <ResponseField name="updated_at" type="string">Update timestamp.</ResponseField>
+  </Expandable>
+</ResponseField>
+
+<ResponseField name="count" type="number">Total number of payout accounts.</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/payout-accounts' \
+  -H 'Authorization: Bearer <token>' \
+  -H 'x-seller-id: <seller_id>'
+```
+
+```ts JS Client
+const { payout_accounts } = await client.vendor.payoutAccounts.query()
+```
+</RequestExample>
+
+<ResponseExample>
+```json 200
+{
+  "payout_accounts": [
+    {
+      "id": "pacc_01HXYZ",
+      "status": "active",
+      "onboarding": { "id": "onb_01HXYZ", "data": { "url": "https://connect.stripe.com/setup/..." } },
+      "created_at": "2026-01-15T10:00:00.000Z"
+    }
+  ],
+  "count": 1,
+  "offset": 0,
+  "limit": 20
+}
+```
+</ResponseExample>

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

@@ -0,0 +1,90 @@
+---
+title: "List Payouts"
+api: "GET /vendor/payouts"
+description: "List the seller's payouts."
+---
+
+Returns the payouts belonging to the current seller.
+
+## Query parameters
+
+<ParamField query="limit" type="number" default="20">
+  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>
+
+<ParamField query="status" type="string | string[]">
+  Filter by payout status: `pending`, `processing`, `paid`, `failed`, `canceled`.
+</ParamField>
+
+<ParamField query="created_at" type="object">
+  Filter by creation date using operators like `$gte`, `$lte`, `$gt`, `$lt`.
+</ParamField>
+
+<ParamField query="updated_at" type="object">
+  Filter by update date using operators like `$gte`, `$lte`, `$gt`, `$lt`.
+</ParamField>
+
+## Response
+
+<ResponseField name="payouts" type="object[]">
+  <Expandable title="properties">
+    <ResponseField name="id" type="string">The payout's ID.</ResponseField>
+    <ResponseField name="display_id" type="number">Human-readable payout number.</ResponseField>
+    <ResponseField name="amount" type="number">The payout amount.</ResponseField>
+    <ResponseField name="currency_code" type="string">The payout currency.</ResponseField>
+    <ResponseField name="status" type="enum">One of `pending`, `processing`, `paid`, `failed`, `canceled`.</ResponseField>
+    <ResponseField name="data" type="object">Provider-specific data.</ResponseField>
+    <ResponseField name="created_at" type="string">Creation timestamp.</ResponseField>
+    <ResponseField name="updated_at" type="string">Update timestamp.</ResponseField>
+  </Expandable>
+</ResponseField>
+
+<ResponseField name="count" type="number">Total number of payouts.</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/payouts?status=paid' \
+  -H 'Authorization: Bearer <token>' \
+  -H 'x-seller-id: <seller_id>'
+```
+
+```ts JS Client
+const { payouts, count } = await client.vendor.payouts.query({
+  status: "paid",
+})
+```
+</RequestExample>
+
+<ResponseExample>
+```json 200
+{
+  "payouts": [
+    {
+      "id": "pout_01HXYZ",
+      "display_id": 42,
+      "amount": 1250,
+      "currency_code": "usd",
+      "status": "paid",
+      "created_at": "2026-01-15T10:00:00.000Z"
+    }
+  ],
+  "count": 1,
+  "offset": 0,
+  "limit": 20
+}
+```
+</ResponseExample>