ReferênciaProdutos

Buscar produtos e estoque (integrações)

Produtos da loja com estoque, preço, grupo, grife e fornecedores. Sem filtros, retorna somente os produtos ativos na loja; para consultar os inativos, utilize o parâmetro ativo.

GET
/integracoes/produto/estoque/busca

Authorization

userToken
AuthorizationBearer <token>

Chave de acesso que aparece no cadastro do usuário, no ssOtica. Envie como Authorization: Bearer {chave}.

In: header

Query Parameters

cnpj?string

CNPJ (ou CPF) da loja, com ou sem máscara. Informe cnpj ou empresa.

empresa?string

Código da Licença da loja (chave de contrato). Informe cnpj ou empresa.

page?integer

Número da página, a partir de 1 (padrão 1). As páginas devem ser consultadas até o valor de totalPages informado na resposta.

perPage?integer

Itens por página (padrão 100). Valores acima de 100 são ajustados automaticamente para 100.

referencia?string

Referência do produto (busca simples).

sku?string

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

id?integer

ID do produto (busca simples). Retorna o produto mesmo que esteja inativo na loja. Corresponde ao id de itens[].produto.id na consulta de vendas.

busca?string

Texto pesquisado na descrição, na referência, no código EAN e no nome da grife. Ativa a busca avançada.

grupo_id?integer

ID do grupo de produtos. Aceita múltiplos valores separados por vírgula (ex.: 12,15). Ativa a busca avançada.

grife_id?integer

ID da grife. Aceita múltiplos valores separados por vírgula. Ativa a busca avançada.

fornecedor_id?integer

ID do fornecedor. Aceita múltiplos valores separados por vírgula. Ativa a busca avançada.

ativo?boolean

1 para produtos ativos e 0 para inativos na loja. Tem efeito somente quando combinado a outro parâmetro da busca avançada; por exemplo, ativo=0&ordenar_por=descricao retorna os inativos. Informado isoladamente, é desconsiderado. Sem este parâmetro, são retornados apenas os produtos ativos.

estoque_minimo?number

Retorna produtos com estoque atual igual ou superior a este valor. Ativa a busca avançada.

estoque_maximo?number

Retorna produtos com estoque atual igual ou inferior a este valor. Ativa a busca avançada.

preco_min?number

Retorna produtos com preço de venda igual ou superior a este valor. Ativa a busca avançada.

preco_max?number

Retorna produtos com preço de venda igual ou inferior a este valor. Ativa a busca avançada.

ordenar_por?string

Campo utilizado na ordenação (ativa a busca avançada). Valores fora da lista são desconsiderados.

direcao?string

Direção da ordenação, utilizada com ordenar_por: desc para decrescente; qualquer outro valor resulta em ordem crescente (asc).

fields?string

basico devolve o payload reduzido (ativa a busca avançada): id, referencia, descricao, grife, grupo, estoque_atual, reservado_os, data_ultima_compra, preco_venda, custo e ativo. Outro valor é ignorado.

Response Body

application/json

application/json

text/html

curl -X GET "https://example.com/integracoes/produto/estoque/busca"
{  "currentPage": 1,  "totalPages": 1,  "totalItems": 1,  "perPage": 100,  "data": [    {      "id": 2605953,      "referencia": "Observação de exemplo",      "descricao": "**arm.pof.200-7059-50-1742-J Pierre",      "unidade": "UN",      "grife": "Jean Pierre",      "grife_id": 2761112,      "grupo": "Armações",      "grupo_id": 200232,      "subgrupo": null,      "subgrupo_id": null,      "cor": null,      "tamanho": null,      "formato": null,      "fornecedores": [        {          "id": 63715,          "documento": "",          "razao_social": "Signus",          "nome_fantasia": "Signus"        }      ],      "estoque_atual": 121,      "reservado_os": 59,      "data_ultima_compra": null,      "preco_venda": "80.00",      "custo": "68.02",      "ativo": true,      "codigo_ean": null,      "imagens": [        {          "img": "https://s3.us-west-2.amazonaws.com/static.ipe.digital/superstore/q4XnKq/produtos/imagens/mOwdDj_LrkgRLwIxnqEFvlz.jpg",          "thumb": "https://s3.us-west-2.amazonaws.com/static.ipe.digital/superstore/q4XnKq/produtos/imagens/thumbnail/mOwdDj_LrkgRLwIxnqEFvlz.jpg"        },        {          "img": "https://s3.us-west-2.amazonaws.com/static.ipe.digital/superstore/q4XnKq/produtos/imagens/mOwdDj_7gDJUwndQE9Iyopf.jpg",          "thumb": "https://s3.us-west-2.amazonaws.com/static.ipe.digital/superstore/q4XnKq/produtos/imagens/thumbnail/mOwdDj_7gDJUwndQE9Iyopf.jpg"        },        {          "img": "https://s3.us-west-2.amazonaws.com/static.ipe.digital/superstore/q4XnKq/produtos/imagens/mOwdDj_O1NLV9mZWtKLG9id.jpg",          "thumb": "https://s3.us-west-2.amazonaws.com/static.ipe.digital/superstore/q4XnKq/produtos/imagens/thumbnail/mOwdDj_O1NLV9mZWtKLG9id.jpg"        },        {          "img": "https://s3.us-west-2.amazonaws.com/static.ipe.digital/superstore/q4XnKq/produtos/imagens/mOwdDj_SIdVCuMnosSyhcnj.jpg",          "thumb": "https://s3.us-west-2.amazonaws.com/static.ipe.digital/superstore/q4XnKq/produtos/imagens/thumbnail/mOwdDj_SIdVCuMnosSyhcnj.jpg"        },        {          "img": "https://s3.us-west-2.amazonaws.com/static.ipe.digital/superstore/q4XnKq/produtos/imagens/mOwdDj_XFd8RsjAtcMfDtHC.jpg",          "thumb": "https://s3.us-west-2.amazonaws.com/static.ipe.digital/superstore/q4XnKq/produtos/imagens/thumbnail/mOwdDj_XFd8RsjAtcMfDtHC.jpg"        }      ],      "criado_em": "2018-11-23 09:21:38",      "criado_por": "Ana Caixa",      "atualizado_em": "2024-05-03 13:12:20",      "atualizado_por": "Maria Operadora"    }  ]}

{  "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)."}

"Unauthorized."

Produtos vendidos no período (planilha Excel) GET

Retorna uma planilha Excel (.xlsx) com os produtos vendidos. A loja é identificada pelo CNPJ, e o período é opcional.

Buscar produtos e estoque GET

Versão anterior da busca de produtos, que identifica a loja somente pelo Código da Licença e retorna os erros no formato message. Para novas integrações, recomenda-se a busca de produtos (integrações).