API Vendas (WEB)

Atualizado em1 de agosto de 2024

Informações gerais

Na API WEB, é possível consultar as vendas no período, vendas de itens e a movimentação de estoque dos produtos.
O tipo de requisição suportada “GET”.
Os endpoints precisam ter qualquer parâmetro, exceto o de movimento de estoque que precisa ter ao um parâmetro de “data”.
A API consulta as vendas realizadas tanto no PDV Web quanto vendas diretamente no sistema WEB.

Vendas no Período

Vendas: “/public-api/v2/venda”.
Parâmetros: “idVenda”, “documento”, “pdv”, “codigoCliente”, “emissao”, “codigoFilial”, “status”.
Exemplo: “/public-api/v2/venda?codigoCliente=265&documento=20&codigoFilial=1”.
Após o “venda” da URL, é preciso ter o carácter “?” e o filtro desejado. Caso seja usado diversos filtros, separe-os com o caracter “&”.


JSON retornado:
[ {
"identificacao": "VND",
"tabela": "vendas_cabecalho_view",
"descricaoLayout": "Venda",
"idVenda": 12,
"documento": "20",
"pdv": 1,
"codigoCliente": "265",
"nomeCliente": "CARLOS",
"nomeVendedor": "",
"emissao": "2023-08-30",
"dataHoraEmissao": "2023-08-30T15:34:26.635",
"valorProdutos": "102.00",
"valorTotal": "102.00",
"desconto": "0.00",
"codigoFilial": 1,
"status": 3
}
]

Vendas de itens

Venda-item: “/public-api/v2/venda-item”.
Parâmetros: “idVenda”, “idItem”, “documento”, “modelo”, “pdv”, “codigoCliente”, “codigoVendedor”, “emissao”, “codigoProduto”, “codigoFilial”, “status”, “tipoItem”.
Exemplo: “/public-api/v2/venda-item?emissao.ge=2023-05-05&codigoProduto=10084”
Após o “venda-item” da URL, é preciso ter o carácter “?” e o filtro desejado. Caso seja usado diversos filtros, separe-os com o caracter “&”.

[ {
"idVenda": 12,
"iditem": 12,
"documento": "20",
"modelo": "2D",
"pdv": 1,
"codigoCliente": "265",
"nomeCliente": "CARLOS",
"codigoVendedor": "",
"nomeVendedor": "",
"emissao": "2023-08-30",
"dataHoraEmissao": "2023-08-30T15:34:05.173",
"valorProdutos": "102.00",
"valorTotal": "102.00",
"cfop": "5102",
"codigoProduto": "10084",
"descricaoProduto": "01 Produto teste mercado livre",
"quantidade": "1.000000000000",
"precoUnitario": "102.000",
"desconto": "0.000",
"total": "102.00",
"codigoFilial": 1,
"status": 3,
"condicaoPagamento": "Dinheiro",
"tipoItem": "P",
"embalagem": "1.000000",
"codigoUnidadeMedida": "UN",
"horaVenda": "15:34:05.173",
"pis": "0.00",
"cofins": "0.00",
"ipi": "0",
"icms": "17.34",
"icmsst": "0",
"icmsstfcp": "0",
"iss": "0.00",
"frete": "0",
"seguro": "0",
"outrasDespesas": "0",
"localEstoque": 0,
"codigoFamilia": "2",
"descricaoFamilia": "Familia produto 01",
"codigoGrupo": "578",
"descricaoGrupo": "nível 2",
"codigoMarca": "4",
"descricaoMarca": "Sem fabricante",
"variacoes": [ {
"codigo": 203,
"variacao": "Amarelo/G",
"quantidade": "1"
}
]
}

Movimentação de estoque dos produtos

Movimentação de estoque: “/public-api/v2/movimentacao-estoque”.
Parâmetros: “codigoFilial”, “codigoLocalEstoque”, “codigoProduto”.
Parâmetro obrigatório: “data”.
Exemplo: “/public-api/v2/movimentacao-estoque?data.ge=1900-01-01&data.le=2023-01-01&codigoProduto=1000&codigoLocalEstoque=1”.
Após o “movimentacao-estoque” da URL, é preciso ter o carácter “?” e o filtro desejado. Caso seja usado diversos filtros, separe-os com o caracter “&”.

JSON retornado:
[ {
"identificacao": "MVE",
"tabela": "movimentoestoque",
"descricaoLayout": "Movimentação de estoque",
"codigoFilial": "1",
"nomeFilial": "Testes AUTO",
"codigoLocalEstoque": "1",
"descricaoLocalEstoque": "Geral",
"codigoProduto": "1000",
"nomeProduto": "Produto normal",
"quantidadeEntrada": "101.000000",
"quantidadeSaida": "0.000000"
}
]

Conteúdo Relacionado

Os artigos listados abaixo estão relacionados ao que você acabou de ler:
• Índice de Endpoints (WEB)
• Antes de Falar com o Suporte Técnico
• Obtendo suporte técnico e ajuda