> ## Documentation Index
> Fetch the complete documentation index at: https://www.commercengine.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve seller payout stats

> Retrieves seller payout amounts and invoice volumes bucketed by payout state. Returns a `SellerPayoutStats` object per interval in `stats`, plus a `lifetime_stats` roll-up across all time.



## OpenAPI

````yaml https://openapi.commercengine.io/ce-admin.json get /orders/payouts/metrics/stats
openapi: 3.1.0
info:
  title: CE Admin APIs
  version: '1.0'
  summary: Comprehensive admin interface for managing your e-commerce platform
  description: >-
    Complete administrative API suite for Commerce Engine, providing powerful
    tools to manage products, orders, customers, inventory, analytics, and
    system configuration. Designed for administrators and backend integrations
    requiring full platform control.
  license:
    name: All Rights Reserved
    url: https://www.commercengine.io/contact-us
  contact:
    email: support@commercengine.io
    url: https://www.commercengine.io/contact-us
    name: Support
servers:
  - url: https://staging.api.commercengine.io/api/v1/{store_id}/admin
    description: Staging Server
    variables:
      store_id:
        default: store_id
        description: Store ID
  - url: https://prod.api.commercengine.io/api/v1/{store_id}/admin
    description: Prod Server
    variables:
      store_id:
        default: store_id
        description: Store ID
security:
  - Authorization: []
tags:
  - name: Analytics
    description: Analytics
  - name: Catalog
    description: Catalog
  - name: Coupons & promotions
    description: Coupons & promotions
  - name: Customers
    description: Customers
  - name: Filter Options
    description: Filter Options
  - name: Inventories
    description: Inventories
  - name: Marketplace
    description: Marketplace
  - name: Marketplace Catalog
    description: Marketplace Catalog
  - name: Media Gallery
    description: Media Gallery
  - name: Metrics
    description: Metrics
  - name: Orders
    description: Orders
  - name: Payments
    description: Payments
  - name: Payouts
    description: Payouts
  - name: POS
    description: POS
  - name: POSAdmin
    description: Admin endpoints to be used as proxy in pos
  - name: Segments
    description: Segments
  - name: Shipping
    description: Shipping
  - name: SSE
    description: SSE
  - name: Store
    description: Store
  - name: Webhooks
    description: Webhooks
paths:
  /orders/payouts/metrics/stats:
    parameters: []
    get:
      tags:
        - Metrics
      summary: Retrieve seller payout stats
      description: >-
        Retrieves seller payout amounts and invoice volumes bucketed by payout
        state. Returns a `SellerPayoutStats` object per interval in `stats`,
        plus a `lifetime_stats` roll-up across all time.
      operationId: get-seller-payout-metrics
      parameters:
        - name: date_from
          in: query
          description: start datetime
          required: true
          schema:
            type: string
            format: date-time
        - name: date_to
          in: query
          description: end datetime
          required: true
          schema:
            type: string
            format: date-time
        - name: interval
          in: query
          description: for aggregating data
          required: true
          schema:
            type: string
            enum:
              - hour
              - day
              - week
              - month
        - name: seller_id
          in: query
          description: To retrieve payout stats of a particular seller.
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  success:
                    type: boolean
                  content:
                    properties:
                      stats:
                        type: array
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              format: date-time
                            metrics:
                              $ref: '#/components/schemas/SellerPayoutStats'
                              type: object
                      lifetime_stats:
                        $ref: '#/components/schemas/SellerPayoutStats'
                    type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    SellerPayoutStats:
      title: SellerPayoutStats
      description: Seller payout amounts and invoice volumes aggregated by payout state.
      type: object
      properties:
        deductions:
          description: >-
            Marketplace charges, their tax, and debit adjustments withheld from
            the payable amount.
          type: number
        on_hold_amount:
          description: Payable amount on invoices held back from batching.
          type: number
        outstanding_amount:
          description: Payout-eligible amount not yet assigned to a batch.
          type: number
        scheduled_amount:
          description: Amount in batches scheduled for transfer but not yet paid out.
          type: number
        total_count:
          description: Number of payout invoices counted in the period.
          type: integer
        total_orders:
          description: Number of distinct orders behind those payout invoices.
          type: integer
        total_payout:
          description: Total payout amount recorded for the period.
          type: number
        transferred_amount:
          description: Amount already transferred to sellers.
          type: number
      x-tags:
        - Metrics
  responses:
    Unauthorized:
      description: Not authorized for given operation on the Resource
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Not authorized for given operation on the Resource.
              success:
                type: boolean
                default: false
              code:
                type: string
                example: unauthorized
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer

````