Skip to main content
GET
/
v1
/
sweeps
List sweeps
curl --request GET \
  --url http://localhost:3000/v1/sweeps
{
  "sweeps": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "retailer_location_id": "<string>",
      "sweep_date": "<string>",
      "sweep_number": "<string>",
      "scheduled_start_time": "<string>",
      "scheduled_end_time": "<string>",
      "actual_start_time": "<string>",
      "actual_end_time": "<string>",
      "status": "scheduled",
      "driver_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "total_items": 123,
      "total_load": 123,
      "created_at": "<string>",
      "updated_at": "<string>",
      "retailer_location": {
        "id": "<string>",
        "taxonomy_id": "<string>",
        "name": "<string>",
        "retailer_id": "<string>",
        "retailer_name": "<string>",
        "store_number": "<string>",
        "location_route_order": [
          "<string>"
        ],
        "address": {
          "address_1": "<string>",
          "address_2": "<string>",
          "city": "<string>",
          "province": "<string>",
          "postal_code": "<string>",
          "country_code": "<string>",
          "phone": "<string>"
        }
      },
      "retailer": {
        "id": "<string>",
        "name": "<string>",
        "display_name": "<string>",
        "brand_logo_url": "<string>"
      },
      "taxonomy_id": "<string>",
      "sweep_type": "<string>",
      "picked_items": 123,
      "completed_items": 123
    }
  ],
  "total": 123
}

Query Parameters

limit
integer
default:20
Required range: 1 <= x <= 100
offset
integer | null
default:0
Required range: x >= 0
filter
enum<string>
default:my
Available options:
my,
available,
completed,
all,
ready_to_receive,
receiving_upcoming,
received

Response

200 - application/json

List of sweeps

sweeps
object[]
required
total
number