> ## 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 sweep economics

> Returns economics data for all active/upcoming sweeps.



## OpenAPI

````yaml api-reference/v1/openapi.yaml get /v1/sweeps/economics
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/sweeps/economics:
    get:
      tags:
        - Sweeps
      summary: Get sweep economics
      description: Returns economics data for all active/upcoming sweeps.
      parameters:
        - schema:
            type: string
            enum:
              - scheduled
              - ready
              - in_progress
              - checkout
              - all
            default: all
          required: false
          name: status
          in: query
      responses:
        '200':
          description: Economics data
          content:
            application/json:
              schema:
                type: object
                properties:
                  economics:
                    type: array
                    items:
                      type: object
                      properties:
                        sweep_id:
                          type: string
                          format: uuid
                        total_items:
                          type: number
                        estimated_subtotal:
                          type: number
                        estimated_gross_margin:
                          type: number
                        estimated_labor_cost:
                          type: number
                        estimated_profit:
                          type: number
                        estimated_margin_percent:
                          type: number
                        estimated_time_minutes:
                          type: number
                        is_profitable:
                          type: boolean
                        items_to_breakeven:
                          type: number
                        sweep_number:
                          type: string
                          nullable: true
                        status:
                          type: string
                        sweep_date:
                          type: string
                        scheduled_start_time:
                          type: string
                          nullable: true
                      required:
                        - sweep_id
                        - total_items
                        - estimated_subtotal
                        - estimated_gross_margin
                        - estimated_labor_cost
                        - estimated_profit
                        - estimated_margin_percent
                        - estimated_time_minutes
                        - is_profitable
                        - items_to_breakeven
                  settings:
                    type: object
                    properties:
                      labor_rate_hourly:
                        type: number
                      in_store_time_per_item_minutes:
                        type: number
                      curbside_time_per_item_minutes:
                        type: number
                      in_store_checkout_minutes:
                        type: number
                      curbside_checkout_minutes:
                        type: number
                      nominal_drive_time_minutes:
                        type: number
                      in_store_breakeven_items:
                        type: number
                      curbside_breakeven_items:
                        type: number
                      in_store_max_items:
                        type: number
                      curbside_max_items:
                        type: number
                      new_sweep_marginal_cost:
                        type: number
                    required:
                      - labor_rate_hourly
                      - in_store_time_per_item_minutes
                      - curbside_time_per_item_minutes
                      - in_store_checkout_minutes
                      - curbside_checkout_minutes
                      - nominal_drive_time_minutes
                      - in_store_breakeven_items
                      - curbside_breakeven_items
                      - in_store_max_items
                      - curbside_max_items
                      - new_sweep_marginal_cost
                required:
                  - economics
                  - settings

````