Histórico da Página

POST {urlbase}:{porta}/smpedidovenda/smpedidovendaapi/api/v1/pedidovendaObjetivo

Endpoint responsável por receber, validar e persistir pedidos de venda.

Índice

EXEMPLO DO CORPO DA REQUISIÇÃO

Bloco de código

language	js

{
  "seqCanalVenda":1,
  "idPedidoCanalVenda": "123",
  "dtaHorPedidoCanalVenda": "2022-10-13T13:34:15",
  "nroEmpresa": 1,
  "codGeralOper": 999,
  "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": "28132215893",
    "inscEstadualRg": "155734544",
    "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": "863",
    "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": "28132215893",
      "cnpjInstituicaoPagto": "",
      "idCarteira": "1",
      "tipoCarteira": "01",
      "idPagtoCanalVenda": "1",
      "nsuDto": {
        "nsu": "123456789000",
        "nroCartao": "518092635488115",
        "codRede": "125",
        "codBandeira": "1",
        "codBin": "123",
        "nroAutorizacao": "123"
      }
    }
  ]
}

EXEMPLO DA RESPOSTA RECEBIDA

Bloco de código

language	js

{
  "seqCanalVenda":1,
  "idPedidoCanalVenda": "123",
  "dtaHorPedidoCanalVenda": "2022-10-13T13:34:15",
  "nroEmpresa": 1
}

PARÂMETROS DO CORPO

Instalação

Para instalação do módulo de API Pedido de Venda deve ser feito via PublicaWeb > ConsincoWeb

Pacote: Pedido de Venda API

Versão a partir de: 23.07.999

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


	nroEmpresa inteiro obrigatório Nú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
	pagamentoDto.nsuDto.nroCartao string Número do cartão utilizado no pagamento pedido

Body Parameters

Nome

seqCanalVenda inteiro

Dto	Nome
	seqCanalVenda Inteiro

obrigatório

Sequencial do Canal de Venda

idPedidoCanalVenda

texto

String obrigatório

Identificação do Pedido de Venda

dtaHorPedidoCanalVenda

texto

DateTime

Data/Hora do Pedido de Venda

Formado esperado: "YYYY-MM-DDTHH:MM:SS"


	nroEmpresa

inteiro

Inteiro obrigatório

Número da Empresa

nroSegmento

tipo

Inteiro

Número do Segmento

codGeralOper

inteiro

Inteiro

Código Geral da Operação

nroRepresentante

inteiro

Inteiro

Número do Representante

nroTabVenda

texto

String

Número da Tabela de Venda

seqTransportador

inteiro

tipo

Sequencial do Transportador

tipoEntrega

tipo

String

Tipo de Entrega

obsPedido

tipo

String

Observação do Pedido

obsNotaFiscal

tipo

String

Observação da Nota Fiscal

vlrTotFrete tipo

Valor total do Frete

tipoRateioFretePedido

tipo

String

Tipo de Rateio do Frete do Pedido

tipoFreteDocAuxiliar

tipo

Inteiro

Tipo de Frete/Documento Auxiliar

indIntermediador

tipo

String

Identificador do Intermediador

Object

clienteDto

- Dados do cliente

do pedido de venda ExpandirtitleObject

Clique para expandir

clienteDto

Dados do cliente do pedido de venda

Nome

	cpfCnpj tipo CPF/CNPJ do Cliente
clienteDto	inscEstadualRg tipo Inscrição Estadual
clienteDto	nomeRazaoSocial tipo Razão Social
clienteDto	nomeFantasia tipo Nome Fantasia
clienteDto	sexo tipo Gênero
clienteDto	cidade tipo Nome da Cidade
clienteDto	uf tipo Estado
clienteDto	pais tipo País
clienteDto	bairro tipo Bairro
clienteDto	logradouro tipo Logradouro
clienteDto	nroLogradouro tipo Número do Logradouro
clienteDto	complementoLogradouro tipo Complemento do Logradouro
clienteDto	cep tipo Código Postal (CEP)
clienteDto	foneDdd1 tipo Número do DDD
clienteDto	foneNro1 tipo Número do Telefone
clienteDto	dtaNascFund tipo Data de Nascimento/Fundação
clienteDto	email tipo E-mail
clienteDto	emailNfe tipo E-mail para entrega de Nota Fiscal
clienteDto	estadoCivil tipo Estado Civil
clienteDto	inscMunicipal tipo Inscrição Municipal
clienteDto	inscProdutor tipo Inscrição de Produtor
clienteDto	indContribIcms tipo Identificador de Contribuição de ICMS
clienteDto	fisicaJuridica tipo Pessoa Física/Jurídica

