Skip to main content
POST
/
v1
/
sweeps
/
{id}
/
action
Perform sweep action
curl --request POST \
  --url http://localhost:3000/v1/sweeps/{id}/action \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "claim"
}
'
{
  "success": true,
  "sweep": {
    "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>",
    "taxonomy_id": "<string>",
    "sweep_type": "<string>"
  }
}

Path Parameters

id
string
required

Sweep UUID or taxonomy ID

Body

application/json
action
enum<string>
required
Available options:
claim,
start,
checkout,
complete,
deliver,
decant

Response

Action performed successfully

success
boolean
required
sweep
object
required