Histórico da Página
Objetivo
Método que disponibiliza informações de Vendas realizadas.
Chamada
GET api/v1/vendas?
NumeroCupom=
{NumeroCupom}&CNPJ=
{CNPJ}&NumeroPDV=
{NumeroPDV}&DataInicioVendas=
{DataInicioVendas}&DataFimVendas=
{DataFimVendas}&TipoVenda=
{TipoVenda}&_pageNo=
{_pageNo}&_pageSize=
{_pageSize}Informações para Requisição (Request Information)
Parâmetros URI (URI Parameters)
| Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
| NumeroCupom | Número do cupom | integer | Nenhum. |
| CNPJ | CNPJ da empresa Formato: 00000000000000 (14 dígitos) | string | Nenhum. |
| numeroPDV | Número do PDV | integer | Nenhum. |
| dataInicioVendas | Data início das vendas – Obrigatório – Formato: yyyy-MM-dd | string | Obrigatório Tamanho máximo: 10 Tamanho mínimo: 10 |
| dataFimVendas | Data fim das vendas – Obrigatório – Formato: yyyy-MM-dd | string | Obrigatório Tamanho máximo: 10 Tamanho mínimo: 10 |
| tipoVenda | Tipo da venda (Opções: P – PDV / E – ERP) | string | Nenhum. |
| _pageNo | integer | Nenhum. | |
| _pageSize | integer | Nenhum. |
Parâmetros do Corpo (Body Parameters)
Não há.
Informações para Resposta (Response Information)
Descrição do Recurso (Resource Description)
VendasRespostaDTO – lista de vendas
Coleção de VendaRespostaDto
| Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
| cpfCliente | CPF do Cliente | string | Nenhum. |
| numeroNota | Número do cupom | integer | Nenhum. |
| numeroEmpresa | Número da empresa | integer | Nenhum. |
| CNPJ | CNPJ da empresa | string | Nenhum. |
| numeroPDV | Número PDV | integer | Nenhum. |
| codigoOperador | Código do Operador de PDV | integer | Nenhum. |
| valorTotal | Valor total da venda | decimal number | Nenhum. |
| dataVenda | Data da venda | date | Nenhum. |
| valorDesconto | Valor de desconto da venda | decimal number | Nenhum. |
| valorAcrescimo | Valor de acréscimo da venda | decimal number | Nenhum. |
| situacao | Situação do cupom | string | Nenhum. |
| tipoVenda | Indicador do tipo de venda (Opções: P – PDV / E – ERP) | string | Nenhum. |
| itens | Lista de itens da venda | Coleção de ItemVendaRespostaDto | Nenhum. |
| finalizadoras | Lista de finalizadoras da venda | Coleção de FinalizadoraVendaRespostaDto | Nenhum. |
| origemPedido | Indicador da origem do Pedido | string | Opções = P - PDV / E - Ecommerce / T - Televendas |
| custoLiquidoFiscal | Custo líquido fiscal do item | decimal number | Custo Líquido Fiscal multiplicado pela quantidade de venda. |
| pessoas | Lista de pessoas da venda | DoctoPessoaDto | Nenhum. |
Formatos de Resposta (Response Formats)
application/json, text/json
Exemplo (Sample):
[
{
"cpfCliente": "sample string 1",
"numeroNota": 2,
"numeroEmpresa": 3,
"CNPJ": "sample string 4",
"numeroPDV": 1,
"codigoOperador": 1,
"valorTotal": 7.0,
"dataVenda": "2020-05-13T10:42:46.7840029-03:00",
"valorDesconto": 1.0,
"valorAcrescimo": 1.0,
"situacao": "sample string 9",
"tipoVenda": "sample string 10",
"origemPedido": "sample string 10",
"itens": [
{
"codigoProduto": 1,
"EAN": "sample string 2",
"descricao": "sample string 3",
"sequencia": 4,
"quantidade": 5.1,
"valorUnitario": 6.1,
"valorTotalItem": 7.0,
"valorDescontoItem": 1.0,
"valorAcrescimoItem": 1.0,
"custoLiquidoFiscal":0,
"situacaoItem": "sample string 8"
},
{
"codigoProduto": 1,
"EAN": "sample string 2",
"descricao": "sample string 3",
"sequencia": 4,
"quantidade": 5.1,
"valorUnitario": 6.1,
"valorTotalItem": 7.0,
"valorDescontoItem": 1.0,
"valorAcrescimoItem": 1.0,
"situacaoItem": "sample string 8"
}
],
"finalizadoras": [
{
"tipoPagamento": "sample string 1",
"valorPagamentoRealizado": 1.0
},
{
"tipoPagamento": "sample string 1",
"valorPagamentoRealizado": 1.0
}
]
},
{
"cpfCliente": "sample string 1",
"numeroNota": 2,
"numeroEmpresa": 3,
"CNPJ": "sample string 4",
"numeroPDV": 1,
"codigoOperador": 1,
"valorTotal": 7.0,
"dataVenda": "2020-05-13T10:42:46.7840029-03:00",
"valorDesconto": 1.0,
"valorAcrescimo": 1.0,
"situacao": "sample string 9",
"tipoVenda": "sample string 10",
"itens": [
{
"codigoProduto": 1,
"EAN": "sample string 2",
"descricao": "sample string 3",
"sequencia": 4,
"quantidade": 5.1,
"valorUnitario": 6.1,
"valorTotalItem": 7.0,
"valorDescontoItem": 1.0,
"valorAcrescimoItem": 1.0,
"situacaoItem": "sample string 8"
},
{
"codigoProduto": 1,
"EAN": "sample string 2",
"descricao": "sample string 3",
"sequencia": 4,
"quantidade": 5.1,
"valorUnitario": 6.1,
"valorTotalItem": 7.0,
"valorDescontoItem": 1.0,
"valorAcrescimoItem": 1.0,
"situacaoItem": "sample string 8"
}
],
"finalizadoras": [
{
"tipoPagamento": "sample string 1",
"valorPagamentoRealizado": 1.0
},
{
"tipoPagamento": "sample string 1",
"valorPagamentoRealizado": 1.0
}
],
"pessoasFidelidade": [
{
"Parceiro": "string",
"CNPJCPF": "string"
}
]
}
]application/xml, text/xml
Exemplo (Sample):
<Inline Model>
<cpfCliente>string</cpfCliente>
<numeroNota>1</numeroNota>
<numeroEmpresa>1</numeroEmpresa>
<CNPJ>string</CNPJ>
<numeroPDV>1</numeroPDV>
<codigoOperador>1</codigoOperador>
<valorTotal>1.1</valorTotal>
<dataVenda>1970-01-01T00:00:00.001Z</dataVenda>
<valorDesconto>1.1</valorDesconto>
<valorAcrescimo>1.1</valorAcrescimo>
<situacao>string</situacao>
<tipoVenda>string</tipoVenda>
<origemPedido>string</origemPedido>
<itens>
<codigoProduto>1</codigoProduto>
<EAN>string</EAN>
<descricao>string</descricao>
<sequencia>1</sequencia>
<quantidade>1.1</quantidade>
<valorUnitario>1.1</valorUnitario>
<valorTotalItem>1.1</valorTotalItem>
<valorDescontoItem>1.1</valorDescontoItem>
<valorAcrescimoItem>1.1</valorAcrescimoItem>
<custoLiquidoFiscal>1.1</custoLiquidoFiscal>
<situacaoItem>string</situacaoItem>
</itens>
<finalizadoras>
<tipoPagamento>string</tipoPagamento>
<valorPagamentoRealizado>1.1</valorPagamentoRealizado>
</finalizadoras>
<pessoasFidelidade>
<Parceiro>string</Parceiro>
<CNPJCPF>string</CNPJCPF>
</pessoasFidelidade>
</Inline Model>
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas