Histórico da Página
POST {urlbase}:{porta}/smpedidovenda/smpedidovendaapi/api/v1/pedidovendaPedidoVenda
Endpoint responsável por receber, validar e persistir pedidos de venda.
| Índice |
|---|
EXEMPLO DO CORPO DA REQUISIÇÃO
| Bloco de código | ||
|---|---|---|
| ||
{
"seqCanalVenda":121,
"idPedidoCanalVenda": "12368",
"dtaHorPedidoCanalVenda": "2022-1008-13T1309T09:3459:1506.149Z",
"nroEmpresa": 1,
"codGeralOper": 999518,
"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": "2813221589399999999999",
"inscEstadualRg": "155734544123456789",
"nomeRazaoSocial": "Matheus Márcio da Luz",
"nomeFantasia": "Matheus",
"sexo": "M",
"cidade": "Ribeirão Preto",
"uf": "SP",
"pais": "BRASIL",
"bairro": "Jardim Prof Antônio Palocci",
"logradouro": "Rotatória José Pessini",
"nroLogradouro": "863999",
"complementoLogradouro": "TEST 1",
"cep": "14079077",
"foneDdd1": "16",
"foneNro1": "38800263",
"dtaNascFund": "1987-06-13T13:34:15",
"email": "matheusmarciodaluz@tanetxxxxxxxxxxx@net.com.br",
"emailNfe": "matheusmarciodaluz@tanetxxxxxxxxxxxx@net.com.br",
"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": "2813221589399999999999",
"cnpjInstituicaoPagto": "",
"idCarteira": "1",
"tipoCarteira": "01",
"idPagtoCanalVenda": "1",
"nsuDto": {
"nsu": "123456789000",
"nroCartao": "5180926354881155180#########8115",
"codRede": "125",
"codBandeira": "1",
"codBin": "123",
"nroAutorizacao": "123"
}
}
]
} |
EXEMPLO DA RESPOSTA RECEBIDA
| Bloco de código | ||
|---|---|---|
| ||
{
"seqCanalVenda":1,
"idPedidoCanalVenda": "123",
"dtaHorPedidoCanalVenda": "2022-10-13T13:34:15",
"nroEmpresa": 1
} |
PARÂMETROS DO CORPO
Nome |
|---|
seqCanalVenda Inteiro Obrigatório Sequencial do 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 Número identificador da empresa no ERP, identifica em qual empresa o pedido será integrado. 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 |
codGeralOper Inteiro
Código Geral da Operação
nroRepresentante Inteiro
Número do Representante
nroTabVenda Texto
Número da Tabela de Venda
seqTransportador Inteiro
Sequencial do Transportador
tipoEntrega Texto
Tipo de Entrega
obsPedido Texto
Observação do Pedido
obsNotaFiscal Texto
Observação da Nota Fiscal
vlrTotFrete Numérico
Valor total do Frete
tipoRateioFretePedido Texto
Tipo de Rateio do Frete do Pedido
tipoFreteDocAuxiliar Texto
Tipo de Frete/Documento Auxiliar
indIntermediador Texto
Identificador do Intermediador
é 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:
|
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:
|
tipoFreteDocAuxiliar Inteiro Campo responsável por receber o Tipo de Documento Auxiliar do Frete. O valor da propriedade TipoFreteDocAuxiliar aceita apenas os valores:
|
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
|
Dados do cliente do pedido de venda
|
inscEstadualRg texto Obrigatório
Inscrição Estadual
|
|
|
|
|
|
| ||||
Objeto itemDto Obrigatório Coleção de dados dos itens do pedido de venda
|
Array de objeto itemDto
Coleção de dados dos itens do pedido de venda
|
qtdPedida Numérico
Quantidade Pedida
qtdEmbalagem Numérico
Quantidade da Embalagem
vlrEmbTabPreco Numérico
|
vlrEmbInformado Numérico
Valor da Embalagem Informado
|
vlrEmbTabPromoc Numérico
|
vlrEmbDesconto Numérico
Valor de desconto da Embalagem
observacaoItem Inteiro
Observação do item
|
qtdVolume Numérico
|
indSimilarEcommerce Inteiro
|
|
indKit Inteiro
Identificador de Kit
vlrTotComissao Numérico
Valor Total da Comissão
fatorMultiplicador Numérico
Fator multiplicador
|
seqItemCanalVenda Inteiro
|
Objeto pagamentoDto Obrigatório Coleção de dados dos pagamentos do pedido de venda
|
Array de objeto pagamentoDto
Coleção de dados dos pagamentos do pedido de venda
|
|
|
|
|
|
|
Array de objeto nsuDto
Coleção de dados complementares de cartões do pedido de venda
|
|
|
...
|
RESPOSTA
| Dica |
|---|
200 ok |
| Aviso |
|---|
400 Falha |
VALIDAÇÕES EXISTENTES
Validações efetuadas no momento da requisição
Erro: Campo idPagtoCanalVenda não encontrado.
Informe neste campo a sequencia do pagamento efetuado pelo sistema terceiro, será utilizado se precisar enviar dados complementares da transação de cartão posterior à inserção do pedido. Se seu sistema não controla a sequencia, crie uma a sua escolha, no caso de mais de um pagamento no mesmo pedido, essa sequencia não pode se repetir.
Validações pós processamento
Existem algumas validações que serão processadas após o recebimento do pedido
Erro: Pedido já integrado no sistema
...
| ||
|
| Aviso | ||
|---|---|---|
| ||
|
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.0701.999001
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas