Listar itens

GET

Markdown (LLM)

Lista insumos, produtos e complementos, nesta ordem. Todos os filtros são combinados.

Escopo:stock:read

Limite:300 chamadas / 180s

Parâmetros de query

typestring

Tipo do item.

Enum

supplyInsumo
productProduto
complementComplemento

product

productIdinteger

Filtra por produto específico e exclui insumos.

30

complementIdinteger

Filtra por complemento específico e exclui insumos.

31

supplyIdinteger

Filtra por insumo específico e exclui produtos e complementos.

30

sectorIdinteger

Filtra por setor de produtos e complementos; exclui insumos.

8

namestring

Filtra pelo nome.

Açaí

stockControlboolean

Filtra a configuração de estoque.

true

stockAllowNegativeboolean

Filtra a configuração de estoque.

true

stockSituationstring

Situação do saldo com controle ligado.

Enum

regularSaldo maior que o mínimo, ou sem mínimo definido
lowSaldo menor ou igual ao mínimo
criticalSaldo menor ou igual a zero

low

stockQuantitynumber

Saldo para comparação; exige stockQuantityOperator.

2

stockQuantityOperatorstring

Operador da comparação; exige stockQuantity.

Enum

gtMaior que
gteMaior ou igual a
ltMenor que
lteMenor ou igual a

lte

pageinteger

Página (padrão 1).

1

limitinteger

Itens por página, de 1 a 100 (padrão 20).

20

sortstring

Ordenação por ID do item (padrão desc).

Enum

ascCrescente
descDecrescente (padrão)

desc

Parâmetros da resposta

pagenumber

page da paginação.

1

limitnumber

limit da paginação.

20

totalnumber

total da paginação.

3

pagesnumber

pages da paginação.

1

Linguagem

Produção

Requisição

GET /v1/stock/items

12345678import axios from "axios";
const { data } = await axios({
  method: "get",
  url: "https://api.beefood.app/v1/stock/items?type=product&page=1&limit=20&sort=desc",
  headers: {
    Authorization: `Bearer ${accessToken}`,
  },
});

Resposta

json

1234567891011121314151617181920212223242526272829303132333435363738394041{
  "items": [
    {
      "supplyId": 30,
      "name": "Açaí (porção 500gr)",
      "unit": "UN",
      "cost": 5,
      "stockAllowNegative": false,
      "stockControl": true,
      "stockMinimumQuantity": 2,
      "categoryId": 8,
      "categoryName": "Açaí",
      "stockQuantity": 4,
      "stockSituation": "regular"
    },
    {
      "productId": 30,
      "name": "Açaí",
      "unit": "UN",
      "stockControl": true,
      "stockAllowNegative": false,
      "stockMinimumQuantity": 2,
      "stockQuantity": 4,
      "stockSituation": "regular"
    },
    {
      "complementId": 31,
      "name": "Bacon",
      "unit": "UN",
      "stockControl": true,
      "stockAllowNegative": false,
      "stockMinimumQuantity": 2,
      "stockQuantity": 4,
      "stockSituation": "regular"
    }
  ],
  "page": 1,
  "limit": 20,
  "total": 3,
  "pages": 1
}