Obter todos os estoques

GET https://.account-name.krzlabs.io/api/v1/stocks

Realiza a leitura de estoques.

---

Request

paginação / link de referência

Entenda como aplicar paginação e ordenação na sua listagem

filtros / link de referência

Entenda como aplicar filtros na sua listagem

expansão / link de referência

Entenda como expandir entidades relacionadas nos documentos da listagem

---

Response

Resposta de sucesso

200

Successfully retrieved API registry entry.

Field	Type	Description	Optional	Searchable
code	string	Código identificador único do inventário.	required	true
name	string	Nome do inventário.	required	true
items +	array(Object)	Lista de itens do inventário.	required	false
enabled	boolean	Indica se o inventário está ativo.	not required	false
tags	array(string)	Lista de tags associadas ao inventário.	not required	false

Exemplo de resposta em JSON

{
   "page": 1,
    "skip": 0,
    "limit": 10,
    "sort": {
        "campo": "asc"
    },
    "pages": 5,
    "total": 50,
    "next": true,
    "previous": "2",
    "nextUrl": "https://api.exemplo.com?page=2",
    "previousUrl": false,
    "filters": {
        "status": "ativo"
    },
    "data": [{
        "code": "STOCK001",
        "name": "Estoque Central",
        "items": [
            {
              "sku": "SKU123",
              "balance": 100.0,
              "available": 80.0,
              "reserved": 20.0
            },
            {
              "sku": "SKU456",
              "balance": 50.0,
              "available": 30.0,
              "reserved": 20.0
            }
          ],
          "enabled": true,
          "tags": ["central", "varejo", "ativo"]
    }]
}

Resposta de erro

400

Bad Request

Field	Type	Description
code	Number	Código da resposta http
kind	String	Tipo de mensagem
name	String	Nome da exceção lançada pela plataforma
title	String	Titulo do erro lançado pela plataforma
message	String	Mensagem indicando o probloma ocorrido
solution	String	Mensagem indicando uma possível solução para o problema