Skip to main content
POST
/
v1
/
admin
/
sweeps
Create a sweep
curl --request POST \
  --url http://localhost:3000/v1/admin/sweeps \
  --header 'Content-Type: application/json' \
  --data '
{
  "retailer_location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sweep_date": "<string>",
  "scheduled_start_time": "<string>",
  "items": []
}
'
{
  "success": true,
  "sweep": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sweep_number": "<string>",
    "retailer_location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sweep_date": "<string>",
    "scheduled_start_time": "<string>",
    "status": "<string>",
    "total_items": 123
  }
}

Body

application/json
retailer_location_id
string<uuid>
required
sweep_date
string
required
scheduled_start_time
string
required
items
object[]

Response

201 - application/json

Created sweep

success
boolean
required
sweep
object
required