Retorna produtos

Authorizations

x-api-key

string

header

required

Chave da API gerada no agulhão

Query Parameters

pagina

integer

default:1

Número da página para paginação dos resultados

Example:

1

qtdePorPagina

integer

default:100

Quantidade de produtos por página

Example:

10

ultimaAtualizacao

string<date-time>

Data da última atualização dos produtos (formato ISO 8601)

Example:

"2025-01-01T00:00:00Z"

marcas

string

Filtra produtos por marcas (IDs separados por vírgula)

Example:

"1,2,3"

grupos

string

Filtra produtos por departamentos (IDs separados por vírgula)

Example:

"1,2,3"

subGrupos

string

Filtra produtos por grupos (IDs separados por vírgula)

Example:

"1,2,3"

fornecedorCod

enum<string>

Filtra produtos por código do fornecedor

Available options:

1,

0

Example:

"1"

comEstoque

enum<string>

Filtra produtos que possuem estoque

Available options:

1,

0

Example:

"1"

semEstoque

enum<string>

Filtra produtos que não possuem estoque

Available options:

1,

0

Example:

"1"

precoMin

string

Filtra produtos com preço mínimo

Example:

"10.00"

precoMax

string

Filtra produtos com preço máximo

Example:

"100.00"

filialCod

string

Filtra produtos por código da filial

Example:

"1"

radioStatus

enum<string>

Filtra produtos pelo status (A - Ativo, I - Inativo)

Available options:

A,

I

Example:

"A"

pesquisa

string

Pesquisa pela descrição do produto

Example:

"Produto"

codigoOriginal

string

Filtra produtos pelo código original

Example:

"REF123"

codigoInterno

string

Filtra produtos pelo código interno

Example:

"1"

Response

200 - application/json

Sucesso

produtoCodigo

number

Identificador único do produto

Example:

1

produtoDescricao

string

Descrição do produto

Example:

"Produto Personalizado"

produtoReferencia

string

Referência do produto

Example:

"REF123"

marcaNome

string

Nome da marca do produto

Example:

"Marca Exemplo"

produtos

pedidos

pessoas

tipos-lancamento

filiais

Authorizations

Query Parameters

Response