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

# Get sales summary

> Returns sales summary grouped by period (month) plus lifetime totals.



## OpenAPI

````yaml api-reference/v1/openapi.yaml get /v1/partner/sales/summary
openapi: 3.1.0
info:
  title: Goods API
  version: 1.0.0
  description: >-
    API for Goods grocery operations - scanner app, admin dashboard, and
    customer features
  contact:
    name: Goods Team
    url: https://goods.app
servers:
  - url: http://localhost:3000
    description: Local development
  - url: https://dev.api.switchyard.run
    description: Development
  - url: https://api.switchyard.run
    description: Production
security: []
tags:
  - name: v1
    description: API v1 - unified domain-based endpoints
  - name: Scanner
    description: Scanner app endpoints for drivers and pickers
  - name: Sweeps
    description: Sweep management - retail store pickup operations
  - name: RFC Picks
    description: Ready-for-checkout picking operations
  - name: Inventory
    description: Inventory management and barcode lookup
  - name: Admin
    description: Admin dashboard endpoints
  - name: Orders
    description: Order management
  - name: Products
    description: Product catalog management
  - name: Notifications
    description: Push, email, SMS, and Slack notification management
paths:
  /v1/partner/sales/summary:
    get:
      tags:
        - Partner Sales
      summary: Get sales summary
      description: Returns sales summary grouped by period (month) plus lifetime totals.
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 24
            default: 6
          required: false
          name: months
          in: query
      responses:
        '200':
          description: Sales summary
          content:
            application/json:
              schema:
                type: object
                properties:
                  periods:
                    type: array
                    items:
                      type: object
                      properties:
                        period:
                          type: string
                        orders_count:
                          type: number
                        total_units_sold:
                          type: number
                        gross_sales:
                          type: number
                        total_commission:
                          type: number
                        net_to_partner:
                          type: number
                        payout_status:
                          type: object
                          properties:
                            pending:
                              type: number
                            included:
                              type: number
                            paid:
                              type: number
                          required:
                            - pending
                            - included
                            - paid
                      required:
                        - period
                        - orders_count
                        - total_units_sold
                        - gross_sales
                        - total_commission
                        - net_to_partner
                        - payout_status
                  lifetime:
                    type: object
                    properties:
                      total_orders:
                        type: number
                      total_units_sold:
                        type: number
                      gross_sales:
                        type: number
                      total_commission:
                        type: number
                      net_to_partner:
                        type: number
                      pending_payout:
                        type: number
                    required:
                      - total_orders
                      - total_units_sold
                      - gross_sales
                      - total_commission
                      - net_to_partner
                      - pending_payout
                required:
                  - periods
                  - lifetime
        '404':
          description: Partner brand not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                  - error
        '500':
          description: Server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                  - error

````