GET Ajuste de estoque - Varejonline/api GitHub Wiki

URLs

GET https://integrador.varejonline.com.br/apps/api/ajuste-estoque

Obtém todos os ajustes de estoque com retorno paginado

GET https://integrador.varejonline.com.br/apps/api/ajuste-estoque/:id

Obtém um ajuste de estoque por id

Parâmetros

  • entidades: Veja como Funciona este Filtro
  • inicio: Entenda a Coleta Paginada
  • quantidade: Entenda a Coleta Paginada
  • alteradoApos: Entenda a Coleta de Alterações
  • status: filtra pelo status do ajuste de estoque (enum: PENDENTE, EM_PROCESSAMENTO, PROCESSADO, ERRO_PROCESSAMENTO), separados por vírgula
  • desde: filtra por registros criados/alterados desde uma data específica (string no formato dd/mm/yyyy ou dd/mm/yyyy hh:mm:ss)
  • ate: filtra por registros criados/alterados até uma data específica (string no formato dd/mm/yyyy ou dd/mm/yyyy hh:mm:ss)
  • filtroData: pode ser informado para ser combinado com o filtro desde-ate. Aceita-se "dataAlteracao", "dataCriacao" ou "dataContagem"(padrão: dataAlteracao)
  • descricao: filtra pela descrição do ajuste de estoque (string)

Retorno

  • id: Identificador único do ajuste/balanço de estoque. (Long)
  • status: PENDENTE, EM_PROCESSAMENTO, PROCESSADO, ERRO_PROCESSAMENTO, EM_EXCLUSAO, ERRO_EXCLUSAO (String)
  • entidade: Entidade em que o ajuste foi realizado (objeto complexo) (boolean)
    • id: (Long)
    • nome: (String)
  • descricao: (string) (max. 255 chars)
  • dataContagem: (dd-MM-aaaa HH:mm:ss) (String)
  • produtos: Lista de produtos ajustados. (Array de Objetos)
    • id: Identificador do item de ajuste.** (Long)
    • quantidadeAjuste: Quantidade ajustada (Integer)
    • quantidadeAnterior: Quantidade registrada antes do ajuste. (Integer)
    • produto: Detalhes do produto ajustado. (Objeto)
      • id: ID do produto. (Long)
      • nome: nome do produto. (String) (max. 255 chars)
      • codigoSistema: (String) (max. 255 chars)
      • codigoBarras: (String) (max. 255 chars)
      • codigoInterno: (String) (max. 255 chars)
  • saidas: Lista de identificadores de saídas de estoque geradas por este ajuste. (Array de Long)
  • entradas: Lista de identificadores de entradas de estoque geradas por este ajuste. (Array de Long)
  • zerarEstoqueProdutosRestante: Indica se o sistema zerou o estoque dos produtos que não foram informados. (Boolean)
  • usuarioResponsavel: Dados do usuário que realizou o ajuste. (Objeto)
    • id: ID do usuário. (Long)
    • nome: Nome do responsável. (String) (max. 255 chars)
  • produtosInvalidos: Produtos que não puderam ser ajustados por algum motivo. (Array de Objetos)
    • criterioBusca: Critério utilizado para localizar o produto (ID, CODIGO_SISTEMA, CODIGO_INTERNO, CODIGO_BARRAS). (String) (max. 25 chars)
    • codigoInformado: Valor informado com base no critério. (String) (max. 255 chars)
    • motivo: Justificativa para não ajustar o produto. (String) (max. 255 chars)

Exemplo

GET https://integrador.varejonline.com.br/apps/api/ajuste-estoque/341

{
    "id": 341,
    "status": "PROCESSADO",
    "entidade": {
        "id": 1,
        "nome": "ENTIDADE SIMPLES NACIONAL"
    },
    "dataAlteracao": "29-05-2025 15:36:14",
    "descricao": "Ajuste teste A",
    "dataContagem": "29-05-2025 12:00:00",
    "produtos": [
        {
            "id": 341,
            "produto": {
                "id": 2,
                "nome": "Produto 1",
                "codigoSistema": "0002.0001",
                "codigoBarras": "7891343865321"
            },
            "quantidadeAjuste": 5,
            "quantidadeAnterior": 10
        },
        {
            "id": 342,
            "produto": {
                "id": 3,
                "nome": "Produto 2",
                "codigoSistema": "0002.0002",
                "codigoBarras": "7891343865322"
            },
            "quantidadeAjuste": 5,
            "quantidadeAnterior": 10
        }
    ],
    "saidas": [
        95
    ],
    "entradas": [
        10
    ],
    "zerarEstoqueProdutosRestante": false,
    "usuarioResponsavel": {
        "id": 1,
        "nome": "EQUIPE QA"
    },
    "produtosInvalidos": [
        {
            "criterioBusca": "ID",
            "codigoInformado": "1"
            "motivo": "contagens[0].produto: Não é possível realizar ajuste de estoque para produto base de grade."
        }
    ]
}