Array de objeto itemDto

Coleção de dados dos itens do pedido de venda

Expandir

title	Clique para expandir...

Array de objeto itemDto

Coleção de dados dos itens do pedido de venda

itemDto - Itens do pedido

clienteDto	expandables
itemDto	codAcesso tipo
itemDto	seqProduto tipo Sequencial do Produto
itemDto

Nomes

	qtdPedida tipo Quantidade Pedida
itemDto	qtdEmbalagem tipo Quantidade da Embalagem
itemDto	vlrEmbTabPreco tipo Valor da Embalagem na Tabela de Preço
itemDto	vlrEmbInformado tipo Valor da Embalagem Informado
itemDto	vlrEmbTabPromoc tipo Valor da Embalagem na Tabela Promocional
itemDto	vlrEmbDesconto tipo Valor de desconto da Embalagem
itemDto	observacaoItem tipo Observação do item
itemDto	qtdVolume tipo Quantidade de Volume do Item
itemDto	indSimilarEcommerce tipo Identificação de Pedido Similar ao

E-commerce

Ecommerce
itemDto	indKit tipo Identificador de Kit
itemDto	vlrTotComissao tipo Valor Total da Comissão
itemDto	fatorMultiplicador tipo Fator multiplicador
itemDto	seqItemCanalVenda tipo Sequencial do Item no Canal de Venda

Array de objeto pagamentoDto

Coleção de dados dos pagamentos do pedido de venda

Expandir

title	Clique para expandir...

Array de objeto pagamentoDto

Coleção de dados dos pagamentos do pedido de venda

pagamentoDto - Dados do pagamento do pedido
itemDto	expandables
pagamentoDto

Nomes

	nroFormaPagto tipo Número Forma de Pagamento
pagamentoDto	nroCondPagto tipo Número Condição de Pagamento
pagamentoDto	valorPagto tipo Valor do Pagamento
pagamentoDto	nroGiftCard tipo Número do Gift Card
pagamentoDto	nroParcela tipo Número de Parcelas
pagamentoDto	cpfCnpjCartao tipo CPF/CNPJ do Proprietário do Cartão
pagamentoDto	cnpjInstituicaoPagto tipo CNPJ da Instituição de Pagamento
pagamentoDto	idCarteira tipo Identificação da Carteira
pagamentoDto	tipoCarteira tipo Tipo de carteira
pagamentoDto	idPagtoCanalVenda tipo Identificação do Pagamento do canal de venda

Array de objeto nsuDto

Coleção de dados complementares de cartões do pedido de venda

Expandir

title	Clique para expandir...

Array de objeto nsuDto

Coleção de dados complementares de cartões do pedido de venda

Nomes

nsu texto

NSU é a sigla para Número Sequencial Único. É um número único gerado para identificar uma transação ou uma nota fiscal.

nroCartao texto

Número do cartão utilizado no pagamento

codRede texto

Código da rede utilizada no pagamento

codBandeira texto

Código da bandeira utilizada no pagamento

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.

nroAutorizacao texto

Um 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

CABEÇALHOS

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

O pedido que está tentando inserir já consta como integrado no ERP, para essa verificação identificamos que já existe um mesmo pedido com o mesmo seqCanalVenda e idPedidoCanalVenda no ERP com status de processado, nesse caso, favor verificar se as informações estão corretas e gerar um novo pedido.

INSTALAÇÃO

Para instalação do módulo de API Pedido de Venda deve ser feito via PublicaWeb > ConsincoWeb

Pacote: Pedido de Venda API

...

pagamentoDto.nsuDto - Dados complementares ao pagamento de cartão de crédito
pagamentoDto	expandables
pagamentoDto.nsuDto	nsu string obrigatório
pagamentoDto.nsuDto	nroCartao string obrigatório
pagamentoDto.nsuDto	codRede string
pagamentoDto.nsuDto	codBandeira string
pagamentoDto.nsuDto	codBin string
pagamentoDto.nsuDto	nroAutorizacao string
pagamentoDto.nsuDto	expandables

Árvore de páginas

Versões comparadas

Versão antiga 9

Nova versão 10

Chave

EXEMPLO DO CORPO DA REQUISIÇÃO

EXEMPLO DA RESPOSTA RECEBIDA

PARÂMETROS DO CORPO

CABEÇALHOS

RESPOSTA

VALIDAÇÕES EXISTENTES

Validações efetuadas no momento da requisição

Validações pós processamento

INSTALAÇÃO