Skip to main content
GET
Get Replenishment Task Health

Authorizations

Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

id
integer<int32>
required

Warehouse identity.

Response

Current scoped Replenishment task health.

open_task_count
integer
required

Active non-terminal task count.

Required range: x >= 0
overdue_exception_task_count
integer
required

Exception roots at least four hours old, independent of heartbeat.

Required range: x >= 0
deferred_task_count
integer
required

Current deferred task count.

Required range: x >= 0
blocked_task_count
integer
required

Non-terminal tasks blocked by an integrity finding.

Required range: x >= 0
emergency_task_count
integer
required

Current non-terminal emergency task count.

Required range: x >= 0
source_shortage_count
integer
required

Tasks with recorded source-short quantity.

Required range: x >= 0
capacity_denial_count
integer
required

Deferred tasks with destination-capacity denial evidence.

Required range: x >= 0
cap_limited_need_count
integer
required

Current eligible needs without an active root while the Warehouse or Lane cap is full or unset; counted only when automatic dispatch is enabled.

Required range: x >= 0
restocks_last_7_days_by_lane
object[]
required

Completed placed tasks during the trailing seven days grouped by Lane.

meta
object
required

Additional metadata pertaining to the response.

oldest_open_age_seconds
integer | null

Age of the oldest non-terminal task, or null.

Required range: x >= 0
oldest_deferred_age_seconds
integer | null

Age of the current deferral of the oldest deferred task, or null.

Required range: x >= 0
oldest_blocked_age_seconds
integer | null

Age since the oldest blocked task's latest integrity block, or null.

Required range: x >= 0