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
PARÂMETROS DO CORPO
Nome | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
seqCanalVenda | ||||||||||||||||||||||||||||||||||||
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 dtaHorPedidoCanalVenda DataHora Data/Hora em que o Pedido de Venda receberá terá ao ser criado. Formado 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 nroEmpresa Inteiro 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 InteiroNumérico Número identificador do Segmento no ERP, identifica em qual segmento o pedido será integrado. codGeralOper Inteiro Número identificador do Código Geral de Operação no ERP, identifica em qual CGO o pedido será integrado. O tamanho O valor máximo permitido para o Código Geral Operação é de 999Segmento é de 999999. Caso não seja informado, o sistema utilizará como padrão o segmento informado no cadastro do Canal de Venda. | ||||||||||||||||||||||||||||||||||||
codGeralOper NumériconroRepresentante Inteiro Número identificador do representante Código Geral de Operação no ERP, identifica em qual Representante efetuou CGO o pedido será integrado. O tamanho valor máximo permitido para o Representante Código Geral Operação é de 99999 | ||||||||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||||||||
seqTransportador Inteiro Identificador do Transportador, identifica qual Transportador estará responsável pelo pedido. | ||||||||||||||||||||||||||||||||||||
tipoEntrega Texto Sigla que terá como identificação de Entrega ou Retirada do Pedido. O valor da propriedade TipoEntrega aceita apenas os valores: 'E' (Entrega) e '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 Numérico Valor total do Frete | ||||||||||||||||||||||||||||||||||||
tipoRateioFretePedido Texto Tipo de Rateio do Frete do Pedido O valor da propriedade TipoRateioFretePedido aceita apenas os valores: 'V' (Valor), 'P' (Peso Bruto), 'O' (Volume), e 'T' (Conforme cálculo do frete do transportador no pedido de venda) | ||||||||||||||||||||||||||||||||||||
tipoFreteDocAuxiliar Texto Tipo de Frete/Documento Auxiliar 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), e 9 (Sem Ocorrência de Transporte) | ||||||||||||||||||||||||||||||||||||
indIntermediador Texto Identificador do Intermediador O valor da propriedade IndIntermediador aceita apenas os valores: 'S' (Sim) e 'N' (Não) | ||||||||||||||||||||||||||||||||||||
Object clienteDto Obrigatório Dados do cliente do pedido de venda
| ||||||||||||||||||||||||||||||||||||
Objeto itemDto Obrigatório Coleção de dados dos itens do pedido de venda
| ||||||||||||||||||||||||||||||||||||
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
| ||||||||||||||||||||||||||||||||||||
Objeto itemDto Obrigatório Coleção de dados dos itens Objeto pagamentoDto Obrigatório Coleção de dados dos pagamentos do pedido de venda
|
CABEÇALHOS
RESPOSTA
| Dica |
|---|
200 ok |
| Aviso |
|---|
400 Falha |
VALIDAÇÕES EXISTENTES
Validações efetuadas no momento da requisição
Erro: Campo TipoFreteDocAuxiliar Inválido.
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), e 9 (Sem Ocorrência de Transporte).
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
...
| ||||||||||||||||||||||||||||||||||
Objeto pagamentoDto Obrigatório Coleção de dados dos pagamentos do pedido de venda
|
RESPOSTA
| Dica | ||
|---|---|---|
| ||
|
| 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