Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Objetivo

Método que disponibiliza informações de Pedidos de Compras e os produtos constante nestes.

Chamada

GET api/v1/vendas?

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
NumeroCupomNúmero do cupomintegerNenhum.
CNPJCNPJ da empresa Formato: 00000000000000 (14 dígitos)stringNenhum.
numeroPDVNúmero do PDVintegerNenhum.
dataInicioVendasData início das vendas – Obrigatório – Formato: yyyy-MM-ddstringObrigatório


Tamanho máximo: 10

Tamanho mínimo: 10

dataFimVendasData fim das vendas – Obrigatório – Formato: yyyy-MM-ddstringObrigatório


Tamanho máximo: 10

Tamanho mínimo: 10

tipoVendaTipo da venda (Opções: P – PDV / E – ERP)stringNenhum.
_pageNo
integerNenhum.
_pageSize
integerNenhum.

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)

cpfClienteCPF do ClientestringNenhum.

numeroNotaNúmero do cupomintegerNenhum.

numeroEmpresaNúmero da empresaintegerNenhum.

CNPJCNPJ da empresastringNenhum.

numeroPDVNúmero PDVintegerNenhum.

numeroSerieEcf

Número de série do emissor de cupom fiscal

stringNenhum.

serieNota

Série da nota

stringNenhum.

CodigoVendedorCódigo do VendedorintegerNenhum.

codigoOperadorCódigo do Operador de PDVintegerNenhum.

valorTotalValor total da vendadecimal numberNenhum.

dataVendaData da vendadateNenhum.

valorDescontoValor de desconto da vendadecimal numberNenhum.

valorAcrescimoValor de acréscimo da vendadecimal numberNenhum.

situacaoSituação do cupomstringV=Valido; C=Cancelado

tipoVendaIndicador do tipo de venda (Opções: P – PDV / E – ERP)stringNenhum.

chaveAcessoChave do cupomsample stringNenhum.
itens
Lista de itens da vendaColeção de ItemVendaRespostaDtoNenhum.

codigoProdutoCódigo sequencial do produto no ERPintegerNenhum.

EANCódigo de barras EAN ou DUN do produtosample stringNenhum.

descricaoDescrição do produto sample stringNenhum.

sequenciaSequencia do item no cupomintegerNenhum.

quantidadeQuantidade decimal numberNenhum.

valorUnitarioValor unitário do item decimal numberNenhum.

valorTotalItem

Valor total do item 

decimal numberNenhum.

valorDescontoItemValor do desconto do itemdecimal numberNenhum.

valorAcrescimoItemValor de acréscimo no itemdecimal numberNenhum.

custoLiquidoFiscalCusto líquido fiscal do itemdecimal numberCusto Líquido Fiscal multiplicado pela quantidade de venda.

situacaoItemSituação do item no cupomsample stringV=Valido; C=Cancelado
finalizadoras
Lista de finalizadoras da vendaColeção de FinalizadoraVendaRespostaDtoNenhum.

tipoPagamentoTipo de pagamentosample stringNenhum.

valorPagamentoRealizadoValor do págamento realizado decimal numberNenhum.

origemPedidoIndicador da origem do PedidostringOpções = P - PDV / E - Ecommerce / T - Televendas

custoLiquidoFiscalCusto líquido fiscal do item decimal numberCusto Líquido Fiscal multiplicado pela quantidade de venda.

pessoasLista de pessoas da vendaDoctoPessoaDtoNenhum.
pessoasFidelidade
Lista de pessoas fidelizadasColeção de pessoasFidelidadeVendaRespostaDtoNenhum.

codParceiroCódigo Parceiro do programa de fidelidadeintegerNenhum.

CNPJCPFCNPJ ou CPF do parceirostringNenhum.

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,
"numeroSerieEcf": string optional,
"serieNota": string optional,
"codigoVendedor": 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":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,
"custoLiquidoFiscal":1.0, "situacaoItem": "sample string 8" } ], "finalizadoras": [ { "tipoPagamento": "sample string 1", "valorPagamentoRealizado": 1.0 }, { "tipoPagamento": "sample string 1", "valorPagamentoRealizado": 1.0
} ],
"pessoasFidelidade": [
{
"codParceiro": "integer",
"CNPJCPF": "string"
}
] }, { "cpfCliente": "sample string 1", "numeroNota": 2, "numeroEmpresa": 3, "CNPJ": "sample string 4", "numeroPDV": 1,
"numeroSerieEcf": string optional,
"serieNota": string optional,
"codigoVendedor": 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":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,
"custoLiquidoFiscal":1.0, "situacaoItem": "sample string 8" } ], "finalizadoras": [ { "tipoPagamento": "sample string 1", "valorPagamentoRealizado": 1.0 }, { "tipoPagamento": "sample string 1", "valorPagamentoRealizado": 1.0
}
],
"pessoasFidelidade": [
{
"codParceiro": "integer",
"CNPJCPF": "string"
}
]
}
{
"cpfCliente": "string",
"numeroNota": "string"
}
]

application/xml, text/xml

Exemplo (Sample):

<Inline Model>
<cpfCliente>string</cpfCliente>
<numeroNota>1</numeroNota>
<numeroEmpresa>1</numeroEmpresa>
<CNPJ>string</CNPJ>
<numeroPDV>1</numeroPDV>
<numeroSerieEcf>string</numeroSerieEcf>
<serieNota>string</serieNota>
<codigoVendedor>1</codigoVendedor>
<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>
<codParceiro>integer</codParceiro>
<CNPJCPF>string</CNPJCPF>
</pessoasFidelidade>
</Inline Model>