Skip to main content
POST
/
v1
/
scanner
/
sweeps
/
{id}
Perform sweep action
curl --request POST \
  --url http://localhost:3000/v1/scanner/sweeps/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "start"
}
'
{
  "success": true,
  "sweep": null,
  "error": "<string>",
  "message": "<string>"
}

Path Parameters

​
id
string<uuid>
required

Sweep ID

Body

application/json
​
action
enum<string>
required

Action to perform on sweep

Available options:
claim,
start,
checkout,
complete,
deliver,
decant
Example:

"start"

Response

Action performed successfully

​
success
boolean
required
​
sweep
unknown
​
error
string
​
message
string