POST {urlbase}:{porta}/smpedidovendaapi/api/v1/PedidoVenda
Endpoint responsável por receber, validar e persistir pedidos de venda.
EXEMPLO DO CORPO DA REQUISIÇÃO
{
"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. |
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 é 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 |
Objeto itemDto Obrigatório Coleção de dados dos itens do pedido de venda |
Objeto pagamentoDto Obrigatório Coleção de dados dos pagamentos do pedido de venda IMPORTANTE! 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. |
RESPOSTA
Resposta Recebida
{
"seqPedido": 422,
"seqCanalVenda": 21,
"idPedidoCanalVenda": "68",
"dtaHorPedidoCanalVenda": "2022-08-09T09:59:06.149Z",
"nroEmpresa": 1,
"nroSegmento": 1,
"codGeralOper": 518,
"nroRepresentante": 1,
"nroTabVenda": "1"
}
Resposta de Erro
{
"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
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas