> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shipstream.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Replenishment Task Health

> Returns current task-ledger health for one scoped Warehouse: actual completed restocks during
the trailing seven days by Lane, active/deferred/integrity-blocked age, emergency work, source shortages,
destination-capacity denials, and currently cap-limited needs. Ages are seconds and quantities
use replenished Product units.



## OpenAPI

````yaml GET /v1/inventory/warehouses/{id}/replenishment-tasks/health
openapi: 3.0.3
info:
  title: ShipStream
  version: '1.0'
  license:
    name: Commercial (Copyright 2025 - All Rights Reserved)
    url: https://shipstream.io
  contact:
    name: ShipStream Support
    email: help@shipstream.io
  termsOfService: https://shipstream.io/legal/api-terms/
servers:
  - url: https://{base_url_domain}/api/global
    description: Direct API Url
    variables:
      base_url_domain:
        default: example.shipstream.app
        description: >-
          The fully qualified domain name for your ShipStream WMS instance. This
          is either a custom domain, or a subdomain of shipstream.app,

          and will be the same as the domain name for the page which you use to
          login to ShipStream WMS.
security:
  - ShipStream_bearerAuth: []
tags:
  - name: Warehouses
    x-displayName: Warehouses
  - name: Products
    x-displayName: Products
  - name: ProductProfiles
    x-displayName: ProductProfiles
  - name: HandlingClasses
    x-displayName: HandlingClasses
  - name: Locations
    x-displayName: Locations
  - name: LocationOccupancies
    x-displayName: LocationOccupancies
  - name: LocationTags
    x-displayName: LocationTags
  - name: SlotTypes
    x-displayName: SlotTypes
  - name: Levels
    x-displayName: Levels
  - name: HoldReasons
    x-displayName: HoldReasons
  - name: Holds
    x-displayName: Holds
  - name: Replenishment
    x-displayName: Replenishment
  - name: LocationProfiles
    x-displayName: LocationProfiles
  - name: SlottingRules
    x-displayName: SlottingRules
  - name: PickingBatches
    x-displayName: PickingBatches
  - name: Deliveries
    description: Every thing about a Delivery Receiving
    x-displayName: Deliveries
  - name: Shipments
    x-displayName: Shipments
  - name: Orders
    x-displayName: Orders
  - name: Retailers
    x-displayName: Retailers
  - name: Users
    x-displayName: Users
  - name: User Roles
    x-displayName: User Roles
  - name: Merchants
    x-displayName: Merchants
  - name: Healthcheck
    x-displayName: Healthcheck
paths:
  /v1/inventory/warehouses/{id}/replenishment-tasks/health:
    get:
      tags:
        - Replenishment
      summary: Get Replenishment Task Health
      description: >-
        Returns current task-ledger health for one scoped Warehouse: actual
        completed restocks during

        the trailing seven days by Lane, active/deferred/integrity-blocked age,
        emergency work, source shortages,

        destination-capacity denials, and currently cap-limited needs. Ages are
        seconds and quantities

        use replenished Product units.
      operationId: getReplenishmentTaskHealth
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            format: int32
          description: Warehouse identity.
      responses:
        '200':
          description: Current scoped Replenishment task health.
          content:
            application/json:
              schema:
                type: object
                properties:
                  open_task_count:
                    type: integer
                    minimum: 0
                    description: Active non-terminal task count.
                  overdue_exception_task_count:
                    type: integer
                    minimum: 0
                    description: >-
                      Exception roots at least four hours old, independent of
                      heartbeat.
                  oldest_open_age_seconds:
                    type: integer
                    minimum: 0
                    nullable: true
                    description: Age of the oldest non-terminal task, or `null`.
                  deferred_task_count:
                    type: integer
                    minimum: 0
                    description: Current deferred task count.
                  oldest_deferred_age_seconds:
                    type: integer
                    minimum: 0
                    nullable: true
                    description: >-
                      Age of the current deferral of the oldest deferred task,
                      or `null`.
                  blocked_task_count:
                    type: integer
                    minimum: 0
                    description: Non-terminal tasks blocked by an integrity finding.
                  oldest_blocked_age_seconds:
                    type: integer
                    minimum: 0
                    nullable: true
                    description: >-
                      Age since the oldest blocked task's latest integrity
                      block, or `null`.
                  emergency_task_count:
                    type: integer
                    minimum: 0
                    description: Current non-terminal emergency task count.
                  source_shortage_count:
                    type: integer
                    minimum: 0
                    description: Tasks with recorded source-short quantity.
                  capacity_denial_count:
                    type: integer
                    minimum: 0
                    description: Deferred tasks with destination-capacity denial evidence.
                  cap_limited_need_count:
                    type: integer
                    minimum: 0
                    description: >-
                      Current eligible needs without an active root while the
                      Warehouse or Lane cap is full or unset; counted only when
                      automatic dispatch is enabled.
                  restocks_last_7_days_by_lane:
                    type: array
                    description: >-
                      Completed placed tasks during the trailing seven days
                      grouped by Lane.
                    items:
                      type: object
                      properties:
                        lane_id:
                          type: integer
                          minimum: 1
                          description: Lane identity.
                        lane_code:
                          type: string
                          description: Current Lane code.
                        lane_name:
                          type: string
                          description: Current Lane name.
                        task_count:
                          type: integer
                          minimum: 0
                          description: Completed task count.
                        qty_placed:
                          type: number
                          minimum: 0
                          description: Total quantity placed.
                      required:
                        - lane_id
                        - lane_code
                        - lane_name
                        - task_count
                        - qty_placed
                      additionalProperties: false
                  meta:
                    $ref: '#/components/schemas/Inventory_API_v1_meta'
                required:
                  - overdue_exception_task_count
                  - open_task_count
                  - deferred_task_count
                  - blocked_task_count
                  - emergency_task_count
                  - source_shortage_count
                  - capacity_denial_count
                  - cap_limited_need_count
                  - restocks_last_7_days_by_lane
                  - meta
                additionalProperties: false
        '400':
          $ref: '#/components/responses/Inventory_API_v1_400-bad-request'
        '404':
          $ref: '#/components/responses/Inventory_API_v1_404-not-found'
        '500':
          $ref: '#/components/responses/Inventory_API_v1_500-internal-server-error'
components:
  schemas:
    Inventory_API_v1_meta:
      type: object
      properties:
        processing_time:
          type: number
          description: Total time in which request is processed and response is sent back.
          example: 0.2525252525
        cursor_start:
          description: >-
            A `cursor_start` value which resumes the results on the next page:
            the starting `id`

            for collections sorted by `id`, otherwise an opaque cursor bound to
            the requested sort.

            See [paging parameters](/global-api/paging-parameters) for more
            information on paging.
          oneOf:
            - type: integer
              nullable: true
            - type: string
        cursor_end:
          description: >-
            A `cursor_end` value which resumes the results on the previous page,
            non-inclusive: the

            last `id` for collections sorted by `id`, otherwise an opaque cursor
            bound to the requested sort.

            See [paging parameters](/global-api/paging-parameters) for more
            information on paging.
          oneOf:
            - type: integer
              nullable: true
            - type: string
        count:
          type: integer
          description: >-
            The total number of items matching the query before applying paging
            parameters.

            This field is only present if the query parameter `count=1` is
            present in the request.
      description: Additional metadata pertaining to the response.
  responses:
    Inventory_API_v1_400-bad-request:
      description: >-
        The request was invalid. The client must change the request. See the
        response body for more details.
      content:
        application/json:
          schema:
            type: object
            properties:
              errors:
                type: array
                items:
                  type: object
                  properties:
                    type:
                      type: string
                      description: The error type code.
                      enum:
                        - parser
                        - parameters
                        - openapi
                    message:
                      type: string
                      description: An English sentence describing the error type.
                    details:
                      type: array
                      description: >-
                        An array of objects describing which keys are
                        responsible for the error and detailed messages
                        describing why they are not valid.
                      items:
                        type: object
                        properties:
                          key:
                            type: string
                            description: The path to the key which relates to the error.
                          message:
                            type: string
                            description: >-
                              An English sentence describing the details of the
                              error.
                        additionalProperties: false
                  additionalProperties: false
                minItems: 1
            additionalProperties: false
          example:
            errors:
              - type: parameters
                message: The supplied parameters are invalid.
    Inventory_API_v1_404-not-found:
      description: >-
        The requested resource was not found. It may have been deleted, it may
        have never existed, or you may not have permission to view it.
      content:
        application/json:
          schema:
            type: object
            properties:
              errors:
                type: array
                items:
                  type: object
                  properties:
                    type:
                      type: string
                      description: The error type code.
                      enum:
                        - not_found
                    message:
                      type: string
                      description: An English sentence describing the error type.
                    details:
                      type: array
                      description: >-
                        An array of objects describing which keys are
                        responsible for the error and detailed messages
                        describing why they are not valid.
                      items:
                        type: object
                        properties:
                          key:
                            type: string
                            description: The path to the key which relates to the error.
                          message:
                            type: string
                            description: >-
                              An English sentence describing the details of the
                              error.
                        additionalProperties: false
                  additionalProperties: false
                minItems: 1
            additionalProperties: false
          example:
            errors:
              - type: not_found
                message: The server could not find the requested resource.
    Inventory_API_v1_500-internal-server-error:
      description: >-
        Internal Server Error - Something wrong happened at server side. Contact
        server administrator for more details.
  securitySchemes:
    ShipStream_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.