GET saldos mercadorias - Varejonline/api GitHub Wiki

Objetivo: Retornar o saldo físico bruto (positivo ou negativo) que foi consolidado em histórico nas lojas.

Comportamento 1: Visão Consolidada (Snapshot de Estoque)

Busca com o parâmetro data.

O que ele faz: Tira uma "fotografia" do estoque acumulado.
O que retorna: Apenas 1 registro por produto/entidade, contendo o saldo final total daquele momento.

Comportamento 2: Visão Histórica Recalculada (Delta/Extrato)

Busca com o parâmetro alteradoApos.

O que ele faz: O sistema busca qualquer produto que sofreu movimentação (faturamento, inventário, entrada) a partir daquela data/hora. Caso uma alteração retroativa tenha sido feita, ele recalcula a linha do tempo.
O que retorna: Múltiplos registros por produto/entidade (dia a dia), mostrando a evolução do saldo a partir do dia em que a alteração ocorreu.

URLs

GET https://integrador.varejonline.com.br/apps/api/saldos-mercadorias

Parâmetros

produtos: lista de ids dos produtos cujos saldos se deseja obter, separados por vírgula
entidades: Veja como Funciona este Filtro
inicio: Entenda a Coleta Paginada
quantidade: Entenda a Coleta Paginada
alteradoApos: Entenda a Coleta de Alterações
data: data de referência para o saldo. Se não for informada, será retornado o saldo na data atual. (dd-mm-yyyy ou dd/mm/yyyy)
somenteEcommerce: Permite filtrar somente produtos integráveis no ecommerce (true) ou todos (false) (Boolean Opcional)
somenteMarketplace: Permite filtrar somente produtos integráveis no marketplace (true) ou todos (false) (Boolean Opcional)

Observações

Regra de Precedência: Os parâmetros alteradoApos e data são mutuamente exclusivos. Se ambos forem enviados, alteradoApos terá prioridade.
Quando o parâmetro data não for informado nem o parâmetro alteradoApos, será utilizada a data atual para consulta com o parâmetro data.

Retorno

entidade: entidade à qual o saldo se refere (objeto complexo)
- id: id da entidade (long)
- nome: nome da entidade (string)
- documento: documento da entidade (string)
produto: dados do produto devolvido (objeto complexo)
- id: id da mercadoria
- descricao: id da mercadoria
- codigoSistema: Código Sistema da mercadoria
- codigoInterno: Código Interno da mercadoria
- codigoBarras: Código de Barras da mercadoria
quantidade: quantidade em estoque do produto (decimal)
dataAlteracao: última data de alteração do saldo, no formato dd-mm-aaaa hh:mi:ss
data: data de referência do saldo, no formato dd-mm-aaaa

Exemplo

GET https://integrador.varejonline.com.br/apps/api/saldos-mercadorias?produtos=11,4,5&entidades=1,2,3

[
   {
      "entidade": {
          "id": 3,
          "nome": "Entidade teste",
          "documento": "00.000.000/0000-00"
      },
      "quantidade":500,
      "dataAlteracao": "12/12/2012 23:30:00",
      "produto": {
            "id":9342,
            "descricao":"BLUSA MALHA PRETA GG",
            "codigoSistema":"0001.0001",
            "codigoInterno":"",
            "codigoBarras":""
      },
      "data": "12/12/2012"
   },
   {
      "entidade": {
          "id": 3,
          "nome": "Entidade teste",
          "documento": "00.000.000/0000-00"
      },
      "quantidade":0,
      "dataAlteracao": "12/12/2012 23:30:00",
      "produto": {
            "id":9343,
            "descricao":"BLUSA MALHA PRETA P",
            "codigoSistema":"0001.0002",
            "codigoInterno":"",
            "codigoBarras":""
      },
      "data": "12/12/2012"
   }
]