API do Demander - Estoque por Filial

Este artigo faz parte da documentação da API de Integração REST.

Documentação para consultar, inserir, atualizar e excluir estoques por filial.

Consulta

Lista os estoques por filial da empresa. Sem filtro, considera dataAlteracao dos últimos 6 meses.

Rota: {host}/public/v1/estoques-por-filial?pagina={pagina}&limite={limite}&filtroDataAlteracao={data}&operadorFiltro={operador}
Método: GET

Cuidado

Paginação

• pagina — base 1 (padrão 1)
• limite — padrão 100, máximo 500

Filtros

• filtroDataAlteracao — formato Y-m-d
• operadorFiltro (opcional) — <, >, =, <=, >= (padrão >=)

Retorno:

{
  "estoquesPorFilial": [
    {
      "codProduto": "00009",
      "codFilialUnidade": "00",
      "saldoEstoque": 10.5,
      "dataEstoque": "2020-08-28 15:51:10",
      "dataAlteracao": "2026-07-27 10:00:00"
    }
  ]
}

Inserir ou atualizar

POST upsert pela chave composta codProduto + codFilialUnidade.

Rota: {host}/public/v1/estoques-por-filial
Método: POST
Body: json

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
codProduto	string	30	✓	Código do produto. Parte da chave de upsert.
codFilialUnidade	string	30	✓	Código da filial. Parte da chave de upsert.
saldoEstoque	decimal		✓	Saldo em estoque. Aceita 0.
dataEstoque	datetime		✓	Data/hora da última alteração de estoque. Formato Y-m-d H:i:s.

Cuidado

Inclusão

• É necessário enviar todos os atributos que são obrigatórios. Retorno 201.

Atualização

• Apenas codProduto e codFilialUnidade são obrigatórios. Retorno 200.

Body:

{
  "codProduto": "00009",
  "codFilialUnidade": "00",
  "saldoEstoque": 10.5,
  "dataEstoque": "2020-08-28 15:51:10"
}

Retorno:

{
  "codProduto": "00009",
  "codFilialUnidade": "00",
  "saldoEstoque": 10.5,
  "dataEstoque": "2020-08-28 15:51:10",
  "dataAlteracao": "2026-07-27 10:00:00"
}

Excluir

Remove o estoque por filial.

Rota: {host}/public/v1/estoques-por-filial?codProduto={codProduto}&codFilialUnidade={codFilialUnidade}
Método: DELETE

Retorno:

{
  "mensagem": "Registro excluído com sucesso."
}