Skip to main content
GET
/
v1
/
sweeps
/
economics
Get sweep economics
curl --request GET \
  --url http://localhost:3000/v1/sweeps/economics
import requests

url = "http://localhost:3000/v1/sweeps/economics"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('http://localhost:3000/v1/sweeps/economics', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v1/sweeps/economics",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "http://localhost:3000/v1/sweeps/economics"

req, _ := http.NewRequest("GET", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("http://localhost:3000/v1/sweeps/economics")
.asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3000/v1/sweeps/economics")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "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