---
title: "GET /inventory"
method: GET
path: "/inventory"
tags: ["inventory"]
---

# GET /inventory

`GET /inventory`

## Request

- Base URL: `https://www.weclapp.com/api/nullapi/v2`
- URL: `https://www.weclapp.com/api/nullapi/v2/inventory`
- Auth: API key in header `AuthenticationToken`
- TypeScript: <https://skmtc.dev/weclapp/apis/weclapp-api/docs/inventory/get.ts> (a function with typed inputs; its response is checked against the schema)

query inventory

## Query parameters

- `page` integer
- `pageSize` integer
- `sort` string

## Response `200`

inventory response

- object
  - `result` Inventory[]
    - `id` string
    - `version` string
    - `counter` string
    - `createdDate` integer
    - `description` string
    - `endDate` integer
    - `inventoryGroupId` string, required
    - `inventoryNumber` string
    - `lastModifiedDate` integer
    - `levelOfDetail` 'ARTICLE' | 'SERIAL_NUMBER' | 'STORAGE_PLACE' | 'WAREHOUSE'
    - `managerId` string
    - `recorder` string
    - `startDate` integer
    - `status` 'BOOKED' | 'CANCELLED' | 'CLOSED' | 'COMPLETE' | 'DIFFERENCE_CHECKED' | 'DOCUMENTS_PRINTED' | 'NEW' | 'PLANNED' | 'STARTED', required
    - `statusHistory` InventoryStatusHistory[]
      - `status` 'BOOKED' | 'CANCELLED' | 'CLOSED' | 'COMPLETE' | 'DIFFERENCE_CHECKED' | 'DOCUMENTS_PRINTED' | 'NEW' | 'PLANNED' | 'STARTED'
      - `statusDate` integer
      - `userId` string
    - `warehouseId` string, required

## Other responses

- `default`: error response

## Changes

- **2026-11-07** `0e021229755d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/weclapp/apis/weclapp-api/changes/inventory/get.md)

---

[API](https://skmtc.dev/weclapp/apis/weclapp-api.md) - [All operations](https://skmtc.dev/weclapp/apis/weclapp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/weclapp/apis/weclapp-api/revisions/0e021229755d?raw)