Histórico da Página

ObjetivoPOST {urlbase}:{porta}/smpedidovenda/smpedidovendaapi/api/v1/pedidovenda

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

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

...

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

Í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

Nome
seqCanalVenda Inteiro Obrigatório

Body Parameters

Dto

Nome

seqCanalVenda Inteiro obrigatório

Sequencial do Canal de Venda

idPedidoCanalVenda

String obrigatório

Texto Obrigatório

Identificação do Pedido de Venda

dtaHorPedidoCanalVenda

DateTime

DataHora

Data/Hora do Pedido de Venda
Formado esperado: "YYYY-MM-DDTHH:MM:SS"

nroEmpresa Inteiro

obrigatório

Obrigatório

Número da Empresa

nroSegmento Inteiro

Número do Segmento

codGeralOper Inteiro

Código Geral da Operação

nroRepresentante Inteiro

Número do Representante

nroTabVenda

String

Texto

Número da Tabela de Venda

seqTransportador

tipo

Inteiro

Sequencial do Transportador

tipoEntrega

String

Texto

Tipo de Entrega

obsPedido

String

Texto

Observação do Pedido

obsNotaFiscal

String

Texto

Observação da Nota Fiscal

vlrTotFrete

tipo

Numérico

Valor total do Frete

tipoRateioFretePedido

String

Texto

Tipo de Rateio do Frete do Pedido

tipoFreteDocAuxiliar

Inteiro

Texto

Tipo de Frete/Documento Auxiliar

indIntermediador

String

Texto

Identificador do Intermediador

Object clienteDto

-

Dados do cliente do pedido de venda

Expandir

title	Clique para expandir

Object clienteDto

Dados do cliente do pedido de venda

Nome
cpfCnpj

tipo

Texto Obrigatório

CPF/CNPJ do Cliente

clienteDto

inscEstadualRg

tipo

texto Obrigatório

Inscrição Estadual

clienteDto

nomeRazaoSocial

tipo

Texto Obrigatório

Razão Social

clienteDto

nomeFantasia

tipo

Texto

Nome Fantasia

clienteDto

sexo

tipo

Texto

Gênero

clienteDto

cidade

tipo

Texto

Nome da Cidade

clienteDto

uf

tipo

Texto

Estado

clienteDto

pais

tipo

Texto

País

clienteDto

bairro

tipo

Texto

Bairro

clienteDto

logradouro

tipo

Texto

Logradouro

clienteDto

nroLogradouro

tipo

Texto

Número do Logradouro

clienteDto

complementoLogradouro

tipo

Texto

Complemento do Logradouro

clienteDto

cep

tipo

Texto

Código Postal (CEP)

clienteDto

foneDdd1

tipo

Texto

Número do DDD

clienteDto

foneNro1

tipo

Texto

Número do Telefone

clienteDto

dtaNascFund

tipo

DataHora

Data de Nascimento/Fundação

clienteDto

email

tipo

Texto

E-mail

clienteDto

emailNfe

tipo

Texto

E-mail para entrega de Nota Fiscal

clienteDto

estadoCivil

tipo

Texto

Estado Civil

clienteDto

inscMunicipal

tipo

Texto

Inscrição Municipal

clienteDto

inscProdutor

tipo

Texto

Inscrição de Produtor

clienteDto

indContribIcms

tipo

Texto

Identificador de Contribuição de ICMS

clienteDto

fisicaJuridica

tipo

Texto

Pessoa Física/Jurídica

clienteDto

expandables

itemDto - Itens do pedido

itemDto

codAcesso tipo

itemDto

seqProduto tipo

Sequencial do Produto

itemDto

qtdPedida tipo

Quantidade Pedida

itemDto

qtdEmbalagem tipo

Quantidade da Embalagem

itemDtovlrEmbTabPreco tipo

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

Nomes

codAcesso Texto

qtdPedida Numérico

Quantidade Pedida

qtdEmbalagem Numérico

Quantidade da Embalagem

vlrEmbTabPreco Numérico

Valor da Embalagem na Tabela de Preço

itemDto

vlrEmbInformado

tipo

Numérico

Valor da Embalagem Informado

itemDto

vlrEmbTabPromoc

tipo

Numérico

Valor da Embalagem na Tabela Promocional

itemDto

vlrEmbDesconto

tipo

Numérico

Valor de desconto da Embalagem

itemDto

observacaoItem

tipo

Inteiro

Observação do item

itemDto

qtdVolume

tipo

Numérico

Quantidade de Volume do Item

itemDto

indSimilarEcommerce

tipo

Inteiro

Identificação de Pedido Similar ao

EcommerceitemDto

E-commerce

indKit

tipo

Inteiro

Identificador de Kit

itemDto

vlrTotComissao

tipo

Numérico

Valor Total da Comissão

itemDto

fatorMultiplicador

tipo

Numérico

Fator multiplicador

itemDto

seqItemCanalVenda

tipo

Inteiro

Sequencial do Item no Canal de Venda

itemDto

expandables

pagamentoDto - Dados do pagamento do pedido

pagamentoDtonroFormaPagto tipo

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

Nomes

nroFormaPagto Inteiro

Número Forma de Pagamento

pagamentoDto

nroCondPagto

tipo

Inteiro

Número Condição de Pagamento

pagamentoDto

valorPagto

tipo

Numérico

Valor do Pagamento

pagamentoDto

nroGiftCard

tipo

Numérico

Número do Gift Card

pagamentoDto

nroParcela

tipo

Numérico

Número de Parcelas

pagamentoDto

cpfCnpjCartao

tipo

Texto

CPF/CNPJ do Proprietário do Cartão

pagamentoDto

cnpjInstituicaoPagto

tipo

Texto

CNPJ da Instituição de Pagamento

pagamentoDto

idCarteira

tipo

Texto

Identificação da Carteira

pagamentoDto

tipoCarteira

tipo

Texto

Tipo de carteira

pagamentoDto

idPagtoCanalVenda

tipo

Texto

Identificação do Pagamento do canal de venda

Array de objeto nsuDto

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

pagamentoDto

Expandir

expandables

pagamentoDto.nsuDto - Dados complementares ao pagamento de cartão de crédito

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.nsuDtoexpandables

title	Clique para expandir...

Array de objeto nsuDto

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

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.

nroCartao Texto Obrigatório

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

Versão a partir de: 23.07.999

Árvore de páginas

Versões comparadas

Versão antiga 10

Nova versão 11

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