Skip to main content

GET /api/v1/inventory/

Retrieve a specific inventory record by its unique identifier.

Path Parameters

id
integer
required
The unique identifier of the inventory record

Request

curl -X GET https://api.example.com/api/v1/inventory/1 \
  -H "Content-Type: application/json"

Response

id
integer
Unique identifier for the inventory record
productId
integer
ID of the associated product
quantityAvailable
integer
Current quantity of the product available in stock
minimumStockLevel
integer
Minimum stock level threshold for low stock alerts
lastRestockedDate
string
Timestamp of when the inventory was last restocked (ISO 8601 format)

Response Example

{
  "id": 1,
  "productId": 101,
  "quantityAvailable": 50,
  "minimumStockLevel": 10,
  "lastRestockedDate": "2026-03-01T10:30:00"
}

Status Codes

  • 200 - Success
  • 404 - Inventory record not found

Build docs developers (and LLMs) love