Skip to main content
GET
/
v1
/
sweeps
/
economics
Get sweep economics
curl --request GET \
  --url http://localhost:3000/v1/sweeps/economics
{
  "economics": [
    {
      "sweep_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "total_items": 123,
      "estimated_subtotal": 123,
      "estimated_gross_margin": 123,
      "estimated_labor_cost": 123,
      "estimated_profit": 123,
      "estimated_margin_percent": 123,
      "estimated_time_minutes": 123,
      "is_profitable": true,
      "items_to_breakeven": 123,
      "sweep_number": "<string>",
      "status": "<string>",
      "sweep_date": "<string>",
      "scheduled_start_time": "<string>"
    }
  ],
  "settings": {
    "labor_rate_hourly": 123,
    "in_store_time_per_item_minutes": 123,
    "curbside_time_per_item_minutes": 123,
    "in_store_checkout_minutes": 123,
    "curbside_checkout_minutes": 123,
    "nominal_drive_time_minutes": 123,
    "in_store_breakeven_items": 123,
    "curbside_breakeven_items": 123,
    "in_store_max_items": 123,
    "curbside_max_items": 123,
    "new_sweep_marginal_cost": 123
  }
}

Query Parameters

status
enum<string>
default:all
Available options:
scheduled,
ready,
in_progress,
checkout,
all

Response

200 - application/json

Economics data

economics
object[]
required
settings
object
required