ObjetivoPOST {urlbase}:{porta}/smpedidovendaapi/api/v1/PedidoVenda
Endpoint responsável por receber, validar e persistir pedidos de venda.
Request Information
POST: [urlBase]:[porta]/smpedidovenda/smpedidovendaapi/api/v1/PedidoVenda
URI Parameters
Não há.
Header Parameters / Autorização (Validar se utilizará Header ou Autorização)
Token
EXEMPLO DO CORPO DA REQUISIÇÃO
| Bloco de código |
|---|
|
{
"seqCanalVenda":21,
"idPedidoCanalVenda": "68",
"dtaHorPedidoCanalVenda": "2022-08-09T09:59:06.149Z",
"nroEmpresa": 1,
"codGeralOper": 518,
"nroRepresentante": 1,
"nroTabVenda": "1",
"seqTransportador": 0,
"tipoEntrega": "E",
"obsPedido": "TESTE POST PEDIDO",
"obsNotaFiscal": "TESTE API PEDIDO",
"vlrTotFrete": 5.00,
"tipoRateioFretePedido": "V",
"tipoFreteDocAuxiliar": 0,
"indIntermediador": "N",
"clienteDto": {
"cpfCnpj": "99999999999",
"inscEstadualRg": "123456789",
"nomeRazaoSocial": "Matheus",
"nomeFantasia": "Matheus",
"sexo": "M",
"cidade": "Ribeirão Preto",
"uf": "SP",
"pais": "BRASIL",
"bairro": "Jardim",
"logradouro": "Rotatória",
"nroLogradouro": "999",
"complementoLogradouro": "TEST 1",
"cep": "14079077",
"foneDdd1": "16",
"foneNro1": "38800263",
"dtaNascFund": "1987-06-13T13:34:15",
"email": "[email protected]",
"emailNfe": "[email protected]",
"estadoCivil": "S",
"inscMunicipal": "",
"inscProdutor": "",
"indContribIcms": "N",
"fisicaJuridica": "F"
},
"itemDto": [
{
"codAcesso": "17",
"seqProduto": 21,
"qtdPedida": 10,
"qtdEmbalagem": 1,
"vlrEmbTabPreco": 5.00,
"vlrEmbInformado": 4.59,
"vlrEmbTabPromoc": 0,
"vlrEmbDesconto": 0.41,
"observacaoItem": "PRODUTO TESTE",
"qtdVolume": 0,
"indSimilarEcommerce": "N",
"indKit": "N",
"vlrTotComissao": 0,
"fatorMultiplicador": 0,
"seqItemCanalVenda": 0
}
],
"pagamentoDto": [
{
"nroFormaPagto": 6,
"nroCondPagto": 30,
"valorPagto": 45.90,
"nroGiftCard": 0,
"nroParcela": 0,
"cpfCnpjCartao": "99999999999",
"cnpjInstituicaoPagto": "",
"idCarteira": "1",
"tipoCarteira": "01",
"idPagtoCanalVenda": "1",
"nsuDto": {
"nsu": "123456789000",
"nroCartao": "5180#########8115",
"codRede": "125",
"codBandeira": "1",
"codBin": "123",
"nroAutorizacao": "123"
}
}
]
} |
PARÂMETROS DO CORPO
Nome |
|---|
seqCanalVenda Inteiro Obrigatório Sequencial do Canal de Venda. Manutenção de Canal de Venda |
idPedidoCanalVenda Texto Obrigatório Identificação do Pedido no Canal de Venda. O IdPedidoCanalVenda possui um tamanho máximo de 60 caracteres. Essa numeração poderá ser utilizada no ERP como "Ped Cliente" na pesquisa do pedido de venda (F7) para buscas. |
dtaHorPedidoCanalVenda DataHora Data/Hora que o Pedido de Venda terá ao ser criado. Formato esperado: "YYYY-MM-DDTHH:MM:SS". Caso não seja informado, o sistema utilizará a data e hora atual para integração com o ERP. |
nroEmpresa Numérico Obrigatório |
nroEmpresa inteiro obrigatórioNúmero identificador da empresa no ERP, identifica em qual empresa o pedido será integrado. |
Campo com limite de 6 caracteres
| clienteDto | cpfCnpj string obrigatório CPF/CNPJ do Cliente |
pagamentoDto.nsuDto | nroCartao string Número do cartão utilizado no pagamento pedido |
Body Parameters
...
Dto
...
Nome
...
seqCanalVenda tipo obrigatório
Sequencial do Canal de Venda
...
idPedidoCanalVenda tipo
Identificação do Pedido de Venda
...
dtaHorPedidoCanalVenda tipo
Data/Hora do Pedido de Venda
O valor máximo permitido para a Empresa é de 999999. |
nroSegmento Numérico Número identificador do Segmento no ERP, identifica em qual segmento o pedido será integrado. O valor máximo permitido para o Segmento é de 999999. Caso não seja informado, o sistema utilizará como padrão o segmento informado no cadastro do Canal de Venda. |
codGeralOper Numérico Número identificador do Código Geral de Operação no ERP, identifica em qual CGO o pedido será integrado. O valor máximo permitido para o Código Geral Operação é de 999999. Caso não seja informado, o sistema utilizará como padrão o código geral de operação informado no cadastro do Canal de Venda. |
nroRepresentante Numérico Número identificador do representante no ERP, identifica qual Representante efetuou o pedido. O tamanho máximo permitido para o Representante é de 99999. Caso não seja informado, o sistema utilizará como padrão o representante informado no cadastro do Canal de Venda. |
nroTabVenda Texto Número identificador da tabela de Venda do ERP, identifica em qual Tabela de Venda o pedido será integrado. O Número da Tabela de Venda possui um tamanho máximo de 3 caracteres. Caso não seja informado, o sistema utilizará como padrão a tabela de venda informada no cadastro do Canal de Venda. |
seqTransportador Numérico Identificador do Transportador, identifica qual Transportador estará responsável pelo pedido. O valor máximo permitido para o Transportador é de 999999999999999999. |
tipoEntrega Texto Obrigatório Sigla de identificação da Entrega ou Retirada do Pedido. O valor da propriedade TipoEntrega aceita apenas os valores: - 'E' (Entrega)
- 'R' (Retira)
|
obsPedido Texto Campo responsável por receber a Observação do Pedido.
A ObsPedido possui um tamanho máximo de 240 caracteres. |
obsNotaFiscal Texto Campo responsável por receber a Observação da Nota Fiscal. A ObsNotaFiscal possui um tamanho máximo de 500 caracteres. |
vlrTotFrete Decimal Campo responsável por receber o Valor Total do Frete. O valor máximo permitido para o Valor Total do Frete é de 9999999999.9999. |
tipoRateioFretePedido Texto Sigla de identificação do Tipo de Rateio do Frete, seja ele 'V', 'P', 'O' ou 'T'. O valor da propriedade TipoRateioFretePedido aceita apenas os valores: - 'V' (Valor)
- 'P' (Peso Bruto)
- 'O' (Volume)
- 'T' (Conforme cálculo do frete do transportador no pedido de venda)
|
tipoFreteDocAuxiliar Inteiro Campo responsável por receber o Tipo de Documento Auxiliar do Frete. O valor da propriedade TipoFreteDocAuxiliar aceita apenas os valores: - 0 (Contratação do Frete por conta do Remetente (CIF))
- 1 (Contratação do Frete por conta do Destinatário (FOB))
- 2 (Contratação do Frete por conta de Terceiros)
- 3 (Transporte Próprio por conta do Remetente)
- 4 (Transporte Próprio por conta do Destinatário)
- 9 (Sem Ocorrência de Transporte)
|
indIntermediador Texto Sigla de identificação do Intermediador. O valor da propriedade IndIntermediador aceita apenas os valores: |
Object clienteDto Obrigatório Dados do cliente do pedido de venda | Expandir |
|---|
| title | Clique para expandir |
|---|
| | Nome |
|---|
cpfCnpj Texto Obrigatório Campo responsável por receber os dados de CPF/CNPJ do Cliente. O valor da propriedade CpfCnpj possui o tamanho máximo de 14 caracteres. | inscEstadualRg texto Registro formal das empresas perante a Receita Estadual, sendo utilizada para a fiscalização e recolhimento do ICMS – Imposto de Circulação de Mercadorias e Serviços (Inscrição Estadual). O valor da propriedade InscEstadualRg possui o tamanho máximo de 60 caracteres. | nomeRazaoSocial Texto Obrigatório Campo responsável por receber a Razão Social. O valor da propriedade NomeRazaoSocial possui o tamanho máximo de 100 caracteres. | nomeFantasia Texto Campo responsável por receber o Nome Fantasia. O valor da propriedade NomeFantasia possui o tamanho máximo de 30 caracteres. | sexo Texto Sigla de identificação por receber o gênero do Cliente. O valor da propriedade Sexo aceita apenas os valores: - 'M' (Masculino)
- 'F' (Feminino)
- 'O' (Outros)
| cidade Texto Obrigatório Campo responsável por receber Nome da Cidade do Cliente. O valor da propriedade Cidade possui o tamanho máximo de 30 caracteres. | uf Texto Obrigatório Campo responsável por receber o Estado do Cliente. O valor da propriedade Uf possui o tamanho máximo de 2 caracteres. | pais Texto Campo responsável por receber o País do Cliente. O valor da propriedade Pais possui o tamanho máximo de 25 caracteres. | bairro Texto Obrigatório Campo responsável por receber o Bairro do Cliente. O valor da propriedade Bairro possui o tamanho máximo de 30 caracteres. | logradouro Texto Campo responsável por receber o Logradouro do Cliente. O valor da propriedade Logradouro possui o tamanho máximo de 35 caracteres. | nroLogradouro Texto Campo responsável por receber o número do Logradouro do Cliente. O valor da propriedade NroLogradouro possui o tamanho máximo de 10 caracteres. | complementoLogradouro Texto Campo responsável por receber o Complemento do Logradouro do Cliente. O valor da propriedade ComplementoLogradouro possui o tamanho máximo de 60 caracteres. | cep Texto Campo responsável por receber o Código Postal (CEP). O valor da propriedade Cep possui o tamanho máximo de 12 caracteres. | foneDdd1 Texto Número do DDD. O valor da propriedade FoneDdd1 possui o tamanho máximo de 5 caracteres. | foneNro1 Texto Campo responsável por receber o Número do Telefone do Cliente. O valor da propriedade FoneNro1 possui o tamanho máximo de 12 caracteres. | dtaNascFund DataHora Campo responsável por receber Data de Nascimento/Fundação do Cliente. Formato esperado: "YYYY-MM-DDTHH:MM:SS". | email Texto Campo responsável por receber o e-mail do cliente. O valor da propriedade Email possui o tamanho máximo de 50 caracteres. | emailNfe Texto Campo responsável por receber e-mail para entrega de Nota Fiscal. O valor da propriedade EmailNfe possui o tamanho máximo de 50 caracteres. | estadoCivil Texto Sigla de identificação do Estado Civil do Cliente. O valor da propriedade EstadoCivil aceita apenas os valores: - 'S' (Solteiro)
- 'C' (Casado)
- 'V' (Viúvo)
- 'Q' (Desquitado)
- 'D' (Divorciado)
- 'A' (Amasiado)
- 'P' (Separado)
- 'O' (Outros)
| inscMunicipal Texto Campo responsável por receber a Inscrição Municipal do Cliente. O valor da propriedade InscMunicipal possui o tamanho máximo de 15 caracteres. | inscProdutor Texto Campo responsável por receber a Inscrição de Produtor do Cliente. O valor da propriedade InscProdutor possui o tamanho máximo de 15 caracteres. | indContribIcms Texto Sigla de identificação da Contribuição de ICMS. O valor da propriedade IndContribIcms aceita apenas os valores: | fisicaJuridica Texto Sigla de identificação se o cliente é Pessoa Física ou Jurídica. O valor da propriedade FisicaJuridica aceita apenas os valores: - 'F' (Pessoa Física)
- 'J' (Pessoa Jurídica)
|
|
|
Objeto itemDto Obrigatório Coleção de dados dos itens do pedido de venda | Expandir |
|---|
| title | Clique para expandir... |
|---|
| | Nomes |
|---|
codAcesso Texto O valor da propriedade CodAcesso possui o tamanho máximo de 14 caracteres. | seqProduto Inteiro Obrigatório Sequencial identificador do Produto no ERP. | qtdPedida Decimal Obrigatório Campo responsável por receber a Quantidade Pedida do produto. O valor máximo permitido para a Quantidade Pedida é de 99999999.999. O valor informado deve ser o da quantidade unitária total, pois o mesmo será dividido pela embalagem na importação. Exemplo: - Está sendo integrado 1 fardo com 6 un de refrigerante. Deve-se mandar qtdPedida = 6 e qtdEmbalagem = 6.
- Está sendo integrado 6 unidades de refrigerante. Deve-se mandar qtdPedida = 6 e qtdEmbalagem = 1.
| qtdEmbalagem Decimal Obrigatório Campo responsável por identificar a Quantidade da Embalagem do produto. O valor máximo permitido para a Quantidade da Embalagem é de 99999.999999. | vlrEmbTabPreco Decimal Obrigatório Campo responsável por receber o Valor da Embalagem na Tabela de Preço. O valor máximo permitido para o Valor da Embalagem na Tabela de Preço é de 9999999999.99. | vlrEmbInformado Decimal Obrigatório Campo responsável por receber o Valor da Embalagem informada para o produto no pedido. O valor máximo permitido para o Valor da Embalagem informada é de 9999999999.999999. | vlrEmbTabPromoc Decimal Campo responsável por receber o Valor da Embalagem na Tabela Promocional. O valor máximo permitido para a o Valor da Embalagem na Tabela Promocional é de 9999999999.99. | vlrEmbDesconto Decimal Campo responsável por receber o Valor de Desconto da Embalagem. O valor máximo permitido para o Valor de Desconto da Embalagem é de 9999999999.99. | observacaoItem Texto Campo responsável por receber a Observação do item no pedido. O valor da propriedade ObservacaoItem possui o tamanho máximo de 250 caracteres. | qtdVolume Decimal Campo responsável por receber a Quantidade de Volume do Item no pedido. O valor máximo permitido para a Quantidade de Volume é de 99999.999999. | indSimilarEcommerce Texto Campo responsável por receber a Identificação de Pedido Similar ao e-commerce. O valor da propriedade IndSimilarEcommerce aceita apenas os valores: | indKit Texto Campo responsável por receber o Identificador de Kit no produto. O valor da propriedade IndKit aceita apenas os valores: | vlrTotComissao Decimal Campo responsável por receber o Valor Total da Comissão. O valor máximo permitido para o Valor Total da Comissão é de 9999999999.9999. | fatorMultiplicador Decimal Campo responsável por receber o Fator Multiplicador do produto. O valor máximo permitido para o Fator Multiplicador é de 9999999999.9999. | seqItemCanalVenda Inteiro Campo responsável por receber o Sequencial do Item no Canal de Venda. |
|
|
Objeto pagamentoDto Obrigatório Coleção de dados dos pagamentos do pedido de venda | Informações |
|---|
| Atualmente, nossa API de Pedidos permite a realização de pedidos de venda com múltiplos pagamentos, contanto que os DTOs de pagamento transmitam o mesmo número de formas de pagamento no ERP. Em outras palavras, um pedido pode ser dividido em dois ou mais pagamentos, como por exemplo, utilizando dois cartões de crédito com prazos e parcelamentos diferentes, desde que a forma de pagamento seja a mesma para ambos. |
| Expandir |
|---|
| title | Clique para expandir... |
|---|
| | Nomes |
|---|
nroFormaPagto Numérico Obrigatório Número da Forma de Pagamento do pedido. O valor da propriedade NroFormaPagto possui o valor máximo permitido de 99999.
| nroCondPagto Numérico Obrigatório Número da Condição de Pagamento do pedido. O valor da propriedade NroCondPagto possui o valor máximo permitido de 999. | valorPagto Decimal Obrigatório Valor do Pagamento. O valor da propriedade ValorPagto aceita apenas valores entre 0.01 e 9999999999.99. | nroGiftCard Numérico Número do Gift Card. O valor da propriedade NroGiftCard possui o valor máximo permitido de 999999999999999. | nroParcela Numérico Número de Parcelas. O valor da propriedade NroParcela possui o valor máximo permitido de 999999999999999. | cpfCnpjCartao Texto CPF/CNPJ do Proprietário do Cartão. O valor da propriedade CpfCnpjCartao possui o tamanho máximo de 14 caracteres. | cnpjInstituicaoPagto Texto CNPJ da Instituição de Pagamento. O valor da propriedade CnpjInstituicaoPagto possui o tamanho máximo de 15 caracteres. | idCarteira Texto Identificação da Carteira. O valor da propriedade IdCarteira possui o tamanho máximo de 8 caracteres. | tipoCarteira Texto Tipo de carteira. O valor da propriedade TipoCarteira possui o tamanho máximo de 2 caracteres. | idPagtoCanalVenda Texto Identificação do Pagamento do canal de venda. O valor da propriedade IdPagtoCanalVenda possui o tamanho máximo de 60 caracteres. Este campo deverá ser informado se a forma de pagamento for do tipo Cartão de Crédito e precise informar os dados complementares do cartão em um segundo momento. Por exemplo, se no momento da integração do pedido você não possua os dados de NSU. Nesse caso é necessário preencher um idPagtoCanalVenda de sua escolha referente ao pagamento, e esta mesma informação deverá ser utilizada posteriormente no endpoint específico para inclusão dos dados do NSU: POST - Nsu. | Objeto nsuDto Coleção de dados complementares de cartões do pedido de venda | Expandir |
|---|
| title | Clique para expandir... |
|---|
| | Nomes |
|---|
nsu Texto Obrigatório NSU é a sigla para Número Sequencial Único. É um número único gerado para identificar uma transação ou uma nota fiscal. O valor da propriedade Nsu possui o tamanho máximo de 50 caracteres. | nroCartao Texto Obrigatório Número do cartão utilizado no pagamento. O valor da propriedade NroCartao possui o tamanho máximo de 20 caracteres. | codRede Texto Código da rede utilizada no pagamento. O valor da propriedade CodRede possui o tamanho máximo de 12 caracteres. | codBandeira Texto Código da bandeira utilizada no pagamento. O valor da propriedade CodBandeira possui o tamanho máximo de 12 caracteres. | codBin Texto Código BIN é o Número de Identificação Bancária (na sigla em inglês) e corresponde aos 6 primeiros dígitos de um cartão de crédito. O valor da propriedade CodBin possui o tamanho máximo de 12 caracteres. | nroAutorizacao Texto Código que é gerado a partir de cinco ou seis números por um banco emissor, o código usado para validar um cartão de crédito e aprová-lo quando uma compra ou venda é feita. O valor da propriedade NroAutorizacao possui o tamanho máximo de 15 caracteres. |
|
|
|
|
| Dica |
|---|
|
| Bloco de código |
|---|
{
"seqPedido": 422,
"seqCanalVenda": 21,
"idPedidoCanalVenda": "68",
"dtaHorPedidoCanalVenda": "2022-08-09T09:59:06.149Z",
"nroEmpresa": 1,
"nroSegmento": 1,
"codGeralOper": 518,
"nroRepresentante": 1,
"nroTabVenda": "1"
} |
|
| Aviso |
|---|
|
| Bloco de código |
|---|
{
"code": "Zvpebfbsg.NfcArgPber.Zip.GasPbagebyyre+Reebe.2",
"message": "Erro ao salvar 'PedidoVenda'",
"detailedMessage": "AspNetCoreOnPostError",
"helpUrl": "",
"details": [
{
"guid": "be5f6a5c-1116-46fa-9d9f-d7f4b696ba27",
"code": "400",
"message": "Mensagem de erro.",
"detailedMessage": "Fetalhe"
}
]
} |
|
INSTALAÇÃO
Para instalação do módulo de API Pedido de Venda deve ser feito via PublicaWeb > ConsincoWeb
Pacote: Comercial Pedido de Venda API
Versão a partir de: 23.01.001
...
nroEmpresa tipo
Número da Empresa
...
nroSegmento tipo
Número do Segmento
...
codGeralOper tipo
Código Geral da Operação
...
nroRepresentante tipo
Número do Representante
...
nroTabVenda tipo
Número da Tabela de Venda
...
seqTransportador tipo
Sequencial do Transportador
...
tipoEntrega tipo
Tipo de Entrega
...
obsPedido tipo
Observação do Pedido
...
obsNotaFiscal tipo
Observação da Nota Fiscal
...
vlrTotFrete tipo
Valor total do Frete
...
tipoRateioFretePedido tipo
Tipo de Rateio do Frete do Pedido
...
tipoFreteDocAuxiliar tipo
Tipo de Frete/Documento Auxiliar
...
indIntermediador tipo
Identificador do Intermediador
...
clienteDto - Dados do cliente
...
cpfCnpj tipo
CPF/CNPJ do Cliente
...
inscEstadualRg tipo
Inscrição Estadual
...
nomeRazaoSocial tipo
Razão Social
...
nomeFantasia tipo
Nome Fantasia
...
sexo tipo
Gênero
...
cidade tipo
Nome da Cidade
...
uf tipo
Estado
...
pais tipo
País
...
bairro tipo
Bairro
...
logradouro tipo
Logradouro
...
nroLogradouro tipo
Número do Logradouro
...
complementoLogradouro tipo
Complemento do Logradouro
...
cep tipo
Código Postal (CEP)
...
foneDdd1 tipo
Número do DDD
...
foneNro1 tipo
Número do Telefone
...
dtaNascFund tipo
Data de Nascimento/Fundação
...
email tipo
E-mail
...
emailNfe tipo
E-mail para entrega de Nota Fiscal
...
estadoCivil tipo
Estado Civil
...
inscMunicipal tipo
Inscrição Municipal
...
inscProdutor tipo
Inscrição de Produtor
...
indContribIcms tipo
Identificador de Contribuição de ICMS
...
fisicaJuridica tipo
Pessoa Física/Jurídica
...
expandables
...
itemDto - Itens do pedido
...
codAcesso tipo
...
seqProduto tipo
Sequencial do Produto
...
qtdPedida tipo
Quantidade Pedida
...
qtdEmbalagem tipo
Quantidade da Embalagem
...
vlrEmbTabPreco tipo
Valor da Embalagem na Tabela de Preço
...
vlrEmbInformado tipo
Valor da Embalagem Informado
...
vlrEmbTabPromoc tipo
Valor da Embalagem na Tabela Promocional
...
vlrEmbDesconto tipo
Valor de desconto da Embalagem
...
observacaoItem tipo
Observação do item
...
qtdVolume tipo
Quantidade de Volume do Item
...
indSimilarEcommerce tipo
Identificação de Pedido Similar ao Ecommerce
...
indKit tipo
Identificador de Kit
...
vlrTotComissao tipo
Valor Total da Comissão
...
fatorMultiplicador tipo
Fator multiplicador
...
seqItemCanalVenda tipo
Sequencial do Item no Canal de Venda
...
expandables
...
pagamentoDto - Dados do pagamento do pedido
...
nroFormaPagto tipo
Número Forma de Pagamento
...
nroCondPagto tipo
Número Condição de Pagamento
...
valorPagto tipo
Valor do Pagamento
...
nroGiftCard tipo
Número do Gift Card
...
nroParcela tipo
Número de Parcelas
...
cpfCnpjCartao tipo
CPF/CNPJ do Proprietário do Cartão
...
cnpjInstituicaoPagto tipo
CNPJ da Instituição de Pagamento
...
idCarteira tipo
Identificação da Carteira
...
tipoCarteira tipo
Tipo de carteira
...
idPagtoCanalVenda tipo
Identificação do Pagamento do canal de venda
...
expandables
...
pagamentoDto.nsuDto - Dados complementares ao pagamento de cartão de crédito
...