Demander API - Stock by Branch

This article is part of the REST Integration API documentation.

Documentation to consult, insert, update and delete stocks by branch.

Consultation

Lists stocks by company branch. Without filter, considers dataAlteracao from the last 6 months.

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

Caution

Pagination

• pagina — base 1 (default 1)
• limite — default 100, maximum 500

Filters

• filtroDataAlteracao — Y-m-d format
• operadorFiltro (optional) — <, >, =, <=, >= (default >=)

Return:

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

Insert or update

POST upsert by the compound key codProduto + codFilialUnidade.

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

Property	Type	Size	Mandatory	Description
codProduto	string	30	✓	Product code. Part of the upsert key.
codFilialUnidade	string	30	✓	Branch code. Part of the upsert key.
saldoEstoque	decimal		✓	Balance in stock. Accepts 0.
dataEstoque	datetime		✓	Date/time of last stock change. Format Y-m-d H:i:s.

Caution

Inclusion

• It is necessary to send all attributes that are mandatory. Return 201.

Update

• Only codProduto and codFilialUnidade are mandatory. Return 200.

Body:

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

Return:

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

Delete

Removes inventory by branch.

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

Return:

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