Skip to main content

Warehouse Dashboard

1 API call in this section.

Get Warehouse Staff Dashboard​

Warehousing / Warehouse Dashboard
GET/warehousing/dashboard

Summary

GET /warehousing/dashboard?warehouse_id={{warehouse_id}}

Live warehouse-staff dashboard. It does not use warehouse_report or a scheduled report.

Auth and access

  • The user must have a warehouse-related role.

  • The user must have an active warehouse_staff assignment for warehouse_id.

  • The warehouse must belong to the current tenant and be active.

Business rules

  • status totals current inventory_stock.quantity by stock status.

  • recent_activity is the latest 10 committed inventory events for this tenant and warehouse, newest first.

  • Each event has a stable dashboard type and display label; the source transaction_type is not exposed.

  • Current types are inventory_initial_stock, inventory_received, inventory_picked, inventory_moved, inventory_adjusted, inventory_returned, inventory_counted, inventory_transferred_in, inventory_transferred_out, and inventory_transaction for an unknown source value.

  • An empty activity array is a valid success response.

Frontend contract

  • Render Status from the *_units fields.

  • Render the timeline from type, label, item, quantity, actor, locations, reference, and timestamp.

  • Handle 403 as no active warehouse assignment and 409 as an inactive warehouse.

Query parameters

ParameterTypeDescription
warehouse_idRequiredstring

Required UUID of the active warehouse assigned to the authenticated staff member.

Example: {{warehouse_id}}

Headers

ParameterTypeDescription
Authorizationstring

Bearer {{access_token}}

Example: Bearer {{access_token}}

Staging
Request
curl
1curl --globoff --request GET "https://staging-api.ondi.io/functions/v1/warehousing/dashboard?warehouse_id=${WAREHOUSE_ID}" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}"

Response examples

200OK
Response body
json
1{2  "success": true,3  "message": "",4  "warehouse": {5    "id": "{{warehouse_id}}",6    "name": "Main Warehouse",7    "code": "WH-MAIN"8  },9  "status": {10    "available_units": 120,11    "reserved_units": 15,12    "damaged_units": 2,13    "expired_units": 1,14    "other_units": 0,15    "total_units": 13816  },17  "recent_activity": [18    {19      "id": "00000000-0000-4000-8000-000000000001",20      "type": "inventory_received",21      "label": "Received",22      "quantity": 12,23      "timestamp": "2026-07-13T10:00:00.000Z",24      "item": {25        "id": "00000000-0000-4000-8000-000000000002",26        "name": "Packing Box",27        "sku": "BOX-001"28      },29      "performed_by": {30        "id": "00000000-0000-4000-8000-000000000003",31        "name": "Warehouse Staff"32      },33      "from_location": null,34      "to_location": {35        "id": "00000000-0000-4000-8000-000000000004",36        "code": "A-01"37      },38      "reference": {39        "id": "00000000-0000-4000-8000-000000000005",40        "type": "receiving_order"41      }42    }43  ]44}