List Inventory

GET

/api/inventories

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/inventories?filter&page&sort&per_page'

Response Example

{
    "data": [
        {
            "key": "09000048633753",
            "code": "59838746",
            "name": "string",
            "quantity": 10,
            "unitCost": 10,
            "locationKey": "08000356728503",
            "updatedAt": "1983-09-06T21:55:53Z",
            "createdAt": "2020-05-13T10:49:43Z"
        }
    ],
    "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

Delete an Integration Integration

Get an Inventory