Listar Produtos

Descrição

Retorna a lista de produtos cadastrados no sistema, permitindo filtragem por diversos campos, como ID, nome, filial, código, se é vendável e status (ativo/inativo). Os resultados podem ser paginados por meio dos parâmetros take e skip.

OBS. Disponível para uso com chave de acesso de filial e também com chave de acesso de ADM Geral.

🔑 Parâmetros de Consulta (Query Params)

Parâmetro	Tipo	Obrigatoriedade	Descrição
idProduct	int32	Não	Filtrar pelo ID específico do produto.
idBranch	int32	Não	Filtrar pelo número da filial (somente aplicável para chaves multilocal; ignorado caso contrário).
name	string	Não	Filtrar pelo nome do produto.
code	string	Não	Filtrar pelo código do produto.
onlySellable	boolean	Não	Filtrar para retornar apenas produtos vendáveis (`true`). Valor padrão: `true`.
active	boolean	Não	Filtrar para retornar apenas produtos ativos (`true`) ou inativos (`false`). Valor padrão: `false`.
take	int32	Não	Quantidade de registros a serem retornados (máximo 50). Padrão: 25.
skip	int32	Não	Quantidade de registros a serem ignorados na listagem (paginação). Padrão: 0.

📤 Estrutura da Resposta

A resposta retorna a lista de produtos encontrados com base nos filtros informados.

Campo	Tipo	Descrição
`idProduct`	int32	Identificador único do produto.
`nameProduct`	string	Nome do produto.
`value`	number	Valor do produto.
`code`	string	Código do produto.
`active`	boolean	Indica se o produto está ativo no sistema.
`sellable`	boolean	Indica se o produto pode ser vendido.
`productForSale`	boolean	Indica se o produto está configurado para venda.
`allowSaleWithoutStock`	boolean	Indica se o produto pode ser vendido mesmo sem estoque disponível.
`currentAmount`	int32	Quantidade atual do produto em estoque.
`minimumAmount`	int32	Quantidade mínima configurada para o estoque do produto.

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200OK

application/json

Success

Body

Exemplo

[
    {
        "idProduct": 0,
        "nameProduct": "string",
        "value": 0,
        "code": "string",
        "active": true,
        "sellable": true,
        "productForSale": true,
        "allowSaleWithoutStock": true,
        "currentAmount": 0,
        "minimumAmount": 0
    }
]

🟠400Bad Request

Get products

Listar Produtos#

Descrição#

🔑 Parâmetros de Consulta (Query Params)#