Stocks

As an Admin, you can view stock levels via the API.

List Stocks

GET/stocks Bearer Token

Retrieve a paginated list of stock entries.

Parameter	Type	Required	Description
per_page	number	No	Results per page

Response

Success (200):

{
  "data": [
    {
      "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "product_name": "T-Shirt Red M",
      "product_sku": "TSHIRT-RED-M",
      "warehouse_name": "Main Warehouse",
      "quantity": 150,
      "warning_quantity": 10,
      "status": "active"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "limit": 50,
      "total": 45,
      "pages": 1
    }
  }
}

Show Stock

GET/stocks/{id}/show Bearer Token

Retrieve a single stock entry by ID.

Response

Success (200):

{
  "data": {
    "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "product_name": "T-Shirt Red M",
    "product_sku": "TSHIRT-RED-M",
    "warehouse_name": "Main Warehouse",
    "quantity": 150,
    "warning_quantity": 10,
    "status": "active",
    "created_at": "2025-01-10T08:00:00Z",
    "updated_at": "2025-01-15T12:00:00Z"
  },
  "meta": {}
}

Not found (404):

{
  "error": {
    "code": "HTTP_ERROR",
    "message": "Resource not found."
  }
}