API para integração de pedidos e-commerce no PDV
API para geração e manutenção de vendas e notas fiscais do e-commerce no PDV
Version: 1.0
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
[ Jump to Models ]
Table of Contents
Up
post /nfe/devolucao-rs
(geraDevolucao)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/plain
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
(testeRest)
Return type
String
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
default
default response
String
Up
post /api/desconto/melhor/obter-v1
Consultar melhor desconto por produto (obterV1)
Consulta melhor desconto do produto consultando no próprio sistema e no PEC.
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"nomeLaboratorio" : "Laboratório Genérico S.A.",
"percentualDesconto" : 15.0,
"valorVenda" : 19.9,
"codigoCondicaoPagamento" : "7",
"codigoProduto" : 12345,
"nomeCondicaoPagamento" : "CARTAO",
"nomeDesconto" : "CADPRODU",
"quantidadeEstoque" : 150,
"codigoBarras" : 7891234567890,
"nomeProduto" : "Dipirona 500mg",
"quantidade" : 150,
"codigoLaboratorio" : 678
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Consulta realizada com sucesso
DescontoMelhorIntegracaoDto
400
Requisição inválida
401
Não autorizado
500
Erro interno na consulta
Up
get /api/nota-fiscal/download-xml-nota-v1
Download do XML da nota fiscal (downloadXmlNotaV1)
Faz o download do XML da nota fiscal emitida.
Query parameters
numeroNota (required)
Query Parameter — Número da venda gerada no PDV format: int64
numeroPedido (required)
Query Parameter — Número do pedido no e-commerce vinculado à venda
Return type
String
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
XML da nota fiscal
String
401
Não autorizado
404
Nota fiscal não localizada
Up
post /api/nota-fiscal/emitir-nota-v1
Emitir nota fiscal (emitirNotaV1)
Emite uma nota fiscal para um pedido de e-commerce.
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"numeroSequencial" : 1,
"modeloNotaFiscal" : "55",
"tipoRetorno" : "Sucesso",
"descricaoRetorno" : "Nota fiscal emitida com sucesso",
"numeroNotaFiscal" : 67890,
"numeroPedido" : "PED-20240001",
"serieNotaFiscal" : "A1",
"codigoRetorno" : "200",
"numeroNota" : 12345,
"chaveNotaFiscal" : "12345678901234567890123456789012345678901234"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Nota(s) emitida(s) com sucesso
EmissaoNotaFiscalIntegracaoRetDto
400
Erro na emissão da nota
401
Não autorizado
500
Erro na emissão da nota
Up
post /api/venda/atualizar-status-venda-v1
Atualizar status da venda e-commerce (atualizarStatusPedidoV1)
Atualiza o status de uma venda e-commerce.
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"numeroPedido" : "PED-20240001",
"statusPedido" : {
"codigo" : "codigo",
"descricao" : "descricao"
},
"numeroNota" : 12345
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Status atualizado com sucesso
VendaEcommerceIntegracaoRetDto
400
Requisição inválida
401
Não autorizado
500
Erro na atualização do status da venda
Up
get /api/venda/consultar-venda-numero-nota-v1
Consultar venda pelo número da venda (consultarVendaCodigoBarrasV1)
Consulta vendas pelo número da venda gerada no PDV.
Query parameters
numeroNota (required)
Query Parameter — Número da venda gerada no PDV format: int64
Return type
Example data
Content-Type: application/json
{
"cliente" : {
"fone" : "(48)99999-9999",
"codigo" : 12345,
"numeroCpfCnpj" : "12345678901",
"numeroRGIE" : "1234567890",
"celular" : "(48)90000-0000",
"nome" : "João da Silva",
"dataNascimento" : "2000-01-23T04:56:07.000+00:00",
"sexo" : "M",
"email" : "email@teste.com"
},
"pagamentoMultiplo" : {
"dinheiro" : {
"valor" : 100.0
},
"cartao" : [ {
"codigo" : 1,
"qtdParcela" : 3,
"valor" : 100.0,
"numeroAutorizacao" : 1234567890
}, {
"codigo" : 1,
"qtdParcela" : 3,
"valor" : 100.0,
"numeroAutorizacao" : 1234567890
} ],
"crediario" : {
"vencimentos" : [ "2026-06-10", "2026-07-10", "2026-08-10" ],
"qtdParcela" : 3,
"valor" : 100.0,
"pagamentoRealizado" : true
},
"pix" : {
"codigo" : 5,
"idTransacaoPIX" : "1234567890",
"valor" : 100.0,
"numeroAutorizacao" : 1234567890
}
},
"vendedor" : {
"codigo" : 123,
"nome" : "Maria"
},
"valorFrete" : 10.0,
"produtos" : [ {
"numeroSequencial" : 1,
"valorDesconto" : 0.5,
"codigoProduto" : 12345,
"nomeDesconto" : "CADPRODU",
"nomeProduto" : "Produto Exemplo",
"quantidade" : 2,
"valorUnitario" : 50.0
}, {
"numeroSequencial" : 1,
"valorDesconto" : 0.5,
"codigoProduto" : 12345,
"nomeDesconto" : "CADPRODU",
"nomeProduto" : "Produto Exemplo",
"quantidade" : 2,
"valorUnitario" : 50.0
} ],
"enderecoEntrega" : {
"cidade" : "São Paulo",
"estado" : "SP",
"complemento" : "Apto 101",
"numero" : "123",
"bairro" : "Centro",
"logradouro" : "Rua das Flores",
"referencia" : "Ao lado do mercado público",
"cep" : "12345678"
},
"dataPedido" : "2020-01-01T23:59:59-0300",
"entrega" : true,
"numeroPedido" : "PED-20240001",
"numeroNota" : 98143,
"valorTotalVenda" : 100.0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Consulta realizada com sucesso
VendaEcommerceIntegracaoDto
400
Requisição inválida
401
Não autorizado
500
Erro interno na consulta
Up
get /api/venda/consultar-venda-v1
Consultar venda e-commerce (consultarVendaV1)
Consulta vendas do e-commerce por parâmetros.
Query parameters
numeroNota (required)
Query Parameter — Número da venda gerada no PDV format: int64
numeroPedido (required)
Query Parameter — Número do pedido no e-commerce vinculado à venda
limiteMensal (optional)
Query Parameter — Se true, limita a consulta às vendas dos últimos 30 dias default: false
Return type
Example data
Content-Type: application/json
{
"xmlNfe" : "xmlNfe",
"numeroCupomFiscal" : 0,
"numeroNotaFiscal" : 6,
"dataPedido" : "2000-01-23T04:56:07.000+00:00",
"numeroPedido" : "PED-20240001",
"statusPedido" : {
"codigo" : "codigo",
"descricao" : "descricao"
},
"numeroNota" : 12345
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Consulta realizada com sucesso
StatusVendaEcommerceIntegracaoRetDto
400
Requisição inválida
401
Não autorizado
500
Erro na consulta de vendas
Up
post /api/venda/efetuar-venda-v1
Efetuar venda e-commerce (efetuarVendaV1)
Efetua uma venda no e-commerce.
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"numeroPedido" : "PED-20240001",
"statusPedido" : {
"codigo" : "codigo",
"descricao" : "descricao"
},
"numeroNota" : 12345
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Venda efetuada com sucesso
VendaEcommerceIntegracaoRetDto
400
Requisição inválida
401
Não autorizado
500
Erro na geração da venda
Up
post /api/venda/finalizar-venda-v1
Finalizar venda e-commerce (finalizarVendaV1)
Finaliza uma venda no e-commerce.
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"numeroPedido" : "PED-20240001",
"statusPedido" : {
"codigo" : "codigo",
"descricao" : "descricao"
},
"numeroNota" : 12345
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Venda finalizada com sucesso
VendaEcommerceIntegracaoRetDto
400
Requisição inválida
401
Não autorizado
500
Erro na finalização da venda
[ Jump to Methods ]
Table of Contents
AtualizaStatusPedidoEcommerceDtoCartaoVendaIntegracaoDTOClienteEcommerceIntegracaoDtoCrediarioIntegracaoDTODadosDestinatarioDadosEmitenteDadosTransporteDescontoMelhorIntegracaoDtoDescontoMelhorIntegracaoReqDtoDevolucaoFornecedorDTODfeReferenciadoDinheiroIntegracaoDTOEmissaoNotaFiscalIntegracaoDtoEmissaoNotaFiscalIntegracaoRetDtoEnderecoEntregaIntegracaoDtoIbsCbsIbsCbsProdutoIntegracaoJsonItemNotaFiscalItemNotaFiscalItemVendaMedicamentosNotaFiscalDevolucaoNotaFiscalOrigemPagamentoMultiploIntegracaoDtoPixIntegracaoDTOProdutoDescontoMelhorIntegracaoDtoRastrosStatusPedidoStatusVendaEcommerceIntegracaoRetDtoVendaVendaEcommerceFinalizacaoIntegracaoDtoVendaEcommerceIntegracaoDtoVendaEcommerceIntegracaoRetDtoVendaItemEcommerceIntegracaoDtoVendedorEcommerceIntegracaoDto
Objeto utilizado para atualizar o status de uma venda e-commerce no PDV
numeroNota
Integer Número da venda gerada no PDV format: int32
example: 12345
numeroPedido
String Número do pedido no e-commerce vinculado à venda
example: PED-20240001
status
String Status do pedido no e-commerce
4 - CANCELADO
example: 4
Objeto utilizado para informar a forma de pagamento CARTÃO em uma venda e-commerce no PDV
codigo
Integer Código do cartão (Trier) format: int32
example: 1
numeroAutorizacao (optional)
Integer Número de autorização da transação no cartão format: int32
example: 1234567890
qtdParcela (optional)
Integer Número de parcelas no cartão format: int32
example: 3
valor
Double Valor pago no cartão format: double
example: 100.0
Objeto utilizado para informar o cliente de uma venda e-commerce no PDV
celular (optional)
String Número de celular do cliente format: (##)#####-####
example: (48)90000-0000
codigo (optional)
Integer Código do cliente, se não informado, será gerado automaticamente pelo PDV format: int32
example: 12345
dataNascimento (optional)
Date Data de nascimento do cliente format: date-time
email (optional)
example: email@teste.com
fone (optional)
String Número de telefone do cliente
example: (48)99999-9999
nome
example: João da Silva
numeroCpfCnpj
String Número do CPF ou CNPJ do cliente
example: 12345678901
numeroRGIE (optional)
String Número do RG ou IE do cliente
example: 1234567890
sexo (optional)
M,F
example: M
Objeto utilizado para informar a forma de pagamento CREDIARIO em uma venda e-commerce no PDV.
pagamentoRealizado
Boolean Indica se o pagamento foi realizado.
example: true
qtdParcela
Integer Número de parcelas do crediario. format: int32
example: 3
valor
Double Valor total pago no crediario. format: double
example: 100.0
vencimentos (optional)
array[String] Vencimentos manuais por parcela (yyyy-MM-dd), na ordem das parcelas. Se omitido, calculado pela configuração do cliente.
example: ["2026-06-10","2026-07-10","2026-08-10"]
bairro (optional)
cep (optional)
cidade (optional)
cnae (optional)
cnpj (optional)
codigoMunicipio (optional)
codigoPais (optional)
complemento (optional)
email (optional)
indicadorIE (optional)
inscricaoEstadual (optional)
inscricaoEstadualST (optional)
inscricaoMunicipal (optional)
inscricaoSuframa (optional)
logradouro (optional)
numeroEndereco (optional)
pais (optional)
razaoSocial (optional)
telefone (optional)
uf (optional)
bairro (optional)
cep (optional)
cidade (optional)
cnae (optional)
cnpj (optional)
codigoMunicipio (optional)
codigoPais (optional)
complemento (optional)
inscricaoEstadual (optional)
inscricaoEstadualST (optional)
inscricaoMunicipal (optional)
logradouro (optional)
numeroEndereco (optional)
pais (optional)
razaoSocial (optional)
telefone (optional)
uf (optional)
cpfCnpjTransportador (optional)
enderecoTransportador (optional)
ieTransportador (optional)
nomeMunicipioTransportador (optional)
nomeTransportador (optional)
ufTransportador (optional)
Objeto que representa os dados de melhor desconto para a produto
codigoBarras (optional)
Long Código de barras do produto format: int64
example: 7891234567890
codigoCondicaoPagamento (optional)
String Código da condição de pagamento do desconto aplicado
example: 7
codigoLaboratorio (optional)
Integer Código identificador do laboratório format: int32
example: 678
codigoProduto (optional)
Integer Código identificador do produto format: int32
example: 12345
nomeCondicaoPagamento (optional)
String Nome da condição de pagamento do desconto aplicado
example: CARTAO
nomeDesconto (optional)
String Nome do desconto aplicado
example: CADPRODU
nomeLaboratorio (optional)
String Nome do laboratório fabricante
example: Laboratório Genérico S.A.
nomeProduto (optional)
example: Dipirona 500mg
percentualDesconto (optional)
Double Percentual de desconto aplicado format: double
example: 15.0
quantidade (optional)
Integer Quantidade do produto format: int32
example: 150
quantidadeEstoque (optional)
Integer Quantidade disponível em estoque format: int32
example: 150
valorVenda (optional)
Double Valor de venda do produto format: double
example: 19.9
Objeto utilizado para consultar o melhor desconto.
considerarTodasCondicoesPagamento (optional)
String Considerar todas as condições de pagamento
example: S
identificadorCliente (optional)
String Identificador do Cliente (cartão, CPF ou CNPJ)
example: 111.111.111-11
produtos
ambiente (optional)
codAplicacao (optional)
deveDestacarIcmsStEmCampoProprio (optional)
deveDestacarIpiEmCampoProprio (optional)
notaEmitida (optional)
nt2025002Vigente (optional)
numeroLote (optional)
numeroNSU (optional)
numeroSerie (optional)
numeroUltimaNota (optional)
proximoLote (optional)
tipoRegime (optional)
SIMPLES_NACIONAL
SIMPLES_NACIONAL_EXEC
NORMAL
SIMPLES_NACIONAL_MEI
tipoRegimeFornec (optional)
SIMPLES_NACIONAL
SIMPLES_NACIONAL_EXEC
NORMAL
SIMPLES_NACIONAL_MEI
venda (optional)
chave (optional)
nitem (optional)
Objeto utilizado para informar a forma de pagamento DINHEIRO em uma venda e-commerce no PDV
valor
Double Valor pago em dinheiro format: double
example: 100.0
Objeto utilizado para a emitir uma nota fiscal de uma venda e-commerce no PDV
numeroNota
Integer Número da venda gerada no PDV format: int32
example: 12345
numeroPedido
String Número do pedido no e-commerce
example: PED-20240001
Objeto utilizado para retornar dados da emissão de uma nota fiscal de uma venda e-commerce no PDV
chaveNotaFiscal (optional)
String Chave da nota fiscal eletrônica
example: 12345678901234567890123456789012345678901234
codigoRetorno (optional)
example: 200
descricaoRetorno (optional)
String Descrição detalhada do retorno
example: Nota fiscal emitida com sucesso
modeloNotaFiscal (optional)
example: 55
numeroNota (optional)
Integer Número da venda gerada no PDV format: int32
example: 12345
numeroNotaFiscal (optional)
Integer Número da nota fiscal format: int32
example: 67890
numeroPedido (optional)
String Número do pedido no e-commerce vinculado à venda
example: PED-20240001
numeroSequencial (optional)
Integer Número sequencial da emissão format: int32
example: 1
serieNotaFiscal (optional)
example: A1
tipoRetorno (optional)
example: Sucesso
Objeto utilizado para informar o endereço de entregra de uma venda e-commerce no PDV
bairro
example: Centro
cep (optional)
example: 12345678
cidade
example: São Paulo
complemento (optional)
example: Apto 101
estado
example: SP
logradouro
example: Rua das Flores
numero (optional)
example: 123
referencia (optional)
example: Ao lado do mercado público
aliquota (optional)
aliquotaEfetiva (optional)
percentualDiferimento (optional)
percentualReducaoAliquota (optional)
valor (optional)
valorDiferimento (optional)
aliquotaEfetivaRegularCbs (optional)
aliquotaEfetivaRegularIbsMun (optional)
aliquotaEfetivaRegularIbsUf (optional)
baseCalculo (optional)
cbs (optional)
classificacaoTributaria (optional)
classificacaoTributariaRegular (optional)
cst (optional)
cstRegular (optional)
doacao (optional)
ibsMun (optional)
ibsUf (optional)
valorItem (optional)
valorRegularCbs (optional)
valorRegularIbsMun (optional)
valorRegularIbsUf (optional)
dados (optional)
tabela (optional)
bas_cofins (optional)
bas_fcp (optional)
bas_fcpst (optional)
bas_icms (optional)
bas_ipi (optional)
bas_pis (optional)
bas_substrib (optional)
cod_barra (optional)
cod_filial (optional)
cod_modelo (optional)
cod_natureza (optional)
cod_origem (optional)
cod_produto (optional)
cod_rede (optional)
cod_reduzido (optional)
cod_tribut (optional)
deveSubtrairIcmsDesonerado (optional)
deveSubtrairIcmsStDesonerado (optional)
ficticio (optional)
indDeduzDeson (optional)
medicamento (optional)
nom_produto (optional)
num_nota (optional)
num_sequencial (optional)
obs_livre_contribuinte_conteudo (optional)
obs_livre_contribuinte_id (optional)
obs_livre_fisco_conteudo (optional)
obs_livre_fisco_id (optional)
prc_cofins (optional)
prc_descto (optional)
prc_diferimento (optional)
prc_fcp (optional)
prc_fcpst (optional)
prc_icms (optional)
prc_icms_st_retido (optional)
prc_icmsefet (optional)
prc_icmsst (optional)
prc_ipi (optional)
prc_margemst (optional)
prc_pis (optional)
prc_red_base_icms_efetivo (optional)
prc_redicms (optional)
prc_redicmsst (optional)
qtd_produto (optional)
rastro (optional)
ser_nota (optional)
sit_cofins (optional)
sit_ipi (optional)
sit_pis (optional)
vlr_base_icms_efetivo (optional)
vlr_base_icms_st_retido (optional)
vlr_cofins (optional)
vlr_descto (optional)
vlr_despacess (optional)
vlr_diferimento (optional)
vlr_fcp (optional)
vlr_fcpst (optional)
vlr_frete (optional)
vlr_icms (optional)
vlr_icms_efetivo (optional)
vlr_icms_op (optional)
vlr_icms_st_deson (optional)
vlr_icms_st_retido (optional)
vlr_icms_substituto (optional)
vlr_icmsdeson (optional)
vlr_ipi (optional)
vlr_pis (optional)
vlr_racrearred (optional)
vlr_rtdescarred (optional)
vlr_seguro (optional)
vlr_substrib (optional)
vlr_total (optional)
vlr_unitario (optional)
baseCalculoCofins (optional)
baseCalculoFcp (optional)
baseCalculoFcpST (optional)
baseCalculoIcms (optional)
baseCalculoIcmsST (optional)
baseCalculoIpi (optional)
baseCalculoPis (optional)
codBenef (optional)
codCest (optional)
codigoBarra (optional)
codigoFilial (optional)
codigoNatureza (optional)
codigoOrigem (optional)
codigoProduto (optional)
codigoRede (optional)
codigoTributario (optional)
descricaoProduto (optional)
deveSubtrairIcmsDesonerado (optional)
deveSubtrairIcmsStDesonerado (optional)
dfeReferenciado (optional)
ibsCbsProduto (optional)
ncm (optional)
nt2023004Vigente (optional)
numeroSequencial (optional)
obsLivreContribuinteConteudo (optional)
obsLivreContribuinteId (optional)
obsLivreFiscoConteudo (optional)
obsLivreFiscoId (optional)
percentualCalculoIpi (optional)
percentualCofins (optional)
percentualDesconto (optional)
percentualDiferimento (optional)
percentualFcp (optional)
percentualFcpST (optional)
percentualIcms (optional)
percentualIcmsEfetivo (optional)
percentualIcmsST (optional)
percentualMargemSt (optional)
percentualPis (optional)
percentualReducaoIcms (optional)
percentualReducaoIcmsSt (optional)
prcIcmsStRetido (optional)
quantidade (optional)
situacaoIpi (optional)
unidade (optional)
valorCofins (optional)
valorDesconto (optional)
valorDespesaAcessoria (optional)
valorDiferimento (optional)
valorFcp (optional)
valorFcpSt (optional)
valorFrete (optional)
valorIcms (optional)
valorIcmsDesonerado (optional)
valorIcmsOperacao (optional)
valorIcmsSt (optional)
valorIcmsStDesonerado (optional)
valorIpi (optional)
valorItem (optional)
valorPis (optional)
valorRateioAcrescimoArredondamento (optional)
valorRateioDescontoArredondamento (optional)
valorSeguro (optional)
valorTotal (optional)
valorUnitario (optional)
vlrBaseIcmsStRetido (optional)
vlrICMSSubstituto (optional)
vlrIcmsStRetido (optional)
getvPMC (optional)
numRegms (optional)
cod_filial (optional)
cod_fornec (optional)
cod_modelo (optional)
cod_rede (optional)
cod_statusnfe (optional)
cod_transp (optional)
dat_emissao (optional)
dat_notaentra (optional)
dat_saient (optional)
deveDestacarIcmsStEmCampoProprio (optional)
flg_cancelado (optional)
flg_devol (optional)
hor_emissao (optional)
itens (optional)
min_emissao (optional)
nom_chavenfe (optional)
nom_obsnf (optional)
num_controleent (optional)
num_nf (optional)
num_nfficticia (optional)
num_notaentra (optional)
num_protocoloenv (optional)
num_seqcadinfis (optional)
num_seqnfe (optional)
num_ultlotenfe (optional)
qtd_parcelas (optional)
seg_emissao (optional)
ser_nota (optional)
tip_ambiente (optional)
tip_condpagto (optional)
tip_frete (optional)
tip_operacao (optional)
tip_origem (optional)
tip_saida (optional)
tip_venda (optional)
tot_bruto (optional)
tot_nota (optional)
vlr_acrescarred (optional)
vlr_desconto (optional)
vlr_icmsdeson (optional)
chaveNfe (optional)
cnpj (optional)
cpf (optional)
dataEmissao (optional)
devolucaoTotal (optional)
estado (optional)
inscricaoEstadual (optional)
modelo (optional)
numero (optional)
serie (optional)
tipoNota (optional)
Objeto utilizado para informar as formas de pagamento de uma venda e-commerce no PDV
cartao (optional)
crediario (optional)
dinheiro (optional)
pix (optional)
Objeto utilizado para informar a forma de pagamento PIX em uma venda e-commerce no PDV
codigo
Integer Código do tipo de pagamento PIX (Cartão) format: int32
example: 5
idTransacaoPIX (optional)
example: 1234567890
numeroAutorizacao (optional)
Integer Número da autorização format: int32
example: 1234567890
valor
Double Valor pago no PIX format: double
example: 100.0
Item para consultar o melhor desconto
codigoProduto
Integer Código do produto format: int32
example: 12345
quantidade
Integer Quantidade do produto format: int32
example: 1
getcAgreg (optional)
getdFab (optional)
getdVal (optional)
getnLote (optional)
getqLote (optional)
Status do pedido
codigo (optional)
String Código do status do pedido
descricao (optional)
String Descrição do status do pedido
Objeto utilizado para retornar o status de uma venda e-commerce no PDV
dataPedido (optional)
Date Data do pedido no e-commerce format: date-time
numeroCupomFiscal (optional)
Integer Número do cupom fiscal format: int32
numeroNota (optional)
Integer Número da venda gerada no PDV format: int32
example: 12345
numeroNotaFiscal (optional)
Integer Número da nota fiscal format: int32
numeroPedido (optional)
String Número do pedido no e-commerce vinculado à venda
example: PED-20240001
statusPedido (optional)
xmlNfe (optional)
String XML da nota fiscal eletrônica
aliquotaFcpst (optional)
baseCalculoFcp (optional)
baseCalculoFcpst (optional)
codigoControle (optional)
codigoFilial (optional)
codigoFornecedor (optional)
codigoRede (optional)
codigoTransportadora (optional)
dadosDestinatario (optional)
dadosDestinatarioCreditoProprio (optional)
dadosEmitente (optional)
dadosTransporte (optional)
dataSaida (optional)
informacoesAdicionais (optional)
itens (optional)
notaOrigem (optional)
quantidadeParcelas (optional)
somarSTOutrasDespesasAcessorias (optional)
tipoCondicaoPagamento (optional)
tipoFrete (optional)
tipoImpressao (optional)
valorAcrescimoArredondamento (optional)
valorBruto (optional)
valorFcp (optional)
valorFcpst (optional)
valorMercadoria (optional)
valorTotal (optional)
valorTotalICMS (optional)
valorTotalICMSDesonerado (optional)
valorTotalICMSST (optional)
valorTotalICMSStDesonerado (optional)
Objeto utilizado para finalizar uma venda e-commerce no PDV
numeroNota
Integer Número da venda gerada no PDV format: int32
example: 12345
numeroPedido
String Número do pedido no e-commerce vinculado à venda
example: PED-123456
pagamentoMultiplo (optional)
Objeto utilizado para gerar uma venda e-commerce no PDV
cliente (optional)
dataPedido
String Data do pedido no e-commerce format: yyyy-MM-dd'T'HH:mm:ssZ
example: 2020-01-01T23:59:59-0300
enderecoEntrega (optional)
entrega (optional)
Boolean Indica se é uma venda Tele-Entrega ou não
example: true
numeroNota (optional)
Integer Número da venda gerada no PDV (somente quando originado de um DAV) format: int32
example: 98143
numeroPedido
String Número do pedido no e-commerce que será vinculado à venda
example: PED-20240001
pagamentoMultiplo (optional)
produtos (optional)
valorFrete (optional)
Double Valor do frete do pedido format: double
example: 10.0
valorTotalVenda
Double Valor total do pedido, que será utilizado como total da venda format: double
example: 100.0
vendedor (optional)
Objeto utilizado para retornar dados da geração ou finalização de uma venda e-commerce no PDV
numeroNota (optional)
Integer Número da venda gerada no PDV format: int32
example: 12345
numeroPedido (optional)
String Número do pedido no e-commerce vinculado à venda
example: PED-20240001
statusPedido (optional)
Item da venda e-commerce no PDV
codigoProduto
Integer Código do produto format: int32
example: 12345
nomeDesconto (optional)
example: CADPRODU
nomeProduto (optional)
example: Produto Exemplo
numeroSequencial (optional)
Integer Número sequencial (somente quando originado de um DAV) format: int32
example: 1
quantidade
Integer Quantidade do produto format: int32
example: 2
valorDesconto (optional)
Double Valor unitário do desconto aplicado ao produto format: double
example: 0.5
valorUnitario
Double Valor unitário do produto format: double
example: 50.0
Objeto utilizado para informar o vendedor de uma venda e-commerce no PDV
codigo (optional)
Integer Código do vendedor format: int32
example: 123
nome (optional)
example: Maria