curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.stateset.com/api/v1/inventory/sweeps/run' \
--header 'Authorization: Bearer YOUR_API_KEY'
{
"sweeps": [
{
"job": "string",
"message": "Two-person tent, green — replacement for damaged pole set.",
"ok": true,
"reclaimed": {}
}
]
}
Run sweeps
Run both engine sweeps — stock holds (inventory reservations + backorder allocations) and traceability (lot expiry, lot and serial reservations) — once, right…
POST
/
api
/
v1
/
inventory
/
sweeps
/
run
curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.stateset.com/api/v1/inventory/sweeps/run' \
--header 'Authorization: Bearer YOUR_API_KEY'
{
"sweeps": [
{
"job": "string",
"message": "Two-person tent, green — replacement for damaged pole set.",
"ok": true,
"reclaimed": {}
}
]
}
Confirm your deployment before running this request. This page describes an API contract;
a published reference does not establish hosted availability. Check the dated
host report and obtain your deployment URL and credentials.
Replace the example host if your provisioned service uses a different URL.
Request body
No request body.Response
SweepRunReport
SweepJobReport[]
required
One entry per sweep, in the order they ran.
Status codes
| Code | Meaning |
|---|---|
200 | What each sweep reclaimed |
500 | The sweep runner could not start |
Using this contract
Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.stateset.com/api/v1/inventory/sweeps/run' \
--header 'Authorization: Bearer YOUR_API_KEY'
{
"sweeps": [
{
"job": "string",
"message": "Two-person tent, green — replacement for damaged pole set.",
"ok": true,
"reclaimed": {}
}
]
}
Last modified on October 20, 2026