APIs do Totali Middleware
Referenciado por: APIs do Totali Middleware |
Conceito
Realizar a inclusão/alteração de Dav (TT_ORC), Itens (TT_IOR) e Pagamentos (TT_RDV) de requisição externa.
Valida Sessão
Sim
Para mais informações para a Validação de sessão e obtenção da Assinatura, verificar a documentação do padrão de trocas de informações neste link.
Exemplo de como deve ser enviado o comando completo:
{ "Parametros":{ "Id":55251, "Dados":{ "Orcamento":{ Dados do Orçamento... } } }, "Assinatura":"71AC25C67D801BE7933756BA48C3950D" }
API
TCommerceAPI
Método
PersisteDAV
Exemplo de chamada: http://localhost:8080/datasnap/rest/TCommerceAPI/PersisteDAV
Troca de informações
- Parâmetros de Entrada:
{ "Orcamento": { "Filial": "<Código da Filial [TT_ORC.CODFIL]>", "TipoPedido": "<Tipo do Pedido (O - DAV, S - DAV-OS) [TT_ORC.TIPPED]>", "NumeroPedido": "<Número do Pedido DAV [TT_ORC.NUMPED] (opcional)>", "NumeroPedidoRE": "<Número do Pedido da Requisição Externa [TT_ORC.NUMPED_RE]>", "DataPedido": "< Data do Pedido [TT_ORC.PED_EM]> ", "DataValidade": "< Data de Validade do Pedido [TT_ORC.DATVAL] (opcional). Se não informado, assumirá a Data do Pedido> ", "DataPrevisaoEntrega": "< Data prevista para entrega [TT_ORC.DATENT]>", "ValorTotal": "<Valor Total [TT_ORC.VLRTOT]>", "ValorDesconto": "<Valor do Desconto [TT_ORC.VLRDES] (opcional)>", "ValorAcrescimo": "<Valor do Acréscimo [TT_ORC.VLRDES] (opcional)>", "ValorParcela": "<Valor da parcela [TT_ORC.VLRPAR] (opcional)>", "QuantidadeParcelas": "<Quantidade de parcelas [TT_ORC.QTDPAR] (opcional)>", "ValorSeguro": "<Valor do Seguro [TT_ORC.VLRSEG] (opcional)>", "ValorFrete": "<Valor do Frete [TT_ORC.VLRFRE] (opcional)>", "Situacao": "<Situação (A - Aberto; E - Entregue; O - Concluído; C - Cancelado) [TT_ORC.FLGEST]>", "PendenteEnvioEcommerce": "<Pendente de Envio para E-commerce [TT_ORC.ENVECO] (opcional)>", "SistemaOrigem": "<Sistema de Origem do Envio (A - App; S - Site; H - Home) [TT_ORC.SISORI] (opcional)>", "SituacaoAprovacaoCredito": "<Situação da Aprovação de Crédito do Cliente (E - Em Aprovação; R - Reprovado; A - Aprovado)
[TT_ORC.APROVA] (opcional)>", "AprovacaoOrcPeloCliente": "<Situação da Aprovação do Orçamento pelo Cliente (A - Em Aberto; 1 - Aprovado; 2 - Reprovado)
[TT_ORC.APRCLI] (opcional)>", "__comment__": "Quando indicado Situação da DAV no E-Commerce ou Indicador de Reserva os itens serão considerados que devem ser Reservados",
"SituacaoEcommerce": "<Situação da DAV no E-Commerce (T - Pagamento em análise; R - Pendente de pagamento; P - Pagamento aprovado;
F - Pagamento efetivado; E - Produto Enviado; 0 - Rejeitado; 1 - Pronto para retirada; 2 - Retirado pelo cliente) [TT_ORC.FLGECO]> (opcional, se pedido não é proveniente de E-Commerce)", "Reserva": "<Indicador de Reserva [TT_ORC.RESERV] (opcional)>", "NumPedCom": "<Numero do Pedido do Cliente>", "__comment__": "<Tipo de Entrega do cliente (Retirar, Expressa ou Normal, sendo [Retirar -> 3 - Retira no Depósito] -
[Expressa ou Normal -> 2 - Loja Entrega])>", "TipoEntrega": "<Tipo de Entrega (0 - Cliente Leva; 1 - Depósito Entrega; 2 - Loja Entrega; 3 - Retira no Depósito;
4 - Em Outra Loja; 5 - Entrega Futura; 6 - Apenas Orçamento; 7 - Venda Sob Encomenda) [TT_ORC.TIPENT]>", "FilialRetirada": "<Filial da retirada (Observação: Identificação utilizada apenas para inclusão de informação nos dados complementares do documento fiscal) [TT_ORC.FILRET]>", "ObservacaoVenda""<Observação de Venda [TT_ORC.OBSERV] (opcional)>", "PlanoDePagamento": { "__comment__": "<Plano de Pagamento: [TT_PLA.FILPGT + TT_PLA.CODPGT - TCommerceAPI_ConsultaRetaguarda -> Origem - C; Tipo - 36 ->
Valor da coluna Pla_Chave do retorno]>", "Chave": "<Chave Plano de Pagamento [Pla_Chave] (opcional)>" }, "TabelaDePrecos": { "__comment__": "<Tabela de Preço: [TT_PRE.FILPRE + TT_PRE.CODPRE - TCommerceAPI_ConsultaRetaguarda -> Origem - C; Tipo - 40 ->
Valor da coluna Pre_TabPreChave do retorno]>", "Chave": "<Chave Tabela de Preço [Pre_TabPreChave] (opcional)>" }, "Cliente": { "__comment__": "<Cliente>", "CodigoExterno": "<Código Externo do Parceiro [TT_CLI.CODEXT]>", "FilCli": "<Filial do Parceiro [TT_CLI.FILCLI] (opcional)>", "CodCli": "<Código do Parceiro [TT_CLI.CODCLI] (opcional)>", "Documento": "<Número do Documento [TT_CLI.NUMDOC] (opcional)>" }, "EnderecoCobranca": { "__comment__": "<Endereço de Cobrança>", "CodigoExterno": "<Código Externo do Endereço [TT_END.CODEXT]>", "CodFil": "<Filial do Endereço [TT_END.CODFIL] (opcional)>", "NumEnd": "<Número de Endereço [TT_END.NUMEND] (opcional)>" }, "EnderecoEntrega": { "__comment__": "<Endereço de Entrega>", "CodigoExterno": "<Código Externo do Endereço [TT_END.CODEXT]>", "CodFil": "<Filial do Endereço [TT_END.CODFIL] (opcional)>", "NumEnd": "<Número de Endereço [TT_END.NUMEND] (opcional)>" }, "EnderecoFatura": { "__comment__": "<Endereço de Fatura>", "CodigoExterno": "<Código Externo do Endereço [TT_END.CODEXT]>", "CodFil": "<Filial do Endereço [TT_END.CODFIL] (opcional)>", "NumEnd": "<Número de Endereço [TT_END.NUMEND] (opcional)>" }, "Vendedor": { "__comment__": "<Vendedor do Orçamento>", "CodigoExterno": "<Código Externo do Vendedor [TT_USU.CODEXT] (opcional)>", "Apelido": "<Apelido do vendedor [TT_USU.APEUSU] (opcional)>", }, "Itens": [{ "__comment__": "<Lista de Itens>", "NumeroItem": "<Número do item [TT_IOR.NUMITE] (Sequencial)>", "ProdutoServico": { "__comment__": "<TCommerceAPI_ConsultaRetaguarda -> Origem - C; Tipo - 41 ->
Obrigatório informar um dos 3 códigos abaixo>", "Chave": "<Chave do produto [Pro_Chave FILMAT+SEQUEN] (opcional)>" "CodExt":"<Código externo do produto (opcional)" "RefPro":"<Referência do produto (opcional)" }, "SituacaoItemOrcamento": "Situação do Item do Orçamento [A - Aberto (default); E - Entregue/Vendido; C - Cancelado; R - Reservado] (opcional). " "QtdItem": "<Quantidade [TT_IOR.QTDITE]>", "vUnitario": "<Valor Unitário [TT_IOR.VLRITE]>", "vDesconto": "<Valor do Desconto [TT_IOR.VLRDES] (opcional)>", "vAcrescimo": "<Valor do Acréscimo [TT_IOR.VLRACR] (opcional)>", "vTotalSemDesc": "<Valor Total Sem Desconto/Acréscimo [TT_IOR.VLRPGT]>", "vTotal": "<Valor Total [TT_IOR.VLRCUS>", "Promocao": "<Promoção (N - Não Promocional no Plano; E - Promocional no Plano; Q - Qualquer Plano) [TT_IOR.PROMOC]>", "TipoEntrega": "<Tipo de Entrega (0 - Cliente Leva; 1 - Depósito Entrega; 2 - Loja Entrega; 3 - Retira no Depósito;
4 - Em Outra Loja; 5 - Entrega Futura; 6 - Apenas Orçamento; 7 - Venda Sob Encomenda) [TT_IOR.TIPENT]>", "Lote": { "__comment__": "<Lotes: [TCommerceAPI_ConsultaRetaguarda -> Origem - C; Tipo - 73 -> Valor da coluna Lot_Chave do retorno]>", "Chave": "<Chave do lote [Lot_Chave] (opcional)>", "CodigoExterno": "<Código Externo do Lote [TT_LOT.CODEXT] (opcional)>", "Numero": "<Número do Lote [TT_LOT.NUMLOT] (opcional)>", }, "NumeroPedidoCompraCliente": "<Número do Pedido de Compra do Cliente [TT_IOR.NUMPEDCOM]>", "ItemPedidoCompraCliente": "<Número do Pedido de Compra do Cliente [TT_IOR.ITEPEDCOM]>" }], "Pagamentos": [{ "__comment__": "<Lista de Pagamentos (opcional)>", "TipoDeRecebimento": "<Tipo de Recebimento (1 - Banco Brasil; 2 - Bradesco; 3 - Banrisul; 4 - HSBC; 5 - Itau;
9 - Pagamento Digital; A - Amex; B - Boleto; C - PagSeguro Cartão; D - Dinners; E - Elo; H - HiperCard; M - MasterCard;
O - Outros; P - PagSeguro Boleto; S - PagSeguro; U - Aura; V - Visa; X - Wix Pagamentos; Y - PayPal; W - Boleto a prazo/Gerar boleto em aberto) [TT_RDV.TIPRDV]>", "DataDeVencimento": "", "ValorDocumento": "<Valor do Documento [TT_RDV.VLRDOC]>", "NumeroDeParcelas": "<Número de Parcelas [TT_RDV.QTDPAR] (Observação: Número de parcelas informado deve estar entre a faixa 1 e 99 e é obrigatório quanto pagamento com Cartão) (Obrigatório quando Tipo de Recebimento Cartão)>", "ValorJuros": "<Valor de Juros [TT_RDV.VLRJUR] (opcional)>", "DataDePagamento": "<Data e Hora de Pagamento [TT_RDV.DATPAG]>", "NumeroDeAutorizacao": "<Número de Autorizacao [TT_RDV.NUMAUT] (Obrigatório quando Tipo de Recebimento Cartão)>", "NumeroDoComprovanteDeVenda": "<Número do Comprovante de Venda [TT_RDV.NUMCPV] (opcional)>", "NumeroCartao": "<Número do Cartão [TT_RDV.NUMCAR] (Obrigatório quando Tipo de Recebimento Cartão)>", "CodigoExternoCartao": "<Código Externo da Bandeira do Cartão [TT_RDV.EXTCAR] (opcional)>", "ValidadeCartao": "<Validade Cartão [TT_RDV.VLDCAR] (Obrigatório quando Tipo de Recebimento Cartão)>", "NossoNumeroBoleto": "<Nosso número [TT_RDV.NOSNUM] (opcional)>", "CodigoDaNacionalidadeDoEmissor": "<Código da Nacionalidade do Emissor [TT_RDV.CODNAC] (opcional)>", "CodigoDoBancoEmissor": "<Código do Banco Emissor [TT_RDV.BANEMI] (opcional)>", "CidadeDoTitular": "<Cidade do Titular [TT_RDV.CIDTIT] (opcional)>", "EnderecoDoTitular": "<Endereço do Titular [TT_RDV.ENDTIT] (opcional)>", "CepDoTitular": "<CEP do Titular [TT_RDV.CEPTIT] (opcional)>", "EstadoDoTitular": "<Estado do Titular [TT_RDV.ESTTIT] (opcional)>", "NumeroDaTransacao": "<Número da Autenticação / TID / Número da Transação [TT_RDV.NUMTRN] (Obrigatório quando Tipo de Recebimento Cartão)>", "CodigoDeIdentificacaoDaTransacao": "<Número Sequencial Único / Código de identificação da Transação [TT_RDV.ID_TRN] (opcional)>" }] } }
- Parâmetros de Saída:
Exemplo de retorno com erro
{ "result": { "controle": { "err": true, "cod": "", "msg": "Mensagem de erro" } } } ou { "error": "Mensagem de erro" }
Exemplo de retorno com sucesso
{ "result": { "controle": { "err": false, "cod": 0, "msg": "" }, "conteudo": { "livre": { "CodFil": "<Filial do Pedido [TT_ORC.CODFIL]>", "TipPed": "<Tipo de Pedido [TT_ORC.TIPPED]>", "NumPed": "<Número do Pedido [TT_ORC.NUMPED]>" } } } }
Exemplo de Envio
Dados do Orçamento:
{ "Orcamento":{ "Filial":"001", "TipoPedido":"O", "NumeroPedidoRE":"3497", "DataPedido":"12/05/2020", "SistemaOrigem":"H", "ValorTotal":154.5, "ValorParcela":77.25, "QuantidadeParcelas":2, "ValorDesconto":0, "ValorFrete":0, "Situacao":"A", "__comment__": "Quando indicado Situação da DAV no E-Commerce ou Indicador de Reserva os itens serão considerados que devem ser Reservados", "SituacaoEcommerce":"P", "Reserva": false, "NumPedCom": "", "__comment__":3, "TipoEntrega":3, "PlanoDePagamento":{ "__comment__":"Plano de Pagamento", "Chave":"001 1" }, "Cliente":{ "__comment__":"Gerfson Santos", "Documento":"22558497120" }, "EnderecoCobranca":{ "CodigoExterno":"001125898" }, "EnderecoEntrega":{ "CodigoExterno":"001125898" }, "EnderecoFatura":{ "CodigoExterno":"001125898" }, "Vendedor":{ "Chave":"001100" }, "Itens":[ { "__comment__":"ENVELOPE CARTA BRANCO C\/1000 11X16 FORONI", "ProdutoServico":{ "Chave":"001 53792", "Codext":"" }, "QtdItem":3, "vUnitario":51.5, "vDesconto":0, "vAcrescimo":0, "vTotalSemDesc":154.5, "vTotal":154.5, "Promocao":"N", "NumeroItem":1, "TipoEntrega":3 } ], "Pagamentos":[ { "TipoDeRecebimento":"V", "NumeroDeAutorizacao":183973, "DataDeVencimento":"11/06/2020", "ValorDocumento":154.5, "NumeroDeParcelas":2, "DataDePagamento":"12/05/2020", "NumeroCartao":"0000", "ValidadeCartao":"0521" } ] } }