List Stock

GET

/api/stocks

The quantity of materials per location and storeroom

Filtering

filter[name]=HelloFromMakiniAPI

filter[name:contains]=Makini

filter[name:startsWith]=Hello

filter[name:startsWith]=API

filter[createdAt:gt]=2023-11-07

filter[createdAt:gteq]=2023-11-07

filter[createdAt:lt]=2023-11-07

filter[createdAt:lted]=2023-11-07

Filter matching

filterMatch=any // OR

filterMatch=all // AND

Sorting

sort[createdAt]=1 // DESC

sort[createdAt]=0 // ASC

Request

Authorization

Query Params

Responses

🟢200

application/json

Successful operation

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/stocks?filter&page&sort&per_page'

Response Example

{
    "data": [
        {
            "key": "07000069347630",
            "productKey": "05000752255762",
            "materialKey": "03000047321741",
            "locationKey": "06000071233403",
            "storeroomKey": "07000453350727",
            "assetKey": "04000181080888",
            "position": "string",
            "uomKey": "09000236236376",
            "quantity": "string",
            "reorderPoint": "string",
            "expiresAt": "1972-03-16T18:01:28Z",
            "reorderQuantity": "string",
            "minLevel": "string",
            "maxLevel": "string",
            "reorderLevel": "string",
            "createdAt": "1978-07-10T16:11:13Z",
            "updatedAt": "2016-09-25T05:08:08Z",
            "deletedAt": "1993-10-28T16:29:58Z"
        }
    ],
    "links": {
        "first": "string",
        "last": "string",
        "prev": "string",
        "next": "string"
    },
    "meta": {
        "current_page": 0,
        "from": 0,
        "last_page": 0,
        "path": "string",
        "per_page": 0,
        "to": 0,
        "total": 0
    }
}

Modified at 2026-03-19 15:49:21

Update a StockTransfer

Create a Stock