ReferênciaProdutos

Buscar produtos e estoque (integrações)

Mesma busca de estoque da rota legada, no **padrão da API Consultiva**: a empresa é identificada por `cnpj` e/ou `empresa` e os erros usam o envelope padrão (`{ "error", "error_info" }`). Resposta **paginada** — informe `page`. Suporta busca por referência/SKU/ID e os mesmos filtros avançados (grupo, grife, fornecedor, faixa de preço/estoque). Recomendada para novas integrações; a rota antiga continua disponível.

GET
/integracoes/produto/estoque/busca

Authorization

userToken
AuthorizationBearer <token>

Token de usuário do ssOtica, obtido na tela de perfil do sistema. Enviado como Authorization: Bearer {token}.

In: header

Query Parameters

cnpj?string

CNPJ/CPF da empresa (com ou sem máscara). Informe cnpj e/ou empresa.

empresa?string

Chave de contrato da empresa. Informe cnpj e/ou empresa.

page*integer

Página.

perPage?integer

Itens por página, 1–100.

referencia?string

Referência do produto.

sku?string

SKU do produto (usado como referência quando referencia não é informado).

id?integer

ID do produto.

busca?string

Termo de busca (filtro avançado).

grupo_id?integer
grife_id?integer
fornecedor_id?integer
ativo?boolean
estoque_minimo?number
estoque_maximo?number
preco_min?number
preco_max?number

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/integracoes/produto/estoque/busca?page=1"
{  "currentPage": 1,  "totalPages": 5,  "totalItems": 48,  "perPage": 10,  "data": [    {      "id": 458095,      "referencia": "ARM-0001",      "descricao": "Armação Acetato Feminina",      "unidade": "UN",      "grife": "Marca X",      "grife_id": 277112,      "grupo": "Armações",      "grupo_id": 19206,      "subgrupo": "Acetato",      "subgrupo_id": 5521,      "cor": "Preto",      "tamanho": "52",      "formato": "Redondo",      "fornecedores": [        {          "id": 230563,          "documento": "11222333000144",          "razao_social": "Distribuidora LTDA",          "nome_fantasia": "Óticas Distrib"        }      ],      "estoque_atual": 12,      "reservado_os": 2,      "preco_venda": 299.9,      "preco_custo": 120,      "ativo": true,      "codigo_ean": "7891234567890",      "imagens": [        "string"      ],      "criado_em": "2024-01-10 09:00:00",      "criado_por": "Maria Operadora",      "atualizado_em": "2025-11-02 14:20:00",      "atualizado_por": "João Estoque"    }  ]}

{  "error": "DATA_INVALIDA",  "error_info": "O campo \"inicio_periodo\" contém uma data inválida. Utilize o formato AAAA-MM-DD (ex.: 2026-06-30)."}

{  "error": "Unauthenticated."}

Produtos vendidos no período (planilha Excel) GET

**Sempre retorna um arquivo Excel (`.xlsx`)** com os produtos vendidos. As datas de período são **opcionais** (sem elas, não há filtro de data). A empresa é localizada por `cnpj`.

Buscar produtos e estoque GET

Consulta produtos com estoque, preço, grupo, grife, fornecedores e quantidade reservada em ordens de serviço. Resposta **paginada** — informe `page` (a busca não retorna sem ele). Suporta busca por referência/SKU/ID e filtros avançados (grupo, grife, fornecedor, faixa de preço/estoque). Observação: a empresa é identificada por `empresa` (Código da Licença). As respostas de **erro** deste endpoint usam o formato `{ "message": "..." }` (HTTP 400). Para novas integrações, prefira a versão padronizada **`GET /integracoes/produto/estoque/busca`**, que identifica a empresa por `cnpj`/`empresa` e usa o envelope de erro padrão da API Consultiva.