Produtos
Retorna o catálogo de produtos da empresa. Registros ativos são retornados por padrão; use ativo=0 para consultar os excluídos.
GET/produtos
Escopo: produtos:ler
Filtros
| Parâmetro | Regra |
|---|---|
| nome | Mínimo 2 caracteres. |
| codigo | SKU exato. |
| ativo | 0 ou 1. Padrão 1. |
Ordenação: id, codigo, nome, preco e estoque. Padrão id asc. Como o estoque é calculado, ordenar por estoque mantém a ordem estável por id; não representa ordenação pelo saldo.
Campos
| Campo | Tipo | Origem/regra |
|---|---|---|
| id | integer | Identificador do produto. |
| codigo | string | SKU; se vazio, usa o próprio ID como texto. |
| nome | string | Descrição do produto. |
| unidade | string/null | Unidade cadastrada. |
| preco | number | Valor unitário. |
| estoque | number | Saldo calculado (entradas − saídas; balanços substituem). |
| ativo | boolean | Deriva de não excluído. |
Requisição
curl -H "Authorization: Bearer SEU_TOKEN" \
"https://web.synerasis.com.br/api/external/v1/produtos?codigo=PRD-055"Resposta 200
{
"data": [
{ "id": 55, "codigo": "PRD-055", "nome": "Peça X", "unidade": "UN", "preco": 300.00, "estoque": 12.00, "ativo": true }
],
"meta": { "pagina": 1, "por_pagina": 50, "total": 1, "total_paginas": 1 }
}