> ## Documentation Index
> Fetch the complete documentation index at: https://docs.domsoftware.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar Estoque

> Mostra o panorama de todos os estoques fracionados por produto, com as contagens disponíveis, físicas e reservadas.

### Query Parameters

<ParamField query="page" type="number" default="1">Paginação</ParamField>
<ParamField query="limit" type="number" default="10">Itens por página</ParamField>
<ParamField query="warehouseId" type="string">Filtra pelo ID de um Centro de Distribuição.</ParamField>
<ParamField query="productId" type="string">Filtra por ID de produto.</ParamField>

### Response

<ResponseExample>
  ```json Response theme={null}
  {
    "data": [
      {
        "productId": "cffbca85-da89-4b2a-aecf-31422abcb34a",
        "availableQuantity": 150,
        "physicalQuantity": 160,
        "reservedQuantity": 10,
        "updatedAt": "2024-02-15T10:00:00.000Z"
      }
    ],
    "total": 1,
    "page": 1,
    "limit": 10
  }
  ```
</ResponseExample>


## OpenAPI

````yaml get /inventory
openapi: 3.0.0
info:
  title: Hub Marketplace API
  description: API for managing marketplace listings and keys
  version: '1.0'
  contact: {}
servers: []
security: []
tags:
  - name: listings
    description: ''
paths:
  /inventory:
    get:
      tags:
        - Inventory
      summary: Listar estoque com filtros e paginação
      operationId: InventoryController_listInventory
      parameters:
        - name: search
          required: false
          in: query
          description: Busca por nome ou SKU
          schema:
            type: string
        - name: stockStatus
          required: false
          in: query
          description: Filtrar por status de estoque
          schema:
            type: string
            enum:
              - ALL
              - IN_STOCK
              - LOW_STOCK
              - OUT_OF_STOCK
        - name: warehouseId
          required: false
          in: query
          description: Filtrar por depósito
          schema:
            type: string
        - name: category
          required: false
          in: query
          description: Filtrar por categoria
          schema:
            type: string
        - name: productType
          required: false
          in: query
          description: Filtrar por tipo de produto
          schema:
            type: string
            enum:
              - SIMPLE
              - KIT
              - MANUFACTURED
        - name: sortBy
          required: false
          in: query
          description: 'Ordenar por: name, stock, value, updated'
          schema:
            default: name
            type: string
        - name: sortOrder
          required: false
          in: query
          description: Direção da ordenação
          schema:
            default: ASC
            type: string
        - name: cursor
          required: false
          in: query
          description: Cursor de paginação (offset)
          schema:
            default: 0
            type: number
        - name: limit
          required: false
          in: query
          description: Limite de itens por página
          schema:
            default: 50
            type: number
      responses:
        '200':
          description: Listagem paginada de estoque
      security:
        - bearer: []
components: {}

````