Você está na página 1de 137

MANUAL WEBSERVICE

WSWMS
DICIONÁRIO DE DADOS DO WEBSERVICE KPL

Descrição de legendas
Campo obrigatório. É necessário informar valor para o campo indicado.
Necessário enviar um dos campos.

Campo não deve ser enviado.


Campo obrigatório desde que exista o node.
Chave única.

Chave composta.

Chave alternativa.
Protocolo chave de confirmação.

Chave de identificação da interface.

Nota: Os campos que não possuírem obrigatoriedade não devem ser enviados nos nodes do XML.

Operação realizada

Código Tipo Mensagem apresentada


100001 tdreAlerta Ocorreram erros durante a obtenção das informações pertinentes a lista de
itens. Verifique o retorno em cada item para maiores detalhes.

200001 tdreSucesso Operação {0} efetuada com sucesso.

Parâmetros: {0} Descrição da operação que foi realizada. Exemplo: Lista de


produtos disponíveis para integração.

200002 tdreSucesso OK.

200003 tdreSucessoSemDados OK, porém não há dados.

300001 tdreErroAplicacao Código do erro não encontrado. Código nr.: {0}.

Parâmetros: {0} Número do código de erro que não se encontra na lista.

300002 tdreErroDataBase Erro na obtenção dos dados para a integração. Origem "{0}”. Parâmetros: {0}
Descreve a origem dos dados onde ocorreu o erro. Exemplo: Lista de marcas
disponíveis para integração.

enumTipo

Dado Enumerado Descrição TipoDeResultadoEnum

tdreSucesso Sucesso na execução do Método invocado.

tdreSucessoSemDados Sucesso na execução do Método invocado, porém sem retorno de dados.

tdreAlerta Alerta na execução do Método invocado.

tdreErroAplicacao Erro no Webservice durante a execução do Método invocado.

tdreErroDataBase Erro no Banco de dados durante a execução do Método invocado.

tdreErroDados Erro nos dados durante a execução do Método invocado.

Página 2 de 137
tdreErroGeral Erro Geral durante a execução do Método invocado.

tdreMensagem Uma mensagem não relacionada a um erro. Serve para enviar mensagens
padronizadas.

enumAcao

Dado Enumerado Descrição TipoDeResultadoEnum


aieEnum Indica a ação para a integração. Pode ser dos seguintes
tipos: aieIndefinido = Ação não indefinida aieManutencao =
Inclusão ou alteração aieExclusao = Exclusão

enumTipoProduto

Dado Enumerado Descrição TipoDeResultadoEnum

tpreEnum O produto pode ser do seguinte tipo:


tpreIndefinido = indefinido, em caso dados nulos ou response com
erros. tpreProduto = O produto é um produto. tpreServico = O produto
é um serviço.

enumSexo

Dado Enumerado Descrição TipoDeResultadoEnum

tseEnum O sexo da pessoa pode ser:


tseIndefinido = dado não esperado.
tseFeminino = sexo feminino
tseMasculino = sexo masculino
tseEmpresa = empresa

enumTipoAtributoEstendido

Dado Enumerado Descrição TipoDeResultadoEnum

TipoAEP O tipo do atributo estendido do produto pode ser:


V = CampoValor
I = CampoInteiro
D = CampoData
S = CampoString
T = CampoTxt

enumProdutoTipoLigacao

Dado Enumerado Descrição TipoDeResultadoEnum


tptleEnum O tipo da classificação da personalização do produto pode
ser: tptleIndefinido tptleProdutoPAI tptleProdutoFILHO
tptleProdutoKit tptleProdutoSimples

Página 3 de 137
enumTipoLocalEntrega

Dado Enumerado Descrição TipoDeResultadoEnum

tleeEnum O tipo de local de entrega pode ser:


tleeDesconhecido = Desconhecido
tleeResidencial = Residencial
tleeComercial = Comercial

enumTipoPessoa

Dado Enumerado Descrição TipoDeResultadoEnum


tpeEnum O tipo pessoa pode ser:
tpeInfinido = Indefinido
tpeFisica = Pessoa Física
tpeJuridica = Pessoa Jurídica
enumStatusPagamento

Dado Enumerado Descrição TipoDeResultadoEnum

tleeEnum O status do pagamento pode ser:


speNenhum =Nenhum
speRecusado = Pagamento recusado speConfirmado
= Pagamento confirmado

enumOptouNFPaulista

Dado Enumerado Descrição TipoDeResultadoEnum

tbneEnum O cliente optou por NF


Paulista? tbneNenhum
tbneSim = Optou NFP tbneNao
= Não optou NFP

enumStatusAtual

Dado Enumerado Descrição TipoDeResultadoEnum

tspeeEnum Status atual do pedido: tspeeNaoEncontrado = Pedido não


encontrado tspeeEmAndamento
= Pedido em andamento
tspeeFaturado = Pedido faturado
tspeeDespachado = Pedido despachado
tspeeEntregue = Pedido entregue
tspeeCancelado = Pedido cancelado

enumTipoListaPresente

Dado Enumerado Descrição TipoDeResultadoEnum


Página 4 de 137
tlpeEnum Valores disponíveis:
tlpeFinanceira;
tlpeProdutos;

enumTipoIPITributacao
Dado Enumerado Descrição TipoDeResultadoEnum
tiptEnum Valores disponíveis:
tiptTributado;
tiptNaoTributado;

enumTipoDestinatarioFiscal

Dado Enumerado Descrição TipoDeResultadoEnum

tdfEnum Valores disponíveis:


tdfIndefinido;
tdfContribuinte;
tdfNaoContribuinte;

enumTipoICMSTributacao

Dado Enumerado Descrição TipoDeResultadoEnum

titEnum Valores disponíveis:


titTributado;
titIsento;
titSuspenso;
titDiferido;
titNaoTributado.

enumTipoICMSModalidadeBase

Dado Enumerado Descrição TipoDeResultadoEnum

timbEnum Valores disponíveis:


timbNenhum;
timbMargemValorAgregado;
timbPauta;
timbPrecoTabelado;
timbValorOperacao.

enumTipoICMSSModalidadeBase

Dado Enumerado Descrição TipoDeResultadoEnum

Página 5 de 137
tismbEnum Valores disponíveis:
tismbNenhum;
tismbPrecoTabeladoMaxSugerido;
tismbListaNegativa;
tismbListaPositiva;
tismbListaNeutra;
tismbMargemValorAgregado;
tismbPautaValor.

enumAcaoManutencao

Dado Enumerado Descrição TipoDeResultadoEnum


ameEnum Indica a ação para a integração. Pode ser dos seguintes tipos:
ameManutencao = Manutenção
ameDesativacao = Desativação
ameExclusao = Exclusão
enumTPersonalizacaoClassificacao

Dado Enumerado Descrição TipoDeResultadoEnum

tpceEnum Valores disponíveis:


tpceNenhuma;
tpceNomeDeCamisa;
tpceNumeroDeCamisa;
tpcePatchDeCamisa;
tpceNomeNumeroDeCamisa.

enumTipoControleEstoque

Dado Enumerado Descrição TipoDeResultadoEnum


tceeEnum Valores disponíveis:
tceeControle
tceeNaoControlaNaoSepara
tceeSeparaNaoControla

Página 6 de 137
MÉTODOS WSWMS

AlterarRastreioObjeto

Conceito

Método que permite a alteração do número de rastreio de objetos previamente cadastrados sistema no KPL.

Objetivo

Alterar o objeto de rastreio do pedido.

Pré-requisitos

O pedido deve estar em um dos status a seguir: PRONTO PARA FATURAR, FATURADO, PROBLEMA ENTREGA e
EM SEPARAÇÃO.

Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig. Descrição


AlterarRastreioObjeto

pChaveIdentificacao String 36 Chave de Identificação WebService

pCodigoPedidoInterno Int - Chave única que identifica o pedido.


pNroObjetoOriginal String 50 Número que identifica o produto no sistema KPL.
pNroObjetoNovo String 50 Numero do novo objeto

LAYOUT RESPONSE

Campo Tipo Max Descrição

AlterarRastreioObjeto

Resultado

Codigo Int - Código do Webservice: Operação realizada

Descricao String 255 Descrição do erro

Tipo Enum - Valores possíveis: enumTipo

ExceptionMessage String 255 Mensagem de erro

XML de exemplo

1. O número do objeto do pedido testado foi alterado com sucesso

Página 7 de 137
REQUEST
<soapenv:Body>
<abac:AlterarRastreioObjeto>
<abac:pChaveIdentificacao>1580A94C-11FB-48D8-82E5-
FFC6324771F4</abac:pChaveIdentificacao>
<abac:pCodigoPedidoInterno>5581</abac:pCodigoPedidoInterno>
<abac:pNroObjetoOriginal>AT000000031BR</abac:pNroObjetoOriginal>
<abac:pNroObjetoNovo>AF000641099BR</abac:pNroObjetoNovo>
</abac:AlterarRastreioObjeto>
</soapenv:Body>

RESPONSE
<soap:Body>
<AlterarRastreioObjetoResponse xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<AlterarRastreioObjetoResult>
<Codigo>200001</Codigo>
<Descricao>Operação "Alteração o NroObjeto de remessa de shipment" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</AlterarRastreioObjetoResult>
</AlterarRastreioObjetoResponse>
</soap:Body>

Regras de negócio

Não se aplica.

AssociarFornecedorProduto

Conceito

Permite associar fornecedores ao produto, definir o fornecedor principal e valor do mesmo.


Objetivo

Página 8 de 137
Incluir um novo fornecedor no cadastro do produto
Pré-requisitos

O registro do produto e do fornecedor deve existir cadastrados na base de dados do KPL. Propriedades
LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


AssociarFornecedorProduto

ChaveIdentificacao String 36 Chave de Identificação WebService

ListaFornecedor

Rows

DadosAssociarFornecedorProdutoRows

CodigoProduto String 50 Código do Produto

CodigoProdutoAbacos Int - Código do Produto KPL

Fornecedor String 50 Fornecedor (CNPJ ou CPF)

CodigoFornecedor String 50 Fornecedor (Código Interno no KPL)

PrazoEntrega Int - Prazo de Entrega

Padrao Bool - Padrão (True)

CodigoFabricante String 40 Fabricante (Código Interno no KPL)

Qualificada Bool - Qualificada (True)

ReposicaoDias Int - Reposição Dias

EntregaDias Int - Entrega Dias

ProcessamentoInterno Int - Processamento Interno

DescontoCompra Float - Desconto Compra

CnpjFornecedor String 20 CNPJ Fornecedor

PrecoCompraBruto Float - Preço Compra Bruto

LAYOUT RESPONSE

Campo Tipo Max Descrição


AssociarFornecedorProdutoResult

VersaoWebservice String Versão do webservice


ResultadoOperacao

Int - Código do Webservice: Operação realizada


Codigo
Descricao String 255 Descrição do erro
Tipo Enum - Valores possíveis: enumTipo
Rows

Página 9 de 137
AssociarFornecedorResultado

CodigoProduto String 50 Código externo do produto


CodigoFornecedor String 50 Código do fornecedor
Resultado

Codigo Int - Código do Webservice: Operação realizada


Descricao String 255 Descrição do erro
Tipo Enum - Valores possíveis: enumTipo
ExceptionMessage String 255 Mensagem de erro
XML de exemplo

Um novo fornecedor foi associado ao cadastro do produto

REQUEST
<soapenv:Body>
<abac:AssociarFornecedorProduto>
<abac:ChaveIdentificacao>1580A94C-11FB-48D8-82E5-
FFC6324771F4</abac:ChaveIdentificacao>
<abac:ListaFornecedor>
<abac:DadosAssociarFornecedorProdutoRows>
<abac:CodigoProduto>WSWMSALT</abac:CodigoProduto>
<abac:CodigoProdutoAbacos>6495</abac:CodigoProdutoAbacos>
<abac:Fornecedor>42274696002561</abac:Fornecedor>
<abac:CodigoFornecedor>49</abac:CodigoFornecedor>
<abac:PrazoEntrega>5</abac:PrazoEntrega>
<abac:Padrao>true</abac:Padrao>
<abac:CodigoFabricante>49</abac:CodigoFabricante>
<abac:Qualificada>true</abac:Qualificada>
<abac:ReposicaoDias>5</abac:ReposicaoDias>
<abac:EntregaDias>5</abac:EntregaDias>
<abac:ProcessamentoInterno>5</abac:ProcessamentoInterno>
<abac:DescontoCompra>5</abac:DescontoCompra>
<abac:CnpjFornecedor>42274696002561</abac:CnpjFornecedor>
<abac:PrecoCompraBruto>100.00</abac:PrecoCompraBruto>
</abac:DadosAssociarFornecedorProdutoRows>
</abac:Rows>
</abac:ListaFornecedor>
</abac:AssociarFornecedorProduto>
</soapenv:Body>

Página 10 de 137
RESPONSE
<soap:Body>
<AssociarFornecedorProdutoResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<AssociarFornecedorProdutoResult>
<VersaoWebservice>5.0.89.0</VersaoWebservice>
<ResultadoOperacao>
<Codigo>0</Codigo>
<Tipo>tdreIndefinido</Tipo>
</ResultadoOperacao>
<Rows>
<AssociarFornecedorResultado>
<CodigoProduto>WSWMSALT</CodigoProduto>
<CodigoFornecedor>49</CodigoFornecedor>
<Resultado>
<Codigo>200001</Codigo>
<Descricao>Operação "Associar o fornecedor ao produto" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo> </Resultado>
</AssociarFornecedorResultado>
</Rows>
</AssociarFornecedorProdutoResult>
</AssociarFornecedorProdutoResponse>
</soap:Body> Regras
de negócio

Não se aplica.

AtualizarSaldoProduto

Conceito

O método AtualizarSaldoProduto foi desenvolvido para permitir atualizar o saldo de estoque dos produtos no
KPL via webservice.

Objetivo

Permite atualizar saldo de estoque dos produtos.

Pré-requisitos

Só poderão ser alterados saldo de produtos já existentes na base de dados do KPL.

Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


AtualizarSaldoProduto

String 36 Identificação única da interface

ChaveIdentificacao
ListaDeSaldos

DadosSaldoProduto

Página 11 de 137
CodigoProduto String 50 Código do produto

CodigoBarras String 50 Código de barras do produto

SaldoDisponivel Float - Saldo disponível


MotivoAtualizacao Char 1 Motivo de atualização:
V = Virtual;
A = Ajuste entrada;
I = Ajuste por inventário
T = Transferência
NomeAlmoxarifado String 50 Nome do almoxarifado
CustoBruto Float - Valor Unitário do Custo Bruto do Produto
CustoLiquido Float - Valor Unitário do Custo Liquido do Produto

LAYOUT RESPONSE

Campo Tipo Max Descrição


AtualizarSaldoProdutoResult

VersaoWebservice String Versão do webservice


ResultadoOperacao

Codigo Int - Código do Webservice: Operação realizada


Descricao String 255 Descrição do erro
Tipo Enum - Valores possíveis: enumTipo

Rows

DadosSaldoProdutoResultado

CodigoProduto String 50 Código Externo Produto


CodigoBarras String 50 Código de Barras do Produto
Resultado

Codigo Int - Código do Webservice: Operação realizada


Descricao String 255 Descrição do erro
Tipo Enum - Valores possíveis: enumTipo
ExceptionMessage String 255 Mensagem de erro
XML de exemplo

O saldo e custo médio do item é alterado de acordo com a quantidade inclusa no estoque, ou seja, o saldo é
atualizado para mais ou menos de acordo com os números submetidos e um novo custo médio é calculado
sobre o valores e quantidades inclusos.

Página 12 de 137
REQUEST
<soapenv:Body>
<abac:AtualizarSaldoProduto>
<abac:ChaveIdentificacao>1580A94C-11FB-48D8-82E5-
FFC6324771F4</abac:ChaveIdentificacao>
<abac:ListaDeSaldos>
<abac:DadosSaldoProduto>
<abac:CodigoProduto>WSWMSEST</abac:CodigoProduto>
<abac:CodigoBarras>9900000006129</abac:CodigoBarras>
<abac:SaldoDisponivel>200</abac:SaldoDisponivel>
<abac:MotivoAtualizacao>Integracao</abac:MotivoAtualizacao>
<abac:NomeAlmoxarifado>FATURAMENTO</abac:NomeAlmoxarifado>
<abac:CustoBruto>10.00</abac:CustoBruto>
<abac:CustoLiquido>10.00</abac:CustoLiquido>
</abac:DadosSaldoProduto>
</abac:ListaDeSaldos>
</abac:AtualizarSaldoProduto>
</soapenv:Body>

RESPONSE
<soap:Body>
<AtualizarSaldoProdutoResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<AtualizarSaldoProdutoResult>
<VersaoWebservice>5.0.89.0</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200002</Codigo>
<Descricao>OK.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosSaldoProdutoResultado>
<CodigoProduto>WSWMSEST</CodigoProduto>
<CodigoBarras>9900000006129</CodigoBarras>
<Resultado>
<Codigo>200002</Codigo>
<Descricao>OK.</Descricao>
<Tipo>tdreSucesso</Tipo>
</Resultado>
</DadosSaldoProdutoResultado>
</Rows>
</AtualizarSaldoProdutoResult>
</AtualizarSaldoProdutoResponse>
</soap:Body>

Página 13 de 137
Regras de negócio

Não se aplica.

Página 14 de 137
CheckoutItem

Conceito

Efetuar o Checkount dos Itens do Pedido. A cada chamada o método tenta efetuar a CONCLUSÃO da separação
de mercadorias.

Objetivo

Disponibilizar os itens do pedido para o processo de faturamento

Pré-requisitos

O pedido não pode estar em status de “Pronto para Faturar” ou “Separação Concluída”

Propriedades

A seguir seguem os campos que compõem o método:

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


CheckoutItem

String 36 Chave de Identificação WebService


ChaveIdentificacao
NumeroPedido String 50 Número do Pedido
CodigoCaixa String 50 Código do Caixa
ItensPedido

DadosItensCheckout

CodigoProduto String 50 Código do Produto


CodigoBarrasProduto String 50 Código de Barras do Produto
Quantidade Double - Quantidade
Rastreabilidade String 50 Código do Lote ou Número de Série do Item
Estoque String 1 Estoque
Observação String 200 Dados Adicionais
Identidade String Informação adicional do processo de separação do
pedido.

LAYOUT RESPONSE

Campo Tipo Max Descrição


CheckoutItemResult

VersaoWebservice String Versão do webservice

ResultadoOperacao

Codigo Int - Código do Webservice: Operação realizada

Descricao String 255 Descrição do erro

Página 15 de 137
Tipo Enum - Valores possíveis: enumTipo

Rows

DadosPedidosItemResultado

Resultado

Codigo Int - Código do Webservice: Operação realizada

Descricao String 255 Descrição do erro

Tipo Enum - Valores possíveis: enumTipo


ExceptionMessage String 255 Mensagem de erro

XML de exemplo

Após o Checkout do pedido o status do mesmo é alterado para “Pronto para Faturar”.

Status Pré Check-out

Status Pós Check-out

Página 16 de 137
REQUEST
<soapenv:Body>
<abac:CheckoutItem>
<abac:ChaveIdentificacao>1580A94C-11FB-48D8-82E5-
FFC6324771F4</abac:ChaveIdentificacao>
<abac:NumeroPedido>PQ2616</abac:NumeroPedido>
<abac:CodigoCaixa>01</abac:CodigoCaixa>
<abac:ItensPedido>
<abac:DadosItensCheckout>
<abac:CodigoProduto>CSOSN102</abac:CodigoProduto>
<abac:CodigoBarrasProduto>000000000006129</abac:CodigoBarrasProduto>
<abac:Quantidade>1</abac:Quantidade> <abac:Rastreabilidade></abac:Rastreabilidade>
<abac:Estoque></abac:Estoque>
<abac:Observacao>Separado via Integracao</abac:Observacao>
</abac:DadosItensCheckout>
</abac:ItensPedido>
</abac:CheckoutItem>
</soapenv:Body>

RESPONSE
<soap:Body>
<CheckoutItemResponse xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<CheckoutItemResult>
<VersaoWebservice>5.0.89.0</VersaoWebservice>
<ResultadoOperacao>
<Codigo>0</Codigo>
<Tipo>tdreIndefinido</Tipo>
</ResultadoOperacao>
<Rows>
<DadosPedidosItemResultado>
<Resultado>
<Codigo>200002</Codigo>
<Descricao>OK.</Descricao>
<Tipo>tdreSucesso</Tipo>
</Resultado>
</DadosPedidosItemResultado>
</Rows>
</CheckoutItemResult>
</CheckoutItemResponse>
</soap:Body>

Regras de negócio
Página 17 de 137
Não se aplica.

CheckoutItem2

Conceito

Efetuar o checkout dos itens do pedido. A cada chamada o método tenta efetuar a CONCLUSÃO da separação
de mercadorias.

Objetivo

Disponibilizar os itens do pedido para o processo de faturamento

Pré-requisitos

O pedido não pode estar em status de “Estoque Reservado Parcialmente” ou “Em Separação”.

Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


CheckoutItem2

ChaveIdentificacao String 36 Chave de Identificação Webservice


NumeroPedido String 50 Número do Pedido
CodigoCaixa String 50 Código do Caixa
CodigoPedidoAbacos Int - Código do Pedido KPL
ItensPedido

DadosItensCheckout

CodigoProduto String 50 Código do Produto


CodigoBarrasProduto String 50 Código de Barras do Produto
Quantidade Double - Quantidade
Rastreabilidade String 30 Código do Lote ou Número de Série do Item

Página 18 de 137
Estoque String 1 Indica se há estoque no operador logístico
[S] im
[N] ão
Se não for enviado assume [S].
Observação String 200 Dados Adicionais
Identidade String Informação adicional do processo de separação do
pedido.

LAYOUT RESPONSE

Campo Tipo Max Descrição


CheckoutItem2Result

VersaoWebservice String Versão do webservice

ResultadoOperacao

Codigo Int - Código do Webservice: Operação realizada

Descricao String 255 Descrição do erro

Tipo Enum - Valores possíveis: enumTipo

Rows

DadosPedidosItemResultado

Resultado

Codigo Int - Código do Webservice: Operação realizada

Descricao String 255 Descrição do erro

Tipo Enum - Valores possíveis: enumTipo

ExceptionMessage String 255 Mensagem de erro


XML de exemplo

LAYOUT REQUEST
<soapenv:Body>
<abac:CheckoutItem2>
<abac:ChaveIdentificacao>?</abac:ChaveIdentificacao>
<abac:NumeroPedido>?</abac:NumeroPedido>
<abac:CodigoCaixa>?</abac:CodigoCaixa>
<abac:CodigoPedidoAbacos>?</abac:CodigoPedidoAbacos>
<abac:ItensPedido>
<abac:DadosItensCheckout>
<abac:CodigoProduto>?</abac:CodigoProduto>
<abac:CodigoBarrasProduto>?</abac:CodigoBarrasProduto>
<abac:Quantidade>?</abac:Quantidade>
<abac:Rastreabilidade>?</abac:Rastreabilidade>
<abac:Estoque>?</abac:Estoque>
<abac:Observacao>?</abac:Observacao>
</abac:DadosItensCheckout>
</abac:ItensPedido>
</abac:CheckoutItem2>
</soapenv:Body>
LAYOUT RESPONSE
<soap:Body>
Página 19 de 137
<CheckoutItem2Response xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<CheckoutItem2Result>
<VersaoWebservice>?</VersaoWebservice>
<ResultadoOperacao>
<Codigo>?</Codigo>
<Tipo>?</Tipo>
</ResultadoOperacao>
<Rows>
<DadosPedidosItemResultado>
<Resultado>
<Codigo>?</Codigo>
<Descricao>?</Descricao>
<Tipo>?</Tipo>
</Resultado>
</DadosPedidosItemResultado>
</Rows>
</CheckoutItem2Result>
</CheckoutItem2Response>
</soap:Body>

Impactos no KPL

Após o checkout do pedido o status do mesmo é alterado para “Pronto para Faturar”.

Pré Checkout

Pós Checkout

Página 20 de 137
REQUEST
<soapenv:Body>
<abac:CheckoutItem2>
<abac:ChaveIdentificacao>1580A94C-11FB-48D8-82E5-
FFC6324771F4</abac:ChaveIdentificacao>
<abac:NumeroPedido>PQ2714</abac:NumeroPedido>
<abac:CodigoCaixa>01</abac:CodigoCaixa>
<abac:CodigoPedidoAbacos>2714</abac:CodigoPedidoAbacos>
<abac:ItensPedido>
<abac:DadosItensCheckout>
<abac:CodigoProduto>RAS01</abac:CodigoProduto>
<!--Optional:-->
<abac:CodigoBarrasProduto>000000000006124</abac:CodigoBarrasProduto>
<abac:Quantidade>1</abac:Quantidade>
<abac:Rastreabilidade>L0205</abac:Rastreabilidade>
<abac:Estoque>S</abac:Estoque>
<abac:Observacao>Separado via Integracao</abac:Observacao>
</abac:DadosItensCheckout>
</abac:ItensPedido>
</abac:CheckoutItem2> </soapenv:Body>

RESPONSE
<soap:Body>
<CheckoutItem2Response xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<CheckoutItem2Result>
<VersaoWebservice>5.0.89.0</VersaoWebservice>
<ResultadoOperacao>
<Codigo>0</Codigo>
<Tipo>tdreIndefinido</Tipo>
</ResultadoOperacao>
<Rows>
<DadosPedidosItemResultado>
<Resultado>
<Codigo>200002</Codigo>
<Descricao>OK.</Descricao>
<Tipo>tdreSucesso</Tipo>
</Resultado>
</DadosPedidosItemResultado>
</Rows>
</CheckoutItem2Result>
</CheckoutItem2Response>
</soap:Body>

Página 21 de 137
Regras de negócio

Não se aplica.

CheckoutItemComVolumes

Conceito

O método CheckoutItemComVolumes foi desenvolvido para permitir efetuar o checkout dos itens do pedido,
podendo informar também os volumes. A cada chamada o método tenta efetuar a CONCLUSÃO da separação
de mercadorias.

Objetivo

Efetuar o checkout dos itens do pedido, podendo informar também os volumes.


Pré-requisitos

 O pedido tem que estar com o status de separação “EM SEPARAÇÃO”. Caso o pedido esteja com outro
status, será retornada a mensagem: “[CHKOUTITE] Pedido não foi separado!, Efetue a separação do pedido
antes do Check-Out.”

Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


CheckoutItemComVolumes

ChaveIdentificacao String 36 Chave de identificação da interface.


Dados

NumeroPedido String 50 Código Externo que identifica o pedido de venda no


KPL.
CodigoCaixa String 50 Código externo do caixa, pedido entra na fila de
faturamento automático
ItensCheckOut

Página 22 de 137
DadosItensCheckoutWMS

CodigoProduto String 50 Código Externo Produto, campo chave para


localizar o produto. Ou utilize Código de Barras
Quantidade Int - Quantidade de itens para o checkout
Rastreabilidade String 30 Código de rastreabilidade do item.
Estoque Char 1 Indica se há estoque no operador logístico
[S] im
[N] ão
Se não for enviado assume [S].
Observacao String 200 Adiciona anotação ao pedido
Identidade String Informação adicional do processo de separação do
pedido.
Volumes

DadosManutencaoVolumesWMS

NumeroObjeto String 50 Número do rastreio do objeto.


PesoLiquido Int - Peso líquido do volume.
PesoBruto Int - Peso bruto do volume.
Especie String 50 Descrição da espécie do volume.
Marca String 50 Descrição da marca do volume.
Descricao String 50 Descrição do volume.

LAYOUT RESPONSE

Campo Tipo Max Descrição

CheckoutItemComVolumesResult

VersaoWebservice String Versão do webservice

ResultadoOperacao

Codigo Int - Código do Webservice: Operação realizada

Descricao String 255 Descrição do erro

Tipo Enum - Valores possíveis: enumTipo

Rows

CheckoutWMSResultado

NumeroPedido String 50 Código Externo que identifica o pedido de venda no KPL.

Resultado

Codigo Int - Código do Webservice: Operação realizada

Descricao String 255 Descrição do erro

Tipo Enum - Valores possíveis: enumTipo

ExceptionMessage String 255 Mensagem de erro


Página 23 de 137
XML de exemplo

1) Criação do pedido no KPL.

Menu da tela: Comercial e Faturamento -> Consultas -> Pedidos

2) Selecionar o pedido para separação.

Página 24 de 137
3) Execução do método para concluir o checkout com volume.

REQUEST
<soapenv:Body>
<abac:CheckoutItemComVolumes>
<abac:ChaveIdentificacao>1580A94C-11FB-48D8-82E5-
FFC6324771F4</abac:ChaveIdentificacao>
<abac:dados>
<abac:NumeroPedido>ME5624</abac:NumeroPedido>
<abac:ItensCheckOut>
<abac:Rows>
<abac:DadosItensCheckoutWMS>
<abac:CodigoProduto>14335</abac:CodigoProduto>
<abac:Quantidade>1</abac:Quantidade>
<abac:Estoque>S</abac:Estoque> <abac:Observacao>Teste
checkout WMS</abac:Observacao> </abac:DadosItensCheckoutWMS>
</abac:Rows>
</abac:ItensCheckOut>
<abac:Volumes>
<abac:Rows>
<abac:DadosManutencaoVolumesWMS>
<abac:PesoLiquido>10</abac:PesoLiquido>
<abac:PesoBruto>10</abac:PesoBruto>
<abac:Especie>CAIXA</abac:Especie>
<abac:Marca>CAIXA</abac:Marca> <abac:Descricao>Teste
checkout WMS</abac:Descricao>
</abac:DadosManutencaoVolumesWMS>
</abac:Rows>
</abac:Volumes>
</abac:dados>
</abac:CheckoutItemComVolumes>
</soapenv:Body>

RESPONSE
<soap:Body>
<CheckoutItemComVolumesResponse xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<CheckoutItemComVolumesResult>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200002</Codigo>
<Descricao>OK.</Descricao>
<Tipo>tdreSucesso</Tipo>
Página 25 de 137
</ResultadoOperacao>
<Rows>
<CheckoutWMSResultado>
<NumeroPedido>ME5624</NumeroPedido>
<Resultado>
<Codigo>200001</Codigo>
<Descricao>Operação "Concluir Separação de itens do pedido" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</Resultado>
</CheckoutWMSResultado>
</Rows>
</CheckoutItemComVolumesResult>
</CheckoutItemComVolumesResponse>
</soap:Body>

4) Tela do KPL com o volume adicionado através do método.

5) Após a execução do método, o status do pedido fica como “PRONTO PARA


FATURAR”.

Página 26 de 137
Regras de negócio

Não se aplica.

ConcluirSeparacaoMercadoria

Conceito

Concluir a Separação de Mercadoria

Objetivo

Concluir o processo de separação da mercadoria após o checkout

Pré-requisitos

O pedido não pode estar em um dos status abaixo:

- Status do pedido: 9 - ESTOQUE RESERVADO PARCIALMENTE


- Status do pedido: 11 – FATURADO
- Status do pedido: 10 - PRONTO PARA FATURAR
- Status do pedido: 27 – DESPACHADO

Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


ConcluirSeparacaoMercadoria

ChaveIdentificacao String 36 Identificação única da interface


NumeroPedido String 50 Número do Pedido
Página 27 de 137
CodigoCaixa String 50 Código do Caixa

LAYOUT RESPONSE

Campo Tipo Max Descrição

ConcluirSeparacaoMercadoriaResponse

Codigo Int - Código do Webservice: Operação realizada

Descricao String 255 Descrição

Tipo Enum - Valores possíveis: enumTipo

XML de exemplo

Pré Separação

Pós Separação

Página 28 de 137
REQUEST
<soapenv:Body>
<abac:ConcluirSeparacaoMercadoria> <abac:ChaveIdentificacao>1580A94C-11FB48D8-
82E5-
FFC6324771F4</abac:ChaveIdentificacao>
<abac:NumeroPedido>PQ3054</abac:NumeroPedido>
<abac:CodigoCaixa>01</abac:CodigoCaixa>
</abac:ConcluirSeparacaoMercadoria>
</soapenv:Body>

RESPONSE
<soap:Body>
<ConcluirSeparacaoMercadoriaResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<ConcluirSeparacaoMercadoriaResult> <Codigo>200001</Codigo>
<Descricao>Operação "Sinalizar o pedido como separado" efetuada com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ConcluirSeparacaoMercadoriaResult>
</ConcluirSeparacaoMercadoriaResponse>
</soap:Body>
Regras de negócio
Não se
aplica.

Página 29 de 137
ConcluirSeparacaoNaoConformidade

Conceito

Concluir a Separação de Mercadoria com itens em não conformidade

Objetivo

Concluir a separação de mercadorias em não conformidade.

Pré-requisitos

O pedido de venda deve existir na base de dados do KPL.

Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


ConcluirSeparacaoNaoConformidade

ChaveIdentificacao String 36 Identificação única da interface


NumeroPedido String 50 Número do Pedido
CodigoCaixa String 50 Código do Caixa

LAYOUT RESPONSE

Campo Tipo Max Descrição

ConcluirSeparacaoNaoConformidadeResult

Codigo Int - Código do Webservice: Operação realizada

Descricao String 255 Descrição

Tipo Enum - Valores possíveis: enumTipo

XML de exemplo

Pré Separação

Página 30 de 137
Pós Separação

REQUEST
<soapenv:Body>
<abac:ConcluirSeparacaoNaoConformidade>
<abac:ChaveIdentificacao>1580A94C-11FB-48D8-82E5-
FFC6324771F4</abac:ChaveIdentificacao>
<abac:NumeroPedido>PQ2639</abac:NumeroPedido>
<abac:CodigoCaixa>01</abac:CodigoCaixa>
</abac:ConcluirSeparacaoNaoConformidade>
</soapenv:Body>

RESPONSE
<soap:Body>
<ConcluirSeparacaoNaoConformidadeResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<ConcluirSeparacaoNaoConformidadeResult>
<Codigo>200001</Codigo>
<Descricao>Operação "Concluir a separação do pedido com itens em não conformidade"
efetuada com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ConcluirSeparacaoNaoConformidadeResult>

Página 31 de 137
</ConcluirSeparacaoNaoConformidadeResponse> </soap:Body>

Regras de negócio

Não se aplica.

ConfirmarFornecedores

Conceito

O método ConfirmarFornecedores foi desenvolvido para permitir informar que registro com os dados dos
fornecedores foi recebido e integrado corretamente.

Objetivo

Uma vez que o registro com os dados de fornecedores ficou disponível para integração, ele se torna um item
de uma lista até que seja retirado da mesma. Para retirá-lo da lista é necessário informar que a sua integração
foi bem sucedida. Caso a confirmação não ocorra o registro irá permanecer na lista.

Pré-requisitos

O protocolo de integração referente aos dados dos fornecedores tem que existir na base de dados de
integração.

Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


ConfirmarFornecedores

ProtocoloFornecedor String 255 Protocolo do fornecedor

LAYOUT RESPONSE

Campo Tipo Max Descrição

ConfirmarFornecedoresResult

Codigo Int - Código do Webservice: Operação realizada

Descricao String 255 Descrição

Tipo Enum - Valores possíveis: enumTipo

ExceptionMessage String 255 Mensagem de erro

XML de exemplo

1) Execução do método para confirmação de recebimento e integração dos dados de fornecedores.


<soapenv:Body>
Página 32 de 137
<abac:ConfirmarFornecedores>
<abac:ProtocoloFornecedor>915E0405-5D0B-4100-8E58-
59D8D87B1460</abac:ProtocoloFornecedor>
</abac:ConfirmarFornecedores>
</soapenv:Body>

2) Retorno do método de confirmação de recebimento e integração dos dados dos fornecedores.


<soap:Body>
<ConfirmarFornecedoresResponse xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<ConfirmarFornecedoresResult>
<Codigo>200001</Codigo>
<Descricao>Operação "Confirmação da integração do cliente/fornecedor" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ConfirmarFornecedoresResult>
</ConfirmarFornecedoresResponse>
</soap:Body>

3) Após a execução, o registro com os dados de fornecedores não fica mais disponível para integração.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<ConfirmarFornecedoresResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
< ConfirmarFornecedoresResult>
<VersaoWebservice>5.0.89.0</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porém não há dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
</ConfirmarFornecedoresResponseResult>
</ConfirmarFornecedoresResponseResponse>
</soap:Body>
</soap:Envelope>

Regras de negócio

Não se aplica.

ConfirmarPedidosDisponiveis

Conceito

O método ConfirmarPedidosDisponiveis foi desenvolvido para permitir informar que o pedido foi recebido e
integrado corretamente.

Objetivo

Uma vez que o pedido ficou disponível para integração, ele se torna um item de uma lista até que seja retirado
da mesma. Para retirá-lo da lista é necessário informar que a sua integração foi bem sucedida. Caso a
confirmação não ocorra o registro irá permanecer na lista.

Pré-requisitos

Página 33 de 137
O protocolo de integração do pedido tem que existir na base de dados de integração.

Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


ConfirmarRecebimentoPedido

ProtocoloPedido String 36 Protocolo do pedido

LAYOUT RESPONSE

Campo Tipo Max Descrição

ConfirmarRecebimentoPedidoResult

Codigo Int - Código do Webservice: Operação realizada

Descricao String 255 Descrição

Tipo Enum - Valores possíveis: enumTipo

ExceptionMessage String 255 Mensagem de erro

XML de exemplo

1) Execução do método para confirmação de recebimento e integração do pedido de venda.


<soapenv:Body>
<abac:ConfirmarPedidosDisponiveis>
<abac:ProtocoloPedido>05AC85FC-7211-47B8-86C5-12C1542F57F8</abac:ProtocoloPedido>
</abac:ConfirmarPedidosDisponiveis>
</soapenv:Body>

2) Retorno do método de confirmação de recebimento e integração do pedido de venda.


<soap:Body>
<ConfirmarPedidosDisponiveisResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<ConfirmarPedidosDisponiveisResult>
<Codigo>200001</Codigo>
<Descricao>Operação "Confirmação de integração de pedidos" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ConfirmarPedidosDisponiveisResult>
</ConfirmarPedidosDisponiveisResponse>
</soap:Body>

3) Após a execução, o registro com os dados do pedido de venda não fica mais disponível para integração.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<PedidosDisponiveisResponse xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<PedidosDisponiveisResult>
<VersaoWebservice>5.0.89.0</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porém não há dados.</Descricao>

Página 34 de 137
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
</PedidosDisponiveisResult>
</PedidosDisponiveisResponse>
</soap:Body>
</soap:Envelope>

Regras de negócio

 Os pedidos são disponibilizados a cada status configurado no cadastro da interface. Ou seja, é


disponibilizado status por status e não o status mais atual do pedido.

Página 35 de 137
ConfirmarProdutosDisponiveis

Conceito

O método ConfirmarProdutosDisponiveis foi desenvolvido para permitir informar que o produto foi recebido
e integrado corretamente.

Objetivo

Uma vez que o produto ficou disponível para integração, ele se torna um item de uma lista até que seja
retirado da mesma. Para retirá-lo da lista é necessário informar que a sua integração foi bem sucedida. Caso
a confirmação não ocorra o registro irá permanecer na lista.

Pré-requisitos

O protocolo de integração do pedido tem que existir na base de dados de integração.

Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


ConfirmarRecebimentoProduto

ProtocoloProduto String 36 Protocolo do produto

LAYOUT RESPONSE

Campo Tipo Max Descrição


ConfirmarRecebimentoPedidoResult

Int - Código do Webservice: Operação realizada


Codigo
Descricao String 255 Descrição
Tipo Enum - Valores possíveis: enumTipo
ExceptionMessage String 255 Mensagem de erro

XML de exemplo

1) Execução do método para confirmação de recebimento e integração do produto.


<soapenv:Body>
<abac:ConfirmarProdutosDisponiveis>
<abac:ProtocoloProduto>A5EF5F82-F0C1-4CD2-A8F8-85FC273B9B49</abac:ProtocoloProduto>
</abac:ConfirmarProdutosDisponiveis>
</soapenv:Body>

2) Retorno do método de confirmação de recebimento e integração do produto.


<soap:Body>
<ConfirmarProdutosDisponiveisResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<ConfirmarProdutosDisponiveisResult>
<Codigo>200001</Codigo>
<Descricao>Operação "Confirmação da inclusão de produtos" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
Página 36 de 137
</ConfirmarProdutosDisponiveisResult>
</ConfirmarProdutosDisponiveisResponse> </soap:Body>

3) Após a execução do método, o produto não fica mais disponível para integração.

<soap:Body>
<ProdutosDisponiveisResponse xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<ProdutosDisponiveisResult>
<VersaoWebservice>5.0.89.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porém não há dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
</ProdutosDisponiveisResult>
</ProdutosDisponiveisResponse>
</soap:Body>

Regras de negócio

Não se aplica.

Página 37 de 137
ConfirmarRecebimentoNotaFiscalEntrada

Conceito

O método ConfirmarRecebimentoNotaFiscalEntrada foi desenvolvido para permitir informar que a nota fiscal
foi recebida e integrada corretamente.

Objetivo

Uma vez que a nota fiscal ficou disponível para integração, ela se torna um item de uma lista até que seja
retirado da mesma. Para retirá-lo da lista é necessário informar que a sua integração foi bem sucedida. Caso
a confirmação não ocorra o registro irá permanecer na lista.

2Pré-requisitos

O protocolo de integração da nota fiscal tem que existir na base de dados de integração.

Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


ConfirmarRecebimentoNotaFiscalEntrada

ProtocoloNotaFiscal String 36 Protocolo da nota fiscal

LAYOUT RESPONSE

Campo Tipo Max Descrição

ConfirmarRecebimentoNotaFiscalEntradaResult

VersaoWebservice String Versão do webservice

ResultadoOperacao

Codigo Int - Código do Webservice: Operação realizada

Descricao String 255 Descrição do erro

Tipo Enum - Valores possíveis: enumTipo

XML de exemplo

1) Execução do método para confirmação de recebimento e integração da nota fiscal.


<soapenv:Body>
<abac:ConfirmarRecebimentoNotaFiscalEntrada>
<abac:ProtocoloNotaFiscal>816ab842-a61e-4a8a-91db-
3f85a55dc536</abac:ProtocoloNotaFiscal>
</abac:ConfirmarRecebimentoNotaFiscalEntrada>
</soapenv:Body>

2) Retorno do método de confirmação de recebimento e integração da nota fiscal.


<soap:Body>
<ConfirmarRecebimentoNotaFiscalEntradaResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<ConfirmarRecebimentoNotaFiscalEntradaResult>
<Codigo>200001</Codigo>
Página 38 de 137
<Descricao>Operação "Confirma o envio das notas fiscais" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ConfirmarRecebimentoNotaFiscalEntradaResult>
</ConfirmarRecebimentoNotaFiscalEntradaResponse>
</soap:Body>

3) Após a execução, o registro com os dados de clientes e fornecedores não fica mais disponível para
integração.
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<ConfirmarRecebimentoNotaFiscalEntradaResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<ConfirmarRecebimentoNotaFiscalEntradaResult>
<VersaoWebservice>5.0.89.0</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porém não há dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
</ConfirmarRecebimentoNotaFiscalEntradaResult>
</ConfirmarRecebimentoNotaFiscalEntradaResponse>
</soap:Body>
</soap:Envelope>

Regras de negócio

 Confirmar recebimento do registro


Uma vez que o registro fica disponível para integração, é necessário informar que o mesmo foi recebido
e integrado corretamente para que não fique mais disponível na fila de integração. A confirmação de
recebimento e integração, deve ser feita através do método ConfirmarRecebimentoNotaFiscalEntrada.

ConfirmarRecebimentoNotaFiscalSaida

Conceito

O método ConfirmarRecebimentoNotaFiscal foi desenvolvido para permitir informar que a nota fiscal foi
recebida e integrada corretamente.

2.13.2 Objetivo

Uma vez que a nota fiscal ficou disponível para integração, ela se torna um item de uma lista até que seja
retirado da mesma. Para retirá-lo da lista é necessário informar que a sua integração foi bem sucedida. Caso
a confirmação não ocorra o registro irá permanecer na lista.

Pré-requisitos

O protocolo de integração da nota fiscal tem que existir na base de dados de integração.

Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


Página 39 de 137
ConfirmarRecebimentoNotaFiscalSaida

ProtocoloNotaFiscal String 36 Protocolo da nota fiscal

LAYOUT RESPONSE

Campo Tipo Max Descrição

ConfirmarRecebimentoNotaFiscalSaidaResult

VersaoWebservice String Versão do webservice

ResultadoOperacao

Codigo Int - Código do Webservice: Operação realizada

Descricao String 255 Descrição do erro

Tipo Enum - Valores possíveis: enumTipo

XML de exemplo

1) Execução do método para confirmação de recebimento e integração da nota fiscal.


<soapenv:Body>
<abac:ConfirmarRecebimentoNotaFiscalSaida>
<abac:ProtocoloNotaFiscal>99b46edf-7c05-47b8-ac79-
4e77c6091199</abac:ProtocoloNotaFiscal>
</abac:ConfirmarRecebimentoNotaFiscalSaida>
</soapenv:Body>

2) Retorno do método de confirmação de recebimento e integração da nota fiscal.


<soap:Body>
<ConfirmarRecebimentoNotaFiscalSaidaResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<ConfirmarRecebimentoNotaFiscalSaidaResult>
<Codigo>200001</Codigo>
<Descricao>Operação "Confirma o envio das notas fiscais" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ConfirmarRecebimentoNotaFiscalSaidaResult>
</ConfirmarRecebimentoNotaFiscalSaidaResponse> </soap:Body>

3) Após a execução, o registro com os dados de clientes e fornecedores não fica mais
disponível para integração.
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<ConfirmarRecebimentoNotaFiscalSaidaResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<ConfirmarRecebimentoNotaFiscalSaidaResult>
<VersaoWebservice>5.0.89.0</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porém não há dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
</ConfirmarRecebimentoNotaFiscalSaidaResult>
</ConfirmarRecebimentoNotaFiscalSaidaResponse>

Página 40 de 137
</soap:Body>
</soap:Envelope>

Regras de negócio

 Confirmar recebimento do registro


Uma vez que o registro fica disponível para integração, é necessário informar que o mesmo foi recebido
e integrado corretamente para que não fique mais disponível na fila de integração. A confirmação de
recebimento e integração, deve ser feita através do método ConfirmarRecebimentoNotaFiscalSaida.

ConfirmarRecebimentoSepararPedido

Conceito

Quando um pedido se torna disponível para integração ele se torna um item de uma lista até que seja retirado
da mesma. Para retirá-lo da lista e iniciar o processo de separação é necessário informar que a sua integração
foi bem sucedida. Este método deve ser usado para isso. Caso a confirmação não ocorra à mesma irá
permanecer na lista indefinidamente. Tem a mesma funcionalidade do método
[ConfirmarRecebimentoSepararPedido] do WSPEDIDOSDISPONIVEIS.ASMX

Objetivo

Disponibilizar o pedido para o processo de separação

Pré-requisitos

Identificar os pedidos disponíveis para integração por meio do método PedidosDisponiveis, identificar o
número do protocolo do pedido e efetuar a confirmação de recebimento do mesmo.

Propriedades
LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


ConfirmarRecebimentoSepararPedido

ProtocoloPedido String 36 Número do protocolo do pedido

LAYOUT RESPONSE

Campo Tipo Max Descrição

ConfirmarRecebimentoSepararPedidoResult

Codigo Int - Código do Webservice: Operação realizada

Descricao String 255 Descrição do erro

Tipo Enum - Valores possíveis: enumTipo

XML de exemplo

Página 41 de 137
REQUEST
<soapenv:Body>
<abac:ConfirmarRecebimentoSepararPedido>
<abac:ProtocoloPedido>3A859D74-652B-4EB2-978C-2D3B57774453</abac:ProtocoloPedido>
</abac:ConfirmarRecebimentoSepararPedido> </soapenv:Body>

RESPONSE
<soap:Body>
<ConfirmarRecebimentoSepararPedidoResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<ConfirmarRecebimentoSepararPedidoResult>
<Codigo>200001</Codigo>
<Descricao>Operação "Confirmar a integração e iniciar a separação de pedido" efetuada
com sucesso.</Descricao> <Tipo>tdreSucesso</Tipo>
</ConfirmarRecebimentoSepararPedidoResult>
</ConfirmarRecebimentoSepararPedidoResponse> </soap:Body>

Regras de negócio

Não se aplica.

Página 42 de 137
ConfirmarStatusPedidoDisponiveis

Conceito

O método ConfirmarRecebimentoStatusPedido foi desenvolvido para permitir informar que o status do


pedido de venda foi recebido e integrado corretamente.

Objetivo

Uma vez que o status do pedido de venda ficou disponível para integração, ele se torna um item de uma lista
até que seja retirado da mesma. Para retirá-lo da lista é necessário informar que a sua integração foi bem
sucedida. Caso a confirmação não ocorra o registro irá permanecer na lista.

Pré-requisitos

O protocolo de integração do status do pedido de venda tem que existir na base de dados de integração.

Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


ConfirmarRecebimentoStatusPedido

ProtocoloPedido String 36 Número do protocolo do pedido

LAYOUT RESPONSE

Campo Tipo Max Descrição

ConfirmarRecebimentoStatusPedidoResult

Codigo Int - Código do Webservice: Operação realizada

Descricao String 255 Descrição do erro

Tipo Enum - Valores possíveis: enumTipo

ExceptionMessage String 255 Mensagem de erro

XML de exemplo

1) Execução do método para confirmação de recebimento e integração do status do pedido.


<soapenv:Body>
<abac:ConfirmarStatusPedidoDisponiveis>
<abac:ProtocoloStatusPedido>4B6F10B1-1475-4399-B26B-
E5CD801E3342</abac:ProtocoloStatusPedido>
</abac:ConfirmarStatusPedidoDisponiveis> </soapenv:Body>

2) Retorno do método de confirmação de recebimento e integração do status do pedido.


<soap:Body>
<ConfirmarStatusPedidoDisponiveisResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<ConfirmarStatusPedidoDisponiveisResult>
<Codigo>200001</Codigo>
<Descricao>Operação "Atualiza o protocolo de envio de status" efetuada com
sucesso.</Descricao>
Página 43 de 137
<Tipo>tdreSucesso</Tipo>
</ConfirmarStatusPedidoDisponiveisResult>
</ConfirmarStatusPedidoDisponiveisResponse> </soap:Body>

3) Após a execução do método, o status do pedido não fica mais disponível para integração.
<soap:Body>
<StatusPedidoDisponiveisResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<StatusPedidoDisponiveisResult>
<VersaoWebservice>5.0.89.0</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porém não há dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
</StatusPedidoDisponiveisResult>
</StatusPedidoDisponiveisResponse>
</soap:Body>

Regras de negócio

Não se aplica

Página 44 de 137
ConsultaStatusSefaz

Conceito

O método ConsultaStatusSefaz foi desenvolvido para permitir consultar o histórico do status da nota fiscal
retornado pela Sefaz. A consulta é realizada a partir do código do pedido de venda.

Objetivo

Consultar o histórico retornado pela Sefaz da nota fiscal relacionada ao pedido

Pré-requisitos

O pedido de venda deve existir na base de dados do KPL.

Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


ConsultaStatusSefaz

ChaveIdentificacao String 36 Identificação única da interface


CodigoPedidoInterno Float - Código do pedido no KPL

LAYOUT RESPONSE

Campo Tipo Max Descrição


ConsultaStatusSefazResult

VersaoWebservice String Versão do webservice

ResultadoOperacao

Codigo Int Código do Webservice: Operação realizada


Descricao String 255 Descrição do erro
Tipo Enum Valores possíveis: enumTipo
Rows

DadosStatusSefazNota

DataHora String 14 DDMMAAAA HH:MM


SerieNota String 3 Serie nota fiscal
NumeroNota Int - Número da nota fiscal
CodigoStatusNotaAbacos Int - Código do status da nota no KPL
StatusNota String 50 Status da nota
StatusEnvioSefaz String - Status do envio
CodigoSefaz String - Código Sefaz
MsgSefaz String 255 Mensagem Sefaz

Página 45 de 137
XML de exemplo

1) Execução do método para retorno do histórico do status da nota fiscal.

REQUEST
<soapenv:Body>
<abac:ConsultaStatusSefaz>
<abac:ChaveIdentificacao>1580A94C-11FB-48D8-82E5-
FFC6324771F4</abac:ChaveIdentificacao>
<abac:CodigoPedidoInterno>5294</abac:CodigoPedidoInterno>
</abac:ConsultaStatusSefaz>
</soapenv:Body> RESPONSE
<soap:Body>
<ConsultaStatusSefazResponse xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<ConsultaStatusSefazResult>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operação "Histórico status Sefaz" efetuada com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosStatusSefazNota>
<DataHora>10092014 08:33</DataHora>
<SerieNota>801</SerieNota>
<NumeroNota>3080</NumeroNota>
<CodigoStatusNotaAbacos>6</CodigoStatusNotaAbacos>
<StatusNota>FINALIZADA</StatusNota>
<StatusEnvioSefaz>Nota fiscal aprovada pela Sefaz</StatusEnvioSefaz>
<CodigoSefaz>100</CodigoSefaz>
<MsgSefaz>Autorizado o uso da NF-e</MsgSefaz>
</DadosStatusSefazNota>
</Rows>
</ConsultaStatusSefazResult>
</ConsultaStatusSefazResponse>
</soap:Body>

Regras de negócio

Não se aplica.

EnviarPedidosParaDespacho

Conceito
O método EnviarPedidosParaDespacho foi desenvolvido para permitir associar os pedidos aos lotes de despacho da
transportadora para o processo de despacho de mercadoria.

Objetivo
Associar os pedidos aos lotes de despacho da transportadora para o processo de despacho de mercadoria.

Pré-requisitos

 O status do pedido enviado para despacho deve ser “Faturado”. Caso o pedido esteja com outro status,
será retornada a mensagem: “[RPLPDSENVDES] Interface = 17 Pedido (Código interno) - 5613 - Pedido não
localizado ou ainda não faturado.”

Propriedades

LAYOUT REQUEST

Página 46 de 137
Campo Tipo Max Obrig Descrição
EnviarPedidosParaDespacho

ChaveIdentificacao String 36 Chave única de identificação da interface.


ListaDeNumerosDePedidos

DadosListaPedidos

NumeroPedido String 50 Número do pedido


CodigoPedido int - Código do pedido no KPL
LAYOUT RESPONSE

Campo Tipo Max Descrição


EnviarPedidosParaDespachoResult

VersaoWebservice String Versão do webservice


ResultadoOperacao

Codigo Int - Código do Webservice: Operação realizada


Descricao String 255 Descrição do erro
Tipo Enum - Valores possíveis: enumTipo
Rows

DadosPedidosResultado

NumeroDoPedido String 50 Número do pedido


Resultado

Codigo Int - Código do Webservice: Operação realizada


Descricao String 255 Descrição do erro
Tipo Enum - Valores possíveis: enumTipo
ExceptionMessage String 255 Mensagem de erro

XML de exemplo

1) Faturamento do pedido para enviar para despacho.

Página 47 de 137
2) Execução do método para relacionar o pedido a um lote de despacho.
REQUEST
<soapenv:Body>
<abac:EnviarPedidosParaDespacho>
<abac:ChaveIdentificacao>1580A94C-11FB-48D8-82E5-
FFC6324771F4</abac:ChaveIdentificacao>
<abac:ListaDeNumerosDePedidos>
<abac:DadosListaPedidos>
<abac:NumeroPedido>ME5614</abac:NumeroPedido>
<abac:CodigoPedido>5614</abac:CodigoPedido>
</abac:DadosListaPedidos>
</abac:ListaDeNumerosDePedidos>
</abac:EnviarPedidosParaDespacho>
</soapenv:Body>

RESPONSE
<soap:Body>
<EnviarPedidosParaDespachoResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<EnviarPedidosParaDespachoResult>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operação "Associar os pedidos aos lotes da transportadoras para
despachado de mercadorias" efetuada com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosPedidosResultado>
<NumeroDoPedido>5614</NumeroDoPedido>
<Resultado>
<Codigo>200001</Codigo>
<Descricao>Operação "Associar os pedidos aos lotes da transportadoras para
despachado de mercadorias" efetuada com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</Resultado>
</DadosPedidosResultado>
</Rows>
</EnviarPedidosParaDespachoResult>
</EnviarPedidosParaDespachoResponse>
</soap:Body>

Página 48 de 137
3) Tela do KPL com o pedido relacionado ao lote de despacho.

Regras de negócio

 Ao enviar o pedido para despacho, ele será associado ao lote de despacho aberto mais recente e caso não
tenha nenhum lote de despacho com status “ABERTO”, o KPL cria um lote para relacionar o pedido
enviado no método.

 Caso seja enviado um pedido já relacionado a um lote de despacho, será retornada a mensagem:
“Checkout do produto [AB000000650BR ] já realizado neste lote
[RPLPDSENVDES] Interface = 17 Pedido (Código interno) - 5614 - Erro! Ao associar o volume
[AB000000650BR ] no lote numero: 142.”

 Pode ser enviado um pedido ou uma lista de pedidos de uma única vez.

EnviarRastreioObjeto

Conceito

Método que permite o cadastro de número de rastreio de objetos no sistema KPL.

Objetivo

Castrar o número do rastreio do objeto no sistema KPL

Pré-requisitos

 O pedido deve estar como o status “PRONTO PARA FATURAR”.

Propriedades

LAYOUT REQUEST

Página 49 de 137
Campo Tipo Max Obrig Descrição
EnviarRastreioObjeto

pChaveIdentificacao String 250 Identificação única da interface


pCodigoPedidoInterno Int - Código do Pedido Interno
pCodigoProduto Int - Código do Produto
pQuantidade Int - Quantidade
pNroObjeto String 50 Número do Objeto

LAYOUT RESPONSE

Campo Tipo Max Descrição


EnviarRastreioObjetoResult

Codigo Int - Código do Webservice: Operação realizada

Descricao String 255 Descrição

Tipo Enum - Valores possíveis: enumTipo

ExceptionMessage String 255 Mensagem de erro

XML de exemplo

Pré inclusão do número de rastreio do objeto no pedido.

Pós inclusão do número de rastreio do objeto no pedido.

Página 50 de 137
REQUEST
<soapenv:Body>
<abac:EnviarRastreioObjeto>
<abac:pChaveIdentificacao>1580A94C-11FB-48D8-82E5-
FFC6324771F4</abac:pChaveIdentificacao>
<abac:pCodigoPedidoInterno>2012</abac:pCodigoPedidoInterno>
<abac:pCodigoProduto>4015</abac:pCodigoProduto>
<abac:pCodigoProduto>4016</abac:pCodigoProduto>
<abac:pCodigoProduto>4017</abac:pCodigoProduto>
<abac:pCodigoProduto>4018</abac:pCodigoProduto>
<abac:pQuantidade>1</abac:pQuantidade>
<abac:pQuantidade>1</abac:pQuantidade>
<abac:pQuantidade>1</abac:pQuantidade>
<abac:pQuantidade>1</abac:pQuantidade>
<abac:pNroObjeto>SR12345679BR</abac:pNroObjeto>
</abac:EnviarRastreioObjeto>
</soapenv:Body>

RESPONSE
<soap:Body>
<EnviarRastreioObjetoResponse xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<EnviarRastreioObjetoResult>
<Codigo>200001</Codigo>
<Descricao>Operação "Atualização de objeto de remessa de shipment" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</EnviarRastreioObjetoResult>
</EnviarRastreioObjetoResponse> </soap:Body>

Regras de negócio

Não se aplica.

EstoqueOnLine

Conceito

Página 51 de 137
O método EstoqueOnline foi desenvolvido para permitir consultar o saldo de estoque de determinado produto
ou uma lista de produtos existentes na base de dados do KPL.

Objetivo

Através desse método é possível obter o saldo de estoque de qualquer produto com a posição do momento,
ou seja, obter o saldo de estoque online.

Pré-requisitos

A informação se torna disponível para integração quando ocorre uma inclusão, alteração ou exclusão de
alguma informação.

 Ativar replicação na interface

Ativar a replicação no cadastro da interface.

 Habilitar o produto na interface

Para que o produto fique disponível para integração, é necessário habilita-lo na interface.

Página 52 de 137
Menu: Comercial e Faturamento -> Cadastros -> Produtos -> Produtos

 Configurar almoxarifados para integração

Devem ser configurados no cadastro da interface os almoxarifados para integração.

Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


ChavedeIdentificacao String 36 Identificação única da interface
ListaDeCodigosProdutos

String String 50 Código externo do produto

Página 53 de 137
LAYOUT RESPONSE

Campo Tipo Max Descrição

EstoqueOnLineResult

VersaoWebservice String Versão do webservice

ResultadoOperacao

Codigo Int - Código do Webservice: Operação realizada

Descricao String 255 Descrição do erro


Tipo Enum - Valores possíveis: enumTipo

Rows

DadosEstoqueResultado

CodigoProduto String 50 Código do Produto

SaldoMinimo Float - Saldo mínimo


SaldoDisponivel Float - Saldo disponível

ProdutoTipoLigacao Enum - Valores Possíveis: enumProdutoTipoLigacao

Resultado

Codigo Int - Código do Webservice: Operação realizada

Descricao String 255 Descrição do erro

Tipo enum - Valores possíveis: enumTipo

ExceptionMessage String 255 Mensagem de erro

XML de exemplo

1) Execução do método para obter o saldo online do produto 14335.

REQUEST
<soapenv:Body>
<abac:EstoqueOnLine>
<abac:ChaveIdentificacao>1580A94C-11FB-48D8-82E5-
FFC6324771F4</abac:ChaveIdentificacao>
<abac:ListaDeCodigosProdutos>
<abac:String>14335</abac:String>
</abac:ListaDeCodigosProdutos>
</abac:EstoqueOnLine>
</soapenv:Body>

RESPONSE
<soap:Body>
<EstoqueOnLineResponse xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<EstoqueOnLineResult>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200002</Codigo>

Página 54 de 137
<Descricao>OK.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosEstoqueResultado>
<CodigoProduto>14335</CodigoProduto>
<SaldoMinimo>1</SaldoMinimo> <SaldoDisponivel>9</SaldoDisponivel>
<ProdutoTipoLigacao>tptleProdutoSimples</ProdutoTipoLigacao>
<Resultado>
<Codigo>200002</Codigo>
<Descricao>OK.</Descricao>
<Tipo>tdreSucesso</Tipo>
</Resultado>
</DadosEstoqueResultado>
</Rows>
</EstoqueOnLineResult>
</EstoqueOnLineResponse>
</soap:Body>

Regras de negócio

 É possível solicitar o saldo de estoque online de um único produto ou de uma lista de produtos.

 No retorno do método, todos os produtos que estavam presentes na solicitação são apresentados com os
seus respectivos resultados (sucesso ou erro).

Página 55 de 137
FornecedoresDisponiveis

Conceito

O método ClientesFornecedoresDisponiveis foi desenvolvido para disponibilizar informações de clientes e


fornecedores para integração.

Objetivo

Através desse método é possível obter as informações do cadastro de clientes e fornecedores que estão
disponíveis para integração.

Pré-requisitos

A informação se torna disponível para integração quando ocorre uma inclusão, alteração ou exclusão de
alguma informação.

 Habilitar integração dos dados de cliente/fornecedor

Habilitar no cadastro da interface a integração dos dados de cliente/fornecedor.

Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


FornecedoresDisponiveis

ChaveIdentificacao String 36 Identificação única da interface

Página 56 de 137
LAYOUT RESPONSE

Campo Tipo Max Descrição


FornecedoresDisponiveisResult

DadosFornecedorWMS

ProtocoloFornecedor String 255 Protocolo do fornecedor


Acao Enum - Valores disponíveis: enumAcao
CodigoFornecedorAbacos String 50 Código fornecedor KPL
String 50 Número fornecedor
NumeroFornecedor
NomeReduzido String 20 Nome reduzido
String 100 Nome
Nome
TipoPessoa Enum - Valores disponíveis: enumTipoPessoa
CPFouCNPJ Char 14 CPF ou CNPJ
Documento Char 14 Documento
InscricaoEstadual String 15 Inscrição estadual
InscricaoMunicipal String 14 Inscrição municipal
Telefone String 15 Número do telefone
Fax String 15 Número do fax
Celular String 15 Número do celular
EMail String 100 E-mail
Site String 200 Site
Sexo Enum - Valores disponíveis: enumSexo
ContatoNome String 50 Nome do contato
ContatoCargo String 50 Cargo do contato
String 50 Departamento do contato
ContatoDepartamento
ContatoEmail String 100 E-mail do contato
ContatoTelefone String 15 Telefone do contato
ContatoFax String 15 Fax do contato
ContatoCelular String 15 Celular do contato
ContatoDataNascimento String 20 Data de nascimento do contato
Endereco

Logradouro String 80 Endereço


NumeroLogradouro Char 6 Número do logradouro
ComplementoEndereco String 30 Complemento do endereço
Bairro String 60 Bairro
Página 57 de 137
Municipio String 60 Município
Estado String 50 Estado
Cep Char 20 CEP

Página 58 de 137
TipoLocalEntrega Enum - Valores disponíveis: enumTipoLocalEntrega

ReferenciaEndereco String 60 Referência do endereço

XML de exemplo

1) Foram alteradas algumas informações do cliente KPL, tais como: classificação, tipo e endereço.

Página 59 de 137
1) Em seStringa foi executado o método para obter as alterações realizadas no cliente.
REQUEST
<soapenv:Body>
<abac:FornecedoresDisponiveis>
<abac:ChaveIdentificacao>1580A94C-11FB-48D8-82E5-
FFC6324771F4</abac:ChaveIdentificacao>
</abac:FornecedoresDisponiveis>
</soapenv:Body>

RESPONSE
<soap:Body>
<FornecedoresDisponiveisResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<FornecedoresDisponiveisResult>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operação "Listar os clientes/fornecedores disponíveis" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosFornecedorWMS>
<ProtocoloFornecedor>915E0405-5D0B-4100-8E58-
59D8D87B1460</ProtocoloFornecedor>
<Acao>aieManutencao</Acao>
<CodigoFornecedorAbacos>1</CodigoFornecedorAbacos>
<NumeroFornecedor>KPL</NumeroFornecedor>
<NomeReduzido>KPL</NomeReduzido>
<Nome>KPL SOLUÇÕES LTDA</Nome>
<TipoPessoa>tpeJuridica</TipoPessoa>
<CPFouCNPJ>05521031000101</CPFouCNPJ>
<Documento/>
<InscricaoEstadual>206001784110</InscricaoEstadual>
<InscricaoMunicipal>557444-1</InscricaoMunicipal>
<Telefone>1141953780</Telefone>
<Fax>1141953780</Fax>
<Celular>11963965759</Celular>
<EMail>homologacaokpl@gmail.com</EMail>
<Site>www.kplsolucoes.com.br</Site>
<Sexo>tseEmpresa</Sexo>
Página 60 de 137
<ContatoNome>CONTATO KPL</ContatoNome>
<ContatoCargo>CONTATO KPL</ContatoCargo>
<ContatoDepartamento>CONTATOS</ContatoDepartamento>
<ContatoEmail>contato@kplsolucoes.com,br</ContatoEmail>
<ContatoTelefone>(11)2424-7380</ContatoTelefone>
<ContatoFax>(11)5555-5555</ContatoFax>
<ContatoCelular>(11)99999-9999</ContatoCelular>
<ContatoDataNascimento/>
<Endereco>
<Logradouro>Alameda Cauaxi</Logradouro>
<NumeroLogradouro>350</NumeroLogradouro>
<ComplementoEndereco>5° andar</ComplementoEndereco>
<Bairro>ALPHAVILLE INDUSTRIAL</Bairro>
<Municipio>BARUERI</Municipio>
<Estado>SP</Estado>
<Cep>06454020</Cep>
<TipoLocalEntrega>tleeComercial</TipoLocalEntrega>
<ReferenciaEndereco/>
</Endereco>
</DadosFornecedorWMS>
</Rows>
</FornecedoresDisponiveisResult>
</FornecedoresDisponiveisResponse>
</soap:Body>

Regras de negócio

 Confirmar recebimento do registro


Uma vez que o registro fica disponível para integração, é necessário informar que o mesmo foi recebido
e integrado corretamente para que não fique mais disponível na fila de integração. A confirmação de
recebimento e integração, deve ser feita através do método ConfirmarFornecedores.

InformaRupturaTotal

Conceito

O método InformarRupturaTotal foi desenvolvido para permitir informar ruptura total de estoque no processo
de separação do pedido de venda.

Objetivo

Informar Ruptura total de estoque no processo de separação do pedido de venda.

Pré-requisitos

O pedido de venda deve existir na base de dados do KPL e estar com o status de separação “EM SEPARAÇÃO”.

Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


InformaRupturaTotal

ChaveIdentificacao String 36 Chave de Identificação Webservice


Página 61 de 137
NumeroPedido String 50 Numero do pedido
CodigoCaixa String 50 Código da caixa

LAYOUT RESPONSE

Campo Tipo Max Descrição

InformaRupturaTotalResult

Codigo Int - Código do Webservice: Operação realizada

Descricao String 255 Descrição do erro

Tipo Enum - Valores possíveis: enumTipo

ExceptionMessage String 255 Mensagem de erro

XML de exemplo

1) Tentativa de execução do método sem fazer o checkout de nenhum item.


REQUEST
<soapenv:Body>
<abac:InformaRupturaTotal>
<abac:ChaveIdentificacao>1580A94C-11FB-48D8-82E5-
FFC6324771F4</abac:ChaveIdentificacao> <abac:NumeroPedido>ME5625</abac:NumeroPedido>
</abac:InformaRupturaTotal>
</soapenv:Body>

RESPONSE
<soap:Body>
<InformaRupturaTotalResponse xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<InformaRupturaTotalResult>
<Codigo>300005</Codigo>
<Descricao>A execução da rotina gerou uma crítica. Detalhes: * Origem: Informar
ruptura total de estoque * Linha em que ocorreu o erro: 53 * Nome do objeto onde ocorreu o erro:
PGEN_P_RAISERROR * Código de erro do banco de dados: 50000</Descricao>
<Tipo>tdreErroDataBase</Tipo>
<ExceptionMessage>FAÇA CHECKOUT DE PELO MENOS UM ITEM PARA CONTINUAR [RPLPDSCONSEP]
Interface = 17 Msg = Pedido (Número) [ME5625] - não foi possível concluir a separação do
pedido.</ExceptionMessage> </InformaRupturaTotalResult>
</InformaRupturaTotalResponse>
</soap:Body>

2) Execução do método para informar ruptura total no pedido após fazer o checkout de um item.
REQUEST
<soapenv:Body>
<abac:InformaRupturaTotal>
<abac:ChaveIdentificacao>1580A94C-11FB-48D8-82E5-
FFC6324771F4</abac:ChaveIdentificacao>
<abac:NumeroPedido>ME5625</abac:NumeroPedido>
</abac:InformaRupturaTotal>
</soapenv:Body>

RESPONSE
<soap:Body>
<InformaRupturaTotalResponse xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<InformaRupturaTotalResult>

Página 62 de 137
<Codigo>200001</Codigo>
<Descricao>Operação "Informar ruptura total de estoque" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</InformaRupturaTotalResult>
</InformaRupturaTotalResponse>
</soap:Body>

3) Tela do KPL após informar a ruptura total.

Comportamento do KPL via tela.

Página 63 de 137
Regras de negócio

Não se aplica.

ListarMovimentacaoEstoqueProduto

Conceito

O método ListarMovimentacaoEstoqueProduto foi desenvolvido para listar as movimentações de estoque de


um determinado produto, da mais recente para mais antiga, podendo limitar a quantidade de registros
selecionados.

Objetivo

Listar as movimentações de estoque de um determinado produto.

Pré-requisitos

Não se aplica.

Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


ListarMovimentacaoEstoqueProduto

ChaveIdentificacao String 36 Chave única de identificação da interface.

CodigoProduto String 50 Código do produto

QtdeRegistros Int - Quantidade de registros

Página 64 de 137
LAYOUT RESPONSE

Campo Tipo Max Descrição


ListarMovimentacaoEstoqueProdutoResult

VersaoWebservice String Versão do webservice

ResultadoOperacao

Codigo Int - Código do Webservice: Operação realizada


Descricao String 255 Descrição do erro
Tipo Enum - Valores possíveis: enumTipo
Rows

DadosMovEstoqueProduto

CodigoMovimentacao Int - Código de Movimentação


DataMovimentacao String 14 Data da movimentação

DataCadastro String 14 Data de cadastro


Almoxarifado String 100 Almoxarifado
SiglaAlmoxarifado String 3 Sigla do Almoxarifado

Ent_Sai String 1 Entrada ou Saída


AbrevTipoMovimentacao String 3 Abreviação do tipo de movimentação
TipoMovimentacao String 100 Tipo de movimentação
Lote_NoSerie String 30 Número de série
LoteDataValidade String 14 Data de validade
SaldoAnterior Float - Saldo anterior
QtdeMovimentada Float - Quantidade movimentada
ValorLiqMovimentacao Float - Valor líquido da movimentação
ValorBrutoMovimentacao Float - Valor bruto movimentação

CustoLiquido Float - Custo líquido


CustoBruto Float - Custo bruto
EntradaCustoMedio String 1 Entrada custo médio
OrigemMovimentacao String 50 Origem da movimentação
DocumentoOrigem String 14 Documento de origem
Usuario String 100 Usuário
Observacao String 200 Observação

XML de exemplo

1) Tela do KPL com a consulta da movimentação de estoque.


Página 65 de 137
2) Execução do método para obter a movimentação do item 14335.

REQUEST
<soapenv:Body>
<abac:ListarMovimentacaoEstoqueProduto>
<abac:ChaveIdentificacao>1580A94C-11FB-48D8-82E5-
FFC6324771F4</abac:ChaveIdentificacao>
<abac:CodigoProduto>14335</abac:CodigoProduto>
</abac:ListarMovimentacaoEstoqueProduto> </soapenv:Body>

RESPONSE
<soap:Body>
<ListarMovimentacaoEstoqueProdutoResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<ListarMovimentacaoEstoqueProdutoResult>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operação "Movimentações de estoque de um produto" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosMovEstoqueProduto>
<CodigoMovimentacao>21955</CodigoMovimentacao>
<DataMovimentacao>25022016 10:56</DataMovimentacao>
<DataCadastro>25022016 10:56</DataCadastro>
<Almoxarifado>FATURAMENTO</Almoxarifado>
<SiglaAlmoxarifado>FAT</SiglaAlmoxarifado>
<Ent_Sai>S</Ent_Sai>
<AbrevTipoMovimentacao>SIN</AbrevTipoMovimentacao>
<TipoMovimentacao>SAÍDA - INTEGRAÇÃO</TipoMovimentacao>
<Lote_NoSerie/>
<LoteDataValidade/>
<SaldoAnterior>10</SaldoAnterior>
<QtdeMovimentada>3</QtdeMovimentada>
<ValorLiqMovimentacao>30</ValorLiqMovimentacao>
<ValorBrutoMovimentacao>30</ValorBrutoMovimentacao>
<CustoLiquido>10</CustoLiquido>
<CustoBruto>10</CustoBruto>

Página 66 de 137
<EntradaCustoMedio>S</EntradaCustoMedio>
<OrigemMovimentacao>Mov. externa (integração)</OrigemMovimentacao>
<DocumentoOrigem>2502</DocumentoOrigem>
<Usuario>INTEGRACAO WMS</Usuario>
<Observacao/>
</DadosMovEstoqueProduto>
<DadosMovEstoqueProduto>
<CodigoMovimentacao>21950</CodigoMovimentacao>
<DataMovimentacao>23022016 21:07</DataMovimentacao>
<DataCadastro>23022016 21:07</DataCadastro>
<Almoxarifado>FATURAMENTO</Almoxarifado>
<SiglaAlmoxarifado>FAT</SiglaAlmoxarifado>
<Ent_Sai>E</Ent_Sai>
<AbrevTipoMovimentacao>E01</AbrevTipoMovimentacao>
<TipoMovimentacao>ENTRADA - COMPRAS</TipoMovimentacao>
<Lote_NoSerie/>
<LoteDataValidade/>
<SaldoAnterior>0</SaldoAnterior>
<QtdeMovimentada>10</QtdeMovimentada>
<ValorLiqMovimentacao>100</ValorLiqMovimentacao>
<ValorBrutoMovimentacao>100</ValorBrutoMovimentacao>
<CustoLiquido>10</CustoLiquido>
<CustoBruto>10</CustoBruto>
<EntradaCustoMedio>N</EntradaCustoMedio>
<OrigemMovimentacao>NF entrada</OrigemMovimentacao>
<DocumentoOrigem>2000002302</DocumentoOrigem>
<Usuario>KPL Soluções</Usuario>
<Observacao/>
</DadosMovEstoqueProduto>
</Rows>
</ListarMovimentacaoEstoqueProdutoResult>
</ListarMovimentacaoEstoqueProdutoResponse>
</soap:Body>

Regras de negócio

 No método é possível limitar a quantidade de registros selecionados.

MarcarPedidosDespachados

Conceito

O método MarcarPedidosDespachados foi desenvolvido para permitir alterar o status do pedido para
“DESPACHADO”.

Objetivo

Permite marcar pedidos como despachados.

Pré-requisitos

Para que o pedido possa ser marcado como despachado, é necessário que esteja com o status “faturado”.
Caso o pedido esteja com outro status, será retornada a mensagem: “[RPLPDSDESENT] Interface = 17 Pedido
(Código interno) - 5613 - A situação atual do pedido não permite a sinalização do pedido como despachado:
- Status do pedido: 13 - AGUARDANDO SEPARACAO DE MERCADORIAS.”.
Página 67 de 137
Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


MarcarPedidosDespachados

ChaveIdentificacao String 36 Chave única de identificação da interface.


ListaDeNumerosDePedidos

DadosListaPedidos

NumeroPedido String 50 Número do pedido


CodigoPedido Int - Código do pedido no KPL

LAYOUT RESPONSE

Campo Tipo Max Descrição

MarcarPedidosDespachadosResult

VersaoWebservice String Versão do webservice

ResultadoOperacao

Codigo Int - Código do Webservice: Operação realizada

Descricao String 255 Descrição do erro

Tipo Enum - Valores possíveis: enumTipo

Rows

DadosPedidosResultado

NumeroDoPedido String 50 Número do pedido

Resultado

Codigo Int - Código do Webservice: Operação realizada

Descricao String 255 Descrição do erro

Tipo Enum - Valores possíveis: enumTipo

ExceptionMessage String 255 Mensagem de erro

XML de exemplo

1) Execução do método para marcar o pedido como despachado.

REQUEST
<soapenv:Body>
<abac:MarcarPedidosDespachados>
Página 68 de 137
<abac:ChaveIdentificacao>1580A94C-11FB-48D8-82E5-
FFC6324771F4</abac:ChaveIdentificacao>
<abac:ListaDeNumerosDePedidos
<abac:DadosListaPedidos>
<abac:NumeroPedido>ME5614</abac:NumeroPedido>
<abac:CodigoPedido>5614</abac:CodigoPedido>
</abac:DadosListaPedidos>
</abac:ListaDeNumerosDePedidos>
</abac:MarcarPedidosDespachados>
</soapenv:Body>

RESPONSE
<soap:Body>
<MarcarPedidosDespachadosResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<MarcarPedidosDespachadosResult>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operação "Sinalizar o pedido como despachado" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosPedidosResultado>
<NumeroDoPedido>5614</NumeroDoPedido>
<Resultado>
<Codigo>200001</Codigo>
<Descricao>Operação "Sinalizar o pedido como despachado" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</Resultado>
</DadosPedidosResultado>
</Rows>
</MarcarPedidosDespachadosResult>
</MarcarPedidosDespachadosResponse>
</soap:Body>

2) Tela do pedido com o status “DESPACHADO”.

Página 69 de 137
Regras de negócio

 Pode ser enviado um pedido ou uma lista de pedidos de uma única vez.

MarcarPedidosEntregues

Conceito

O método MarcarPedidosEntregues foi desenvolvido para permitir alterar o status do pedido para
“ENTREGUE”.

Objetivo

Permite marcar pedidos como entregue.

Pré-requisitos

Para que o pedido possa ser marcado como entregue, é necessário que esteja com o status “despachado”.
Caso o pedido esteja com outro status, será retornada a mensagem: <ExceptionMessage>[PedidoEntregue]
Interface = 17 Pedido (Código interno) - 89 - A situação atual do pedido não permite a sinalização do pedido
como entregue:- Status do pedido: 28 - ENTREGUE</ExceptionMessage>”.

Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição

Página 70 de 137
MarcarPedidosEntregues

ChaveIdentificacao String 36 Chave única de identificação da interface.


ListaDeNumerosDePedidos

DadosPedidosRecebedor

NumeroPedido String 50 Número do pedido


CodigoPedido Int - Código do pedido no KPL
DataEntrega String - Data Entrega do pedido no KPL
NomeRecebedor String - Nome do Recebedor do pedido no KPL
DocumentoRecebedor String - Documento do Recebedo do pedido no KPL

LAYOUT RESPONSE

Campo Tipo Max Descrição


MarcarPedidosEntreguesResult

VersaoWebservice String Versão do webservice


ResultadoOperacao

Codigo Int - Código do Webservice: Operação realizada


Descricao String CodigoPedido
Tipo Enum - Valores possíveis: enumTipo
Rows

DadosPedidosResultado

NumeroDoPedido String 50 Número do pedido


Resultado

Codigo Int - Código do Webservice: Operação realizada


Descricao String 255 Descrição do erro
Tipo Enum - Valores possíveis: enumTipo
ExceptionMessage String 255 Mensagem de erro

XML de exemplo

1) Execução do método para marcar o pedido como entregue.

LAYOUT REQUEST
<soapenv:Body>
<abac:MarcarPedidosEntregues>
<abac:ChaveIdentificacao>2EE8060F-31B0-48F6-A9FA-
D9CEA45226CF</abac:ChaveIdentificacao>
<abac:ListaDeNumerosDePedidos>
<abac:DadosPedidosRecebedor>
<abac:NumeroPedido>13872</abac:NumeroPedido>
<abac:CodigoPedido>89</abac:CodigoPedido>
<abac:DataEntrega>15032017</abac:DataEntrega>
<abac:NomeRecebedor>Recebedor</abac:NomeRecebedor>
<abac:DocumentoRecebedor>12345678</abac:DocumentoRecebedor>
</abac:DadosPedidosRecebedor>
Página 71 de 137
</abac:ListaDeNumerosDePedidos>
</abac:MarcarPedidosEntregues>
</soapenv:Body> LAYOUT
RESPONSE
<soap:Body>
<MarcarPedidosEntreguesResponse xmlns="http://www.kplsolucoes.com.br/ABACOSWebService">
<MarcarPedidosEntreguesResult>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operação "Sinalizar o pedido como entregue" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<VersaoWebService>5.99.0.22837</VersaoWebService>
<Rows>
<DadosPedidosResultado> <NumeroDoPedido>89</NumeroDoPedido>
<Resultado>
<Codigo>200001</Codigo>
<Descricao>Operação "Sinalizar o pedido como entregue" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</Resultado>
</DadosPedidosResultado>
</Rows>
</MarcarPedidosEntreguesResult>
</MarcarPedidosEntreguesResponse>
</soap:Body>

2) Tela do pedido com o status “ENTREGUE”.

Regras de negócio

 Pode ser enviado um pedido ou uma lista de pedidos de uma única vez.

Página 72 de 137
MovimentarEstoque

Conceito

O método MovimentarEstoque foi desenvolvido para permitir efetuar as movimentações de estoque (entrada
e saída) dos produtos no KPL via webservice.

Objetivo

Efetuar a movimentação de estoque dos produtos diretamente no KPL, ou seja, os lançamentos das entrada
e saídas de estoques dos produtos.

Pré-requisitos

 Ativar replicação na interface

Ativar a replicação no cadastro da interface.

Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


MovimentarEstoque

ChaveIdentificacao String 36 Identificação única da interface


ListaDeMovimentos

DadosMovEstoque

String 255 Identificador de registro do movimento de


ProtocoloMovimentoEstoque estoque
CodigoProduto String 50 Código do produto

Página 73 de 137
CodigoBarras String 50 Código de barras do produto
Quantidade float - Quantidade movimentada
EntradaSaida String 1 Movimentação de "E" Entrada ou "S" Saída
DocumentoNumero String 14 Número do documento
TipoMovimento String Tipo de movimento
TipoMovimentoAbrev String Abreviação do tipo de movimento
TipoMovimentoGrupo String Grupo do tipo de movimento
DataMovimento String Data do movimento
DocumentoOrigem String Data de Origem
String Documento Origem Descrição
DocumentoOrigemDescricao
SaldoAnterior Float Saldo anterior
CodigoEstoqueAbacos String 50 Código do estoque KPL
SiglaEstoque Char 3 Sigla do estoque
Estoque String 255 Estoque

LAYOUT RESPONSE

Campo Tipo Max Descrição

MovimentarEstoqueResult

VersaoWebservice String Versão do webservice

ResultadoOperacao

Codigo Int - Código do Webservice: Operação realizada

Descricao String 255 Descrição do erro


Tipo Enum - Valores possíveis: enumTipo

Rows

DadosMovEstoqueResultado

CodigoProduto String 50 Código do produto


DocumentoNumero String 50 Número do documento

Resultado

Codigo Int - Código do Webservice: Operação realizada

Descricao String 255 Descrição do erro


Tipo Enum - Valores possíveis: enumTipo

ExceptionMessage String 255 Mensagem de erro

Página 74 de 137
XML de exemplo

1) Execução do método para efetuar a movimentação de estoque.

REQUEST
<soapenv:Body>
<abac:MovimentarEstoque>
<abac:ChaveIdentificacao>1580A94C-11FB-48D8-82E5-
FFC6324771F4</abac:ChaveIdentificacao>
<abac:ListaDeMovimentos>
<abac:DadosMovEstoque>
<abac:CodigoProduto>14335</abac:CodigoProduto>
<abac:Quantidade>3</abac:Quantidade>
<abac:EntradaSaida>S</abac:EntradaSaida>
<abac:DocumentoNumero>2502</abac:DocumentoNumero>
<abac:TipoMovimento>SAÍDA - INTEGRAÇÃO</abac:TipoMovimento>
<abac:TipoMovimentoAbrev>SIN</abac:TipoMovimentoAbrev>
<abac:TipoMovimentoGrupo>SAÍDA</abac:TipoMovimentoGrupo>
<abac:DataMovimento>25022016</abac:DataMovimento>
<abac:DocumentoOrigem>INT0002</abac:DocumentoOrigem>
<abac:DocumentoOrigemDescricao>Descrição do documento origem da
movimentação.</abac:DocumentoOrigemDescricao>
<abac:SaldoAnterior>0</abac:SaldoAnterior>
<abac:Estoque>FATURAMENTO</abac:Estoque>
</abac:DadosMovEstoque>
</abac:ListaDeMovimentos>
</abac:MovimentarEstoque> </soapenv:Body>

RESPONSE
<soap:Body>
<MovimentarEstoqueResponse xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<MovimentarEstoqueResult>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200002</Codigo>
<Descricao>OK.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosMovEstoqueResultado>
<CodigoProduto>14335</CodigoProduto>
<DocumentoNumero>2502</DocumentoNumero>
<Resultado>
<Codigo>200002</Codigo>
<Descricao>OK.</Descricao>
<Tipo>tdreSucesso</Tipo>
</Resultado>
</DadosMovEstoqueResultado>
</Rows>
</MovimentarEstoqueResult>
</MovimentarEstoqueResponse>
</soap:Body>

2) Tela do KPL com o registro da movimentação de estoque feita via webservice.

Página 75 de 137
Menu: Estoque -> Consultas -> Movimentações de estoque

Regras de negócio

 Podem ser enviados vários dados de movimentação de estoque do produto de uma única vez.

NotasFiscaisEntradaDisponiveis

Conceito

O método NotasFiscaisEntradaDisponiveis foi desenvolvido para disponibilizar as notas fiscais de entrada


disponíveis para integração.

Objetivo

Através desse método é possível obter as informações de notas fiscais de entrada que estão disponíveis para
integração.

Pré-requisitos

A informação se torna disponível para integração quando ocorre uma inclusão, alteração ou exclusão de
alguma informação.

 Ativar replicação na interface

Ativar a replicação no cadastro da interface.

Página 76 de 137
 Configurar comercializações para integração

Configurar no cadastro da interface, as comercializações para integração.

Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


NotasFiscaisEntradaDisponiveis

ChaveIdentificacao String 36 Identificação única da interface

LAYOUT RESPONSE

Campo Tipo Max Descrição


Página 77 de 137
NotasFiscaisEntradaDisponiveisResult

DadosNotasFiscaisEntradaDisponiveisWMS

ProtocoloNotaFiscal String 255 Identificação única do registro


CodigoNotaFiscal Int - Código interno da Nota Fiscal
NumeroNotaFiscal Int - Número da Nota Fiscal
SerieNotaFiscal String 3 Número da série da Nota Fiscal
EntradaSaida String 1 Identifica se a nota é entrada ou saída, retorna
“E” (entrada) ou “S” (saída).
DataCadastro Datetime - Data do faturamento
DataEmissao Datetime - Data de emissão da Nota Fiscal
NaturezaOperacao String 250 Natureza da operação
VolumesQuantidade Int - Quantidade de volumes da nota.
VolumesEspecie String 50 Espécie do volume
VolumesNumero String 50 Número do volume
VolumesMarca String 50 Marca do volume
VolumesPesoLiquido Float - Peso liquido do volume
VolumesPesoBruto Float - Peso bruto do volume
RemetenteCodigo String 50
RemetenteNome String 100 Nome remetente
RemetenteTipoPessoa String 1 Tipo pessoa remetente
RemetenteCPFouCNPJ String 14 CPF ou CNPJ remetente
RemetenteTelefone String 15 Telefone remetente
RemetenteCelular String 15 Celular remetente
RemetenteFax String 15 Fax remetente
RemetenteEmail String 100 E-mail remetente
RemetenteLogradouro String 88 Logradouro remetente
RemetLogradouro String 80 Numero logradouro remetente
RemetComplemento String 30 Complemento endereço remetente
RemetenteNumeroLogradouro Char 6 Numero logradouro remetente
RemetenteBairro String 60 Bairro remetente
RemetenteCEP String 20 CEP remetente
RemetenteMunicipio String 60 Município remetente
RemetenteEstado String 2 Estado remetente
RemetentePontoReferencia String 60 Ponto referência remetente
RemetenteInscEstadual String 14 Inscrição estadual remetente
TransportadoraNome String 100 Nome da transportadora
TransportadoraCNPJ String 14 CNPJ da transportadora
TransportadoraLogradouro String 88 Endereço da transportadora
TransportadoraBairro String 60 Bairro da transportadora
TransportadoraCEP String 20 CEP da transportadora
TransportadoraMunicipio String 60 Município da transportadora
TransportadoraEstado String 2 Estado da transportadora
TransportadoraTelefone String 15 Telefone da transportadora
TransportadoraInscEstadual String 14 Inscrição estadual da transportadora
GrupoComercializacao Int - Grupo comercialização
CodigoUnidadeNegocio Int - Código unidade de negocio
Comercializacao String 50 Comercialização
Página 78 de 137
CodigoRepresentante Int - Código representante
NomeRepresentante String 50 Nome do representante
Itens

DadosItensNotaFiscalEntradaDisponiveisWMS

Sequencial Int - Sequencial


CodigoPedidoAbacos Int - Código produto KPL
CodigoProduto String 50 Código externo produto
CodigoBarrasProduto String 50 Código barras produto
NomeProduto String 50 Nome do produto
DescritorSimples1 String 50 Descritor simples1
DescritorSimples2 String 50 Descritor simples2
DescritorSimples3 String 50 Descritor simples3
DescritorPreDefinido1 String 100 Descritor pré-definido1
DescritorPreDefinido2 String 100 Descritor pré-definido2
DescritorPreDefinido3 String 100 Descritor pré-definido3
QuantidadeFiscal Float - Quantidade física
QuantidadeFisica Float - Quantidade fiscal
QuantidadeAvariada Float - Quantidade avariada
ValorCustoUnitarioBruto Float - Custo unitário bruto
ValorCustoUnitarioLiquido Float - Custo unitário liquido

XML de exemplo

1) Tela do KPL com a NF disponível para integração.

Menu da tela: Comercial e Faturamento -> Consultas -> Notas fiscais

Página 79 de 137
2) Execução do método para obter a NF de entrada.

REQUEST
<soapenv:Body>
<abac:NotasFiscaisEntradaDisponiveis>
<abac:ChaveIdentificacao>1580A94C-11FB-48D8-82E5-
FFC6324771F4</abac:ChaveIdentificacao>
</abac:NotasFiscaisEntradaDisponiveis>
</soapenv:Body>
RESPONSE
<soap:Body>
<NotasFiscaisEntradaDisponiveisResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<NotasFiscaisEntradaDisponiveisResult>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operação "Cabeçalho das notas de entrada/Saida disponíveis" efetuada
com sucesso.</Descricao> <Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosNotasFiscaisEntradaDisponiveisWMS>
<ProtocoloNotaFiscal>816ab842-a61e-4a8a-91db-
3f85a55dc536</ProtocoloNotaFiscal>
<CodigoNotaFiscal>5156</CodigoNotaFiscal>
<NumeroNotaFiscal>2302</NumeroNotaFiscal>
<SerieNotaFiscal>2</SerieNotaFiscal>
<EntradaSaida>E</EntradaSaida>
<DataCadastro>23/02/2016 21:07:07</DataCadastro>
<DataEmissao>23/02/2016 21:07:07</DataEmissao>
<NaturezaOperacao>ENTRADA</NaturezaOperacao>
<VolumesQuantidade>0</VolumesQuantidade>
<VolumesEspecie/>
<VolumesNumero/>
<VolumesMarca/>
<VolumesPesoLiquido>0</VolumesPesoLiquido>
<VolumesPesoBruto>0</VolumesPesoBruto>
<RemetenteCodigo>KPL</RemetenteCodigo>
<RemetenteNome>KPL SOLUÇÕES LTDA</RemetenteNome>
<RemetenteTipoPessoa>J</RemetenteTipoPessoa>
<RemetenteCPFouCNPJ>05521031000101</RemetenteCPFouCNPJ>
<RemetenteTelefone>1141953780</RemetenteTelefone>

Página 80 de 137
<RemetenteCelular>11963965759</RemetenteCelular>
<RemetenteFax>1141953780</RemetenteFax>
<RemetenteEmail>homologacaokpl@gmail.com</RemetenteEmail>
<RemetenteLogradouro>ALAMEDA MADEIRA, 222 16 Andar - Sala
162</RemetenteLogradouro>
<RemetLogradouro>ALAMEDA MADEIRA</RemetLogradouro>
<RemetComplemento>16 Andar - Sala 162</RemetComplemento>
<RemetenteNumeroLogradouro>222</RemetenteNumeroLogradouro>
<RemetenteBairro>É ALPHAVILLE CENTRO INDUSTR E
EMPRESARIAL</RemetenteBairro>
<RemetenteCEP>06455010</RemetenteCEP>
<RemetenteMunicipio>BARUERI</RemetenteMunicipio>
<RemetenteEstado>SP</RemetenteEstado>
<RemetentePontoReferencia/>
<RemetenteInscEstadual>206001784110</RemetenteInscEstadual>
<TransportadoraNome>CORREIOS</TransportadoraNome>
<TransportadoraCNPJ>68945153000226</TransportadoraCNPJ>
<TransportadoraLogradouro>AV DA SAUDE, 939</TransportadoraLogradouro>
<TransportadoraBairro>NOSSA SENHORA DE FATIMA</TransportadoraBairro>
<TransportadoraCEP>13478640</TransportadoraCEP>
<TransportadoraMunicipio>AMERICANA</TransportadoraMunicipio>
<TransportadoraEstado>SP</TransportadoraEstado>
<TransportadoraTelefone/>
<TransportadoraInscEstadual>ISENTO</TransportadoraInscEstadual>
<GrupoComercializacao>11</GrupoComercializacao>
<CodigoUnidadeNegocio>1</CodigoUnidadeNegocio>
<Comercializacao>COMPRAS</Comercializacao>
<CodigoRepresentante/>
<NomeRepresentante/>
<Itens>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operação "Itens das notas disponíveis" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosItensNotaFiscalEntradaDisponiveisWMS>
<Sequencial>1</Sequencial>
<CodigoProdutoAbacos>6099</CodigoProdutoAbacos>
<CodigoProduto>14335</CodigoProduto>
<CodigoBarrasProduto>000000000006099</CodigoBarrasProduto>
<NomeProduto>Condicionador Ameixa</NomeProduto>
<DescritorSimples1/>
<DescritorSimples2/>
<DescritorSimples3/>
<DescritorPreDefinido1/>
<DescritorPreDefinido2/>
<DescritorPreDefinido3/>
<QuantidadeFiscal>10</QuantidadeFiscal>
<QuantidadeFisica>10</QuantidadeFisica>
<QuantidadeAvariada>0</QuantidadeAvariada>
<ValorCustoUnitarioBruto>10,00</ValorCustoUnitarioBruto>
<ValorCustoUnitarioLiquido>10,00</ValorCustoUnitarioLiquido>
</DadosItensNotaFiscalEntradaDisponiveisWMS>
</Rows>
</Itens>
</DadosNotasFiscaisEntradaDisponiveisWMS>
</Rows>
</NotasFiscaisEntradaDisponiveisResult>
</NotasFiscaisEntradaDisponiveisResponse> </soap:Body>

Página 81 de 137
Regras de negócio

Não se aplica.

NotasFiscaisSaidaDisponiveis

Conceito

O método NotasFiscaisSaidaDisponiveis foi desenvolvido para disponibilizar as notas fiscais de saída


disponíveis para integração.

Objetivo

Através desse método é possível obter as informações de notas fiscais de saída que estão disponíveis para
integração.

Pré-requisitos

A informação se torna disponível para integração quando ocorre uma inclusão, alteração ou exclusão de
alguma informação.

 Ativar replicação na interface

Ativar a replicação no cadastro da interface.

Página 82 de 137
 Definir status de replicação da NFE

Configurar no cadastro de interface os status de replicação da nota fiscal.

 Configurar grupos de comercialização para exportação

Página 83 de 137
Configurar no cadastro de interface os grupos de comercialização para exportação.

 Configurar comercializações para integração

Configurar no cadastro de interface as comercializações para integração.

 Configurar unidades de negócio para integração

Configurar no cadastro de interface as unidade de negócio para exportação da nota fiscal.

Página 84 de 137
2.27.4 Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


NotasFiscaisDisponiveis
ChaveIdentificacao String 36 Identificação única da interface

LAYOUT RESPONSE

Campo Tipo Max Descrição


NotasFiscaisSaidaDisponiveisResult
DadosNotasFiscaisSaidaDisponiveisWMS
ProtocoloNotaFiscal String 255 Identificação única do registro
CodigoNotaFiscal Int - Código interno KPL da Nota Fiscal
NumeroNotaFiscal Int - Número da Nota Fiscal
SerieNotaFiscal String 3 Número da série da Nota Fiscal
EntradaSaida Char 1 Identifica se a nota é entrada ou saída, retorna
“E” (entrada) ou “S” (saída).
DataCadastro Datetime - Data do faturamento
DataEmissao Datetime - Data de emissão da Nota Fiscal
NaturezaOperacao String 250 Natureza da operação
VolumesQuantidade Int - Quantidade de volumes da nota.
VolumesEspecie String 50 Espécie do volume
VolumesNumero String 50 Número do volume
VolumesMarca String 50 Marca do volume
VolumesPesoLiquido Float - Peso liquido do volume
VolumesPesoBruto Float - Peso bruto do volume
VolumesRastreio Float - Volumes rastreio

Página 85 de 137
RemetenteNome String 100 Nome remetente
RemetenteTipoPessoa Enum - Valores disponíveis: enumTipoPessoa
RemetenteCPFouCNPJ Char 14 CPF ou CNPJ remetente
RemetenteTelefone String 15 Telefone remetente
RemetenteCelular String 15 Celular remetente
RemetenteFax String 15 Fax remetente
RemetenteEmail String 100 E-mail remetente
RemetenteLogradouro String 88 Logradouro remetente e numero
RemetenteNumeroLogradouro String 6 Numero logradouro remetente
RemetenteBairro String 60 Bairro remetente
RemetenteCEP String 20 CEP remetente
RemetenteMunicipio String 60 Município remetente
RemetenteEstado String 2 Estado remetente
RemetentePontoReferencia String 60 Ponto referência remetente
RemetenteInscEstadual String 14 Inscrição estadual remetente
TransportadoraNome String 100 Nome da transportadora
TransportadoraCNPJ String 14 CNPJ da transportadora
TransportadoraLogradouro String 88 Endereço da transportadora
TransportadoraBairro String 60 Bairro da transportadora
TransportadoraCEP String 20 CEP da transportadora
TransportadoraMunicipio String 60 Município da transportadora
TransportadoraEstado String 2 Estado da transportadora
TransportadoraTelefone String 15 Telefone da transportadora
TransportadoraInscEstadual String 14 Inscrição estadual da transportadora
TransportadoraServicoEntrega String 100
CodigoPedidoAbacos Int - Código interno do pedido
NumeroPedido String 50 Numero do pedido
CodigoNotaEntradaTroca Int - Código interno da nota fiscal do processo de
troca.
NumeroNotaEntradaTroca Int - Numero da nota fiscal do processo de troca.
SerieNotaEntradaTroca String 3 Serie da nota fiscal do processo de troca.
GrupoComercializacao Int - Grupo da comercialização
CodigoUnidadeNegocio Int - Código da unidade de negócio
Comercializacao String 50 Comercialização
CodigoRepresentante String 50 Código do representante
NomeRepresentante String 100 Nome do representante
ChaveNfe String 50 Chave NFE
RemetLogradouro String 80 Logradouro do remetente
RemetComplemento String 30 Complemento de endereço do remetente
Canal Char 50 Canal
SubCanal Char 50 Subcanal
FinalidadeNfe Int 3 1 = NF-e normal
2 = NF-e complementar
3 = NF-e de ajuste
4 = Devolução de Mercadoria

2.27.5 XML de exemplo

Página 86 de 137
1) Tela do KPL com a NF disponível para integração.

Menu: Comercial e Faturamento -> Consultas -> Notas fiscais

Página 87 de 137
2) Execução do método para obter os dados da NF disponível para integração.
REQUEST
<soapenv:Body>
<abac:NotasFiscaisSaidaDisponiveis>
<abac:ChaveIdentificacao>1580A94C-11FB-48D8-82E5-
FFC6324771F4</abac:ChaveIdentificacao>
</abac:NotasFiscaisSaidaDisponiveis>
</soapenv:Body>

RESPONSE
<soap:Body>
<NotasFiscaisSaidaDisponiveisResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<NotasFiscaisSaidaDisponiveisResult>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200001</Codigo>

Página 88 de 137
<Descricao>Operação "Cabeçalho das notas de entrada/Saida disponíveis" efetuada
com sucesso.</Descricao> <Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosNotasFiscaisSaidaDisponiveisWMS>
<ProtocoloNotaFiscal>99b46edf-7c05-47b8-ac79-
4e77c6091199</ProtocoloNotaFiscal>
<CodigoNotaFiscal>4904</CodigoNotaFiscal>
<NumeroNotaFiscal>3080</NumeroNotaFiscal>
<SerieNotaFiscal>801</SerieNotaFiscal>
<EntradaSaida>S</EntradaSaida>
<DataCadastro>10/09/2014 08:32:57</DataCadastro>
<DataEmissao>10/09/2014 08:32:55</DataEmissao>
<NaturezaOperacao>COMERCIALIZAÇÃO DE MERCADORIAS</NaturezaOperacao>
<VolumesQuantidade>0</VolumesQuantidade>
<VolumesEspecie/>
<VolumesNumero/>
<VolumesMarca/>
<VolumesPesoLiquido>0</VolumesPesoLiquido>
<VolumesPesoBruto>0</VolumesPesoBruto>
<VolumesRastreio>AD000002620BR</VolumesRastreio>
<RemetenteNome>KPL SOLUÇÕES LTDA</RemetenteNome>
<RemetenteTipoPessoa>J</RemetenteTipoPessoa>
<RemetenteCPFouCNPJ>05521031000101</RemetenteCPFouCNPJ>
<RemetenteTelefone>1141953780</RemetenteTelefone>
<RemetenteCelular>11963965759</RemetenteCelular>
<RemetenteFax>1141953780</RemetenteFax>
<RemetenteEmail>homologacaokpl@gmail.com</RemetenteEmail>
<RemetenteLogradouro>ALAMEDA MADEIRA, 222 16 Andar - Sala
162</RemetenteLogradouro>
<RemetenteNumeroLogradouro>222</RemetenteNumeroLogradouro>
<RemetenteBairro>É ALPHAVILLE CENTRO INDUSTR E
EMPRESARIAL</RemetenteBairro>
<RemetenteCEP>06455010</RemetenteCEP>
<RemetenteMunicipio>BARUERI</RemetenteMunicipio>
<RemetenteEstado>SP</RemetenteEstado>
<RemetentePontoReferencia/>
<RemetenteInscEstadual>206001784110</RemetenteInscEstadual>
<TransportadoraNome>CORREIOS</TransportadoraNome>
<TransportadoraCNPJ>68945153000226</TransportadoraCNPJ>
<TransportadoraLogradouro>AV DA SAUDE, 939</TransportadoraLogradouro>
<TransportadoraBairro>NOSSA SENHORA DE FATIMA</TransportadoraBairro>
<TransportadoraCEP>13478640</TransportadoraCEP>
<TransportadoraMunicipio>AMERICANA</TransportadoraMunicipio>
<TransportadoraEstado>SP</TransportadoraEstado>
<TransportadoraTelefone/>
<TransportadoraInscEstadual>ISENTO</TransportadoraInscEstadual>
<TransportadoraServicoEntrega>PAC</TransportadoraServicoEntrega>
<CodigoPedidoAbacos>5294</CodigoPedidoAbacos>
<NumeroPedido>PRE5294</NumeroPedido>
<CodigoNotaEntradaTroca/>
<NumeroNotaEntradaTroca/>
<SerieNotaEntradaTroca/>
<GrupoComercializacao>1</GrupoComercializacao>
<CodigoUnidadeNegocio>1</CodigoUnidadeNegocio>
<Comercializacao>HOMOLOG - VENDA - PRONTO PARA FATURAR</Comercializacao>
<CodigoRepresentante>1</CodigoRepresentante>
<NomeRepresentante>PRÓPRIA EMPRESA</NomeRepresentante>
<ChaveNfe>35140905521031000101558010000030801929187460</ChaveNfe>
<RemetLogradouro>ALAMEDA MADEIRA</RemetLogradouro>
<RemetComplemento>16 Andar - Sala 162</RemetComplemento>
<Canal>Internet</Canal>
<SubCanal>Loja E-commerce</SubCanal>
<FinalidadeNfe>1</FinalidadeNfe> </DadosNotasFiscaisSaidaDisponiveisWMS>
</Rows>
Página 89 de 137
</NotasFiscaisSaidaDisponiveisResult>
</NotasFiscaisSaidaDisponiveisResponse>
</soap:Body>

Regras de negócio

Não se aplica.

Página 90 de 137
ObterXmlNfe

Conceito

O método ObterXmlNfe foi desenvolvido para retornar o XML da NFE enviada para a sefaz.

Objetivo

Este método deve ser utilizado para retornar o XML da NFE.

Pré-requisitos

A NF deve existir na base de dados do KPL.

 Ativar replicação na interface

Ativar a replicação no cadastro da interface.

 Ativar a replicação do XML da NFE

Ativar no cadastro de interface a replicação do XML da NFE.

Página 91 de 137
Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


ObterXmlNfe
ChaveIdentificacao String 36 Chave única de identificação da interface.
CodigoNotaFiscalAbacos Int - Código da nota fiscal no KPL
ChaveNfe String 50 Chave da NF-e

LAYOUT RESPONSE

Campo Tipo Max Descrição


ObterXmlNfeResult

CodigoNotaFiscalAbacos Int - Código nota fiscal KPL


ChaveNfe String 50 Chave da NFe
ProtocoloNfe String 20 Protocolo Nfe
XmlNfe String - XML da Nfe

XML de exemplo

1) Tela do KPL com a NFe.


Página 92 de 137
1) Execução do método para obter o XML da NFe.

REQUEST
<soapenv:Body>
<abac:ObterXmlNfe>
<abac:ChaveIdentificacao>C467DC64-DB41-4340-ADF2-
C327B9553BF3</abac:ChaveIdentificacao>
<abac:CodigoNotaFiscalAbacos>36</abac:CodigoNotaFiscalAbacos>
</abac:ObterXmlNfe>
</soapenv:Body>
RESPONSE
<soap:Body>
<ObterXmlNfeResponse xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<ObterXmlNfeResult>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>

Página 93 de 137
<Codigo>200001</Codigo>
<Descricao>Operação "Obter XML das NFE." efetuada com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosResultadoXMLNFE>
<CodigoNotaFiscalAbacos>36</CodigoNotaFiscalAbacos>
<ChaveNfe>35160220121850000155558040000000281587979397</ChaveNfe>
<ProtocoloNFE>135160000598618</ProtocoloNFE>
<XmlNfe><![CDATA[<?xml version=\"1.0\" encoding=\"utf-8\"?><nfeProc
versao=\"2.00\" xmlns=\"http://www.portalfiscal.inf.br/nfe\"><NFe
xmlns="http://www.portalfiscal.inf.br/nfe"><infNFe versao="3.10"
Id="NFe35160220121850000155558040000000281587979397"><ide><cUF>35</cUF><cNF>58797939</cNF><na
tOp>VENDA DE MERC. ADQ. DE
TERCEIROS</natOp><indPag>0</indPag><mod>55</mod><serie>804</serie><nNF>28</nNF><dhEmi>2016-
02-19T18:08:00-02:00</dhEmi><dhSaiEnt>2016-02-19T18:08:00-
02:00</dhSaiEnt><tpNF>1</tpNF><idDest>2</idDest><cMunFG>3505708</cMunFG><tpImp>1</tpImp><tpEm
is>1</tpEmis><cDV>7</cDV><tpAmb>2</tpAmb><finNFe>1</finNFe><indFinal>1</indFinal><indPres>2</
indPres><procEmi>0</procEmi><verProc>KPL
V50B0090</verProc></ide><emit><CNPJ>20121850000155</CNPJ><xNome>KPL - MERCADO
LIVRE</xNome><xFant>KPL</xFant><enderEmit><xLgr>AL CAUAXI</xLgr><nro>350</nro><xCpl>5
ANDAR</xCpl><xBairro>ALPHAVILLE
INDUSTRIAL</xBairro><cMun>3505708</cMun><xMun>BARUERI</xMun><UF>SP</UF><CEP>06454020</CEP><cP
ais>1058</cPais><xPais>BRASIL</xPais></enderEmit><IE>623068511112</IE><CRT>3</CRT></emit><des
t><CPF>09130937779</CPF><xNome>NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR
FISCAL</xNome><enderDest><xLgr>R
PALATINADO</xLgr><nro>138</nro><xCpl>302</xCpl><xBairro>CASCADURA</xBairro><cMun>3304557</cMu
n><xMun>RIO DE
JANEIRO</xMun><UF>RJ</UF><CEP>21380130</CEP><cPais>1058</cPais><xPais>BRASIL</xPais></enderDe
st><indIEDest>9</indIEDest></dest><det
nItem="1"><prod><cProd>735</cProd><cEAN>9900000000028</cEAN><xProd>Raquete Tenis Wilson Roger
Federer 25
WRT228300</xProd><NCM>95065100</NCM><CEST>0100200</CEST><CFOP>6108</CFOP><uCom>UN</uCom><qCom
>1.0000</qCom><vUnCom>129.000000</vUnCom><vProd>129.00</vProd><cEANTrib>9900000000028</cEANTr
ib><uTrib>UN</uTrib><qTrib>1.0000</qTrib><vUnTrib>129.000000</vUnTrib><indTot>1</indTot></pro
d><imposto><vTotTrib>0.00</vTotTrib><ICMS><ICMS00><orig>0</orig><CST>00</CST><modBC>3</modBC>
<vBC>129.00</vBC><pICMS>12.00</pICMS><vICMS>15.48</vICMS></ICMS00></ICMS><PIS><PISAliq><CST>0
1</CST><vBC>129.00</vBC><pPIS>1.65</pPIS><vPIS>2.13</vPIS></PISAliq></PIS><COFINS><COFINSAliq
><CST>01</CST><vBC>129.00</vBC><pCOFINS>7.60</pCOFINS><vCOFINS>9.80</vCOFINS></COFINSAliq></C
OFINS><ICMSUFDest><vBCUFDest>129.00</vBCUFDest><pFCPUFDest>1.00</pFCPUFDest><pICMSUFDest>18.0
0</pICMSUFDest><pICMSInter>12.00</pICMSInter><pICMSInterPart>40.00</pICMSInterPart><vFCPUFDes
t>1.29</vFCPUFDest><vICMSUFDest>3.10</vICMSUFDest><vICMSUFRemet>4.64</vICMSUFRemet></ICMSUFDe
st></imposto></det><total><ICMSTot><vBC>129.00</vBC><vICMS>15.48</vICMS><vICMSDeson>0.00</vIC
MSDeson><vFCPUFDest>1.29</vFCPUFDest><vICMSUFDest>3.10</vICMSUFDest><vICMSUFRemet>4.64</vICMS
UFRemet><vBCST>0.00</vBCST><vST>0.00</vST><vProd>129.00</vProd><vFrete>0.00</vFrete><vSeg>0.0
0</vSeg><vDesc>0.00</vDesc><vII>0.00</vII><vIPI>0.00</vIPI><vPIS>2.13</vPIS><vCOFINS>9.80</vC
OFINS><vOutro>0.00</vOutro><vNF>129.00</vNF><vTotTrib>0.00</vTotTrib></ICMSTot></total><trans
p><modFrete>0</modFrete></transp><infAdic><infCpl>Valor ICMS UF destino:R$
3,10</infCpl></infAdic></infNFe><Signature
xmlns="http://www.w3.org/2000/09/xmldsig#"><SignedInfo><CanonicalizationMethod
Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" /><SignatureMethod
Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1" /><Reference
URI="#NFe35160220121850000155558040000000281587979397"><Transforms><Transform
Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature" /><Transform
Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" /></Transforms><DigestMethod
Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"
/><DigestValue>9lbW3Fa9VcSjywHZyjpWbVkhTUA=</DigestValue></Reference></SignedInfo><SignatureV
alue>OVU9jdGWZzS9zWYivAXsue0THa6dX4wWgPSxDXptmLFH3r6uv2HmwCM9Od9wzMGytdvVWCqrBUIYyw1RKZVutBG6
byz9SF5xv9ZbEmbOcvEUWd/Eus0fA7MHk89jf+oxjdK0w1Rj0GAAgIFenVxxRCYGue5zE2SCS5Qtwmss4nbcUe6tL9yFW
6PYK3bKkV2+KBgPkFGiyoqUy0QkeNW4CI1/sEFPzGrxOJHU+1a2RyDD9KO+iBgGgVpjXUpJvOy2gxcS/bxz7+QuAUoQtn
GGUh2bRMDleUb2/oPArWSzyoO4lhDK55OU2pr2MWIHXHyfw+DWwnRKTlgSbCxFv6rFLA==</SignatureValue><KeyIn
fo><X509Data><X509Certificate>MIIIZzCCBk+gAwIBAgIQBrhliahSqK2ZbWBkmmkieDANBgkqhkiG9w0BAQsFADB
0MQswCQYDVQQGEwJCUjETMBEGA1UEChMKSUNQLUJyYXNpbDEtMCsGA1UECxMkQ2VydGlzaWduIENlcnRpZmljYWRvcmEg
RGlnaXRhbCBTLkEuMSEwHwYDVQQDExhBQyBDZXJ0aXNpZ24gTXVsdGlwbGEgRzUwHhcNMTUwNjE1MDAwMDAwWhcNMTYwN
jEzMjM1OTU5WjCB6jELMAkGA1UEBhMCQlIxEzARBgNVBAoUCklDUC1CcmFzaWwxNjA0BgNVBAsULUF1dGVudGljYWRvIH
BvciBBdXRvcmlkYWRlIGRlIFJlZ2lzdHJvIENOQiBTUDEbMBkGA1UECxQSQXNzaW5hdHVyYSBUaXBvIEExMRUwEwYDVQQ
Página 94 de 137
LFAxJRCAtIDg0Mjk3MTMxMjAwBgNVBAMTKU1FUkNBRE8gRU5WSU9TIFNFUlZJQ09TIERFIExPR0lTVElDQSBMVERBMSYw
JAYJKoZIhvcNAQkBFhdmaXNjYWxAbWVyY2Fkb2xpdnJlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBA
JZgR/Xp2JZIYZuYU1MF4y3BqI/k1G8P8BxN+8qFDhiSp9RbwTSfKPdZncQij3V+GpLUrxkunTlj82unTC0tfIbPM/6Qui
sFSeH0/oyPAxH+pJCx2FKT4FS9rnqws+G6NyxI1g4a527iNk73l5Sebp05ZH3B65I9ZYyKGdcwvNVwSOLSvFRBRyhF4TA
WbfgMdVYmHHCEtvGdFDv0S1EAFCG1Yp7uxiHbx/dkDspNSejRd8Dh28GJrgtwUDxFfFBz9Rm9xW/KbwnhTLSb91eaFkDi
R8qc1Y4FyP34F4Qoc54jdZt6njBtyY+FqB4VomXA/IV6HAuf9SDoqgMHT5rSIW8CAwEAAaOCA3wwggN4MIHCBgNVHREEg
bowgbegPQYFYEwBAwSgNAQyMzAwMzE5Nzc4MTYyMDU3ODExNTAwMDAwMDAwMDAwMDAwMDAwMDAzMjQ1NDA1U1NQR0+gKQ
YFYEwBAwKgIAQeSEVMSVNTT04gQlJJR0lETyBBTkRSQURFIExFTU9ToBkGBWBMAQMDoBAEDjIwMTIxODUwMDAwMTU1oBc
GBWBMAQMHoA4EDDAwMDAwMDAwMDAwMIEXZmlzY2FsQG1lcmNhZG9saXZyZS5jb20wCQYDVR0TBAIwADAfBgNVHSMEGDAW
gBSdUM+9/yTKr7Ez6xfiQnqOaSqOUzAOBgNVHQ8BAf8EBAMCBeAwgYkGA1UdIASBgTB/MH0GBmBMAQIBCzBzMHEGCCsGA
QUFBwIBFmVodHRwOi8vaWNwLWJyYXNpbC5jZXJ0aXNpZ24uY29tLmJyL3JlcG9zaXRvcmlvL2RwYy9BQ19DZXJ0aXNpZ2
5fTXVsdGlwbGEvRFBDX0FDX0NlcnRpU2lnbk11bHRpcGxhLnBkZjCCASUGA1UdHwSCARwwggEYMFygWqBYhlZodHRwOi8
vaWNwLWJyYXNpbC5jZXJ0aXNpZ24uY29tLmJyL3JlcG9zaXRvcmlvL2xjci9BQ0NlcnRpc2lnbk11bHRpcGxhRzUvTGF0
ZXN0Q1JMLmNybDBboFmgV4ZVaHR0cDovL2ljcC1icmFzaWwub3V0cmFsY3IuY29tLmJyL3JlcG9zaXRvcmlvL2xjci9BQ
0NlcnRpc2lnbk11bHRpcGxhRzUvTGF0ZXN0Q1JMLmNybDBboFmgV4ZVaHR0cDovL3JlcG9zaXRvcmlvLmljcGJyYXNpbC
5nb3YuYnIvbGNyL0NlcnRpc2lnbi9BQ0NlcnRpc2lnbk11bHRpcGxhRzUvTGF0ZXN0Q1JMLmNybDAdBgNVHSUEFjAUBgg
rBgEFBQcDAgYIKwYBBQUHAwQwgaAGCCsGAQUFBwEBBIGTMIGQMGQGCCsGAQUFBzAChlhodHRwOi8vaWNwLWJyYXNpbC5j
ZXJ0aXNpZ24uY29tLmJyL3JlcG9zaXRvcmlvL2NlcnRpZmljYWRvcy9BQ19DZXJ0aXNpZ25fTXVsdGlwbGFfRzUucDdjM
CgGCCsGAQUFBzABhhxodHRwOi8vb2NzcC5jZXJ0aXNpZ24uY29tLmJyMA0GCSqGSIb3DQEBCwUAA4ICAQCbtB4ynJiPOu
nc95uVRupbkz0/QqMTXOosYsUiC8bbTmZzM95Rp2qqbC5H+IhqihoYaQnlPc8nYVrEyMfrFCxzE0UwhpcHa5P46hGQF1d
oIjucJINUmoRjj+FbjzJwkXF+NRPLoTSUWH9DddyfwvMvxwJ9ZB3aWWuJH9tkhNgvdG7Zj1b1Vm5hheRqvqFb7gDP1xEl
U8rOes9LAnQzjbGMwFxEbyqNuw60T/k2Qm0yP0tKF4O4B2TDjncElQypwSODFxjfm3dDlZmf5QrumMCE/zlwjMeQmyoC9
Wa3LxAvym65HdhSDdMgQd2zw89E0fPUTNiGXk5UAsRymZ3OLPyK8CNr4c9dWNcmpEfk6xX0GfIXDqSZPFNsjBBhCC6rwI
rjfAN+pqj9yUIoF0eD8sV8wI4DknDTdr3f2UVZckLREez1fMRbln3t2alOFP8WeYPA7dvcDGvkU7i+PyccXRAmRd5k4X0
UqO/Cb7Dq0TBQe//rXSWhZocwnW3zc10IBePqPoRwmcYghyHxAqsXyUkdp6mQzDkKMJgn65Y5k8QC2VRTHyEzB9ZOoYWb
8Bn/5CukGCxlU+U3Iw7jBXqFn2CsCkdciUeM4ptWrUcBxFcoEMywlvvnym16ooHJ2kNwtgwoSTIaniRhhIiAE0hdXKoha
d19+ZG88Pp/eylRjYbNoA==</X509Certificate></X509Data></KeyInfo></Signature></NFe><protNFe
versao="3.10"><infProt><tpAmb>2</tpAmb><verAplic>SP_NFE_PL_008h2</verAplic><chNFe>35160220121
850000155558040000000281587979397</chNFe><dhRecbto>2016-02-19T18:08:02-
02:00</dhRecbto><nProt>135160000598618</nProt><digVal>9lbW3Fa9VcSjywHZyjpWbVkhTUA=</digVal><c
Stat>100</cStat><xMotivo>Autorizado o uso da
NFe</xMotivo></infProt></protNFe></nfeProc>]]></XmlNfe>
</DadosResultadoXMLNFE>
</Rows>
</ObterXmlNfeResult>
</ObterXmlNfeResponse>
</soap:Body>

Regras de negócio

Não se aplica.

PedidoExiste

Conceito

O método PedidoExiste foi desenvolvido para permitir consultar se determinado pedido existe na base de
dados do KPL.

Objetivo

Através desse método é possível identificar se o pedido já foi cadastrado no KPL.

Pré-requisitos

Não se aplica.

Propriedades

Página 95 de 137
LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


ChavedeIdentificacao String 36 Identificação única da interface

ListaDeNumerosDePedidos

String String 50 Código externo do pedido

LAYOUT RESPONSE

Campo Tipo Max Descrição


PedidoExisteResult

VersaoWebservice String Versão do webservice


ResultadoOperacao

Codigo Int - Código do Webservice: Operação realizada


Tipo String 255 Valores possíveis: enumTipo
ExceptionMessage Enum - Mensagem de erro
Rows

DadosPedidosExistentes

NumeroDoPedido String 50 Número do pedido


Existente Bool - Pedido existe?
StatusAtual Enum - Valores disponíveis: enumStatusAtual
StatusPedido Char 50 Status do pedido
Resultado

Codigo Enum - Código do Webservice: Operação realizada


Descricao String 255 Descrição do erro
Tipo enum Valores possíveis: enumTipo

XML de exemplo

1) Execução do método para verificar se o pedido ME5614 existe.


Página 96 de 137
REQUEST
<soapenv:Body>
<abac:PedidoExiste>
<abac:ChaveIdentificacao>1580A94C-11FB-48D8-82E5-
FFC6324771F4</abac:ChaveIdentificacao>
<abac:ListaDeNumerosDePedidos>
<abac:String>ME5614</abac:String>
</abac:ListaDeNumerosDePedidos>
</abac:PedidoExiste>
</soapenv:Body>

RESPONSE
<soap:Body>
<PedidoExisteResponse xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<PedidoExisteResult>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>0</Codigo>
<Tipo>tdreIndefinido</Tipo>
</ResultadoOperacao>
<Rows>
<DadosPedidosExistentes>
<NumeroDoPedido>ME5614</NumeroDoPedido>
<Existente>true</Existente>
<StatusAtual>tspeeEmAndamento</StatusAtual>
<StatusPedido>AGUARDANDO SEPARACAO DE MERCADORIAS</StatusPedido>
<Resultado>
<Codigo>200002</Codigo>
<Descricao>OK.</Descricao>
<Tipo>tdreSucesso</Tipo>
</Resultado>
</DadosPedidosExistentes>
</Rows>
</PedidoExisteResult>
</PedidoExisteResponse>
</soap:Body> Regras
de negócio

 Pode ser consultado um pedido ou uma lista de pedidos de uma única vez.

Página 97 de 137
PedidosDisponiveis

Conceito

O método PedidosDisponiveis foi desenvolvido para disponibilizar as informações de pedidos para integração.

Objetivo

Através desse método é possível obter as informações de pedidos de venda que estão disponíveis para integração.

Pré-requisitos

A informação se torna disponível para integração quando ocorre uma inclusão, alteração ou exclusão de alguma
informação.

 Ativar replicação na interface

Ativar a replicação no cadastro da interface.

 Habilitar comercialização para integração

Habilitar no cadastro de interface as comercializações para integração.

Página 98 de 137
 Habilitar grupo de comercialização para integração

Habilitar no cadastro de interface os grupos de comercialização para integração.

 Definir na interface pontos de replicação do pedido

Configurar no cadastro de interface os pontos de replicação do pedido.

Página 99 de 137
 Habilitar unidades de negócio para integração

Habilitar no cadastro da interface as unidades de negócio para integração.

Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição

Página 100 de 137


PedidosDisponiveis

String 36 Identificação única da interface

ChaveIdentificacao

LAYOUT RESPONSE

Campo Tipo Max Descrição


PedidosDisponiveisResult

VersaoWebservice String Versão do Webservice


ResultadoOperacao

Codigo Int - Código do Webservice: Operação realizada


Descricao String 255 Descrição do erro
Tipo Enum - Valores possíveis: enumTipo
Rows

DadosPedidosDisponiveisWeb

Int - Código interno que identifica o pedido de venda


CodigoPedidoAbacos
NumeroDoPedido String 50 Código externo que identifica o pedido de venda

ProtocoloPedido GUID 255 Protocolo para confirmação do recebimento do


pedido
Comercializacao String 50 Nome da comercialização
GrupoComercializacao String 50 Grupo da comercialização
StatusPedido String 50 Status em que o Pedido foi replicado
Acao Enum - Valores disponíveis: enumAcao
PedidoWeb

DadosPedidoWeb

Int - Código interno do pedido de venda


CodigoPedido
NumeroPedido String 50 Código externo do pedido de venda
CodigoUnidadeNegocio Int - Número que identifica o pedido de venda no KPL

EMail String 100 E-mail do cliente


CodigoCliente Int Número que identifica o cliente no KPL
ClienteCPFouCNPJ Char 14 CPF ou CNPJ do cliente
NomeCliente String 100 Nome do cliente
RepresentanteVendas Int - Código interno do representante de vendas
ValorPedido Float - Valor do pedido
ValorFrete Float - Valor do frete
ValorEncargos Float - Valor dos encargos
ValorDesconto Float - Valor dos descontos
DataVenda Datetime - Data da venda no formato: AAAAMMDD HH:NN:SS
Transportadora String 20 Nome fantasia da transportadora

Página 101 de 137


ServicoEntrega Char 50 Descrição do serviço de entrega
Canal Char 50 Canal
SubCanal Char 50 SubCanal
EmitirNotaSimbolica Bool - Emitir NF Simbólica? (S ou N)
DataPrazoEntregaFinal Datetime - Data prazo final de entrega
OptouNFPaulista Enum - Valores disponíveis: 1.11 enumOptouNFPaulista
MensagemCorpoNota Bool - Mensagem no corpo da NF
DiasEntregaPosPagamento Int - Dias entrega pós-pagamento
DataPrazoEntrega Datetime - Data prazo entrega
DestNome Char 100 Razão Social do Destinatário

DestEndereco String 88 Logradouro + o número + complemento

DestEnderecoLogradouro String 80 Logradouro

DestEnderecoNumero Char 6 Numero do endereço


DestEnderecoComplemento String 30 Complemento do endereço

DestBairro String 60 Bairro do destinatário


DestCep Char 9 CEP do destinatário

DestMunicipio String 60 Município do destinatário

DestEstado Char 2 UF do destinatário


DestPais String 50 Nome do país do destinatário
DestSexo Enum - Valores disponíveis: enumSexo

DestEmail String 100 E-mail do destinatário

DestTelefone String 15 Numero do telefone do destinatário

DestTipoPessoa Enum - Valores disponíveis: enumTipoPessoa


DestCPFouCNPJ Char 14 CPF ou CNPJ do destinatário

DestInscricaoEstadual Char 14 Inscrição Estadual do destinatário

DestInscricaoMunicipal Char 14 Inscrição Municipal do destinatário

Anotacoes

DadosPedidoAnotacaoWeb

CodigoPedido Int - Código interno do pedido

Anotacao Text - Anotação


DataAnotacao Datetime - Data da anotação no formato

PreVenda Bool - Pré-Venda


EstoqueMovimento String 50 Estoque movimento
TipoFrete Char 50 Tipo de frete
DestPontoReferencia String 50 Ponto de referência

Página 102 de 137


PedidoItens

DadosPedidoItensWeb

CodigoItem Int - Número que identifica o item do pedido

CodigoProdutoAbacos Int - Código interno do produto


CodigoProduto String 50 Código externo do produto
Quantidade Float - Quantidade do item no pedido
PrecoUnitarioLiquido Float - Preço Unitário Liquido

PrecoUnitarioBruto Float - Preço Unitário Bruto

QuantidadeReservada Float - Quantidade reservada do item


PersonalizacaoNome String 100 Descrição da personalização do item

PersonalizacaoTexto Text - Texto da personalização do item

NomeProduto Char 50 Descrição do item (produto)


NomeComposto String 200 Nome composto do produto

CodigoBarras String 50 Código de barras do produto


Classe Char 50 Descrição da classe do item

CodigoRastreabilidade String 30 Código da rastreabilidade do item

DataValidade Datetime - Data de validade do item no formato: AAAAMMDD


HH:NN:SS
Datetime - Data de vencimento da garantia do item no
DataVencimentoGarantia formato:
AAAAMMDD HH:NN:SS
PreVenda Char 1 Pré-venda? Informar [S] Sim | [N] Não
EmbalagemPresente Bool - Embalagem para presente?

PedidoPagamento

DadosPedidoPagamentoWeb

CodigoPagamentoAbacos Int - Código interno do pagamento no KPL.

FormaPagamentoCodigo Int - O código passado na forma de pagamento pode


ser qualquer formato desejado. Basta configurar
previamente no KPL o "DE/PARA" para que os
pedidos possam ser incluídos normalmente

FormaPagamento Char 50 A descrição passada na forma de pagamento pode


ser qualquer formato desejado. Basta configurar
previamente
no KPL o "DE/PARA" para que os pedidos possam ser
incluídos normalmente

Página 103 de 137


TipoFormaPagamentoSigla Char 2 Sigla da forma de pagamento

Valor Float - Valor cobrado pelo pedido


ValorPago Float - Valor pago pelo pedido

TIDGateway String 100 Por este número só existir quando ocorre à


transação com o gateway ele pode ser deixado em
branco se não estiver disponível.
Autorizacao String 100 Por este número só existir quando ocorre à
transação com a administradora ele pode ser
deixado em branco se não estiver disponível.
NSU String 50 Numero sequencial único enviado pela
administradora.

DataPagamento Datetime - Data do pagamento

DataVencimentoBoleto Datetime - Data do vencimento do boleto

Parcelas

DadosPedidoPagamentoParcelasWeb
DataAprovacao Datetime - Data da aprovação da parcela

Datetime - Data da provisão do pagamento


DataProvisaoPagamento
ValorBruto Float - Valor bruto

NumeroParcela Int - Números de parcelas

QuantidadeParcelas Int - Quantidade de parcelas

PedidoVolumes

DadosPedidoVolumeWeb

CodigoVolume Int - Código do volume

Sequencial Int - Sequencial do volume

PesoLiquido Float - Peso liquido do volume


PesoBruto Float - Peso bruto do volume
NroRastreio Numeric 15 Numero de rastreio do volume

PLP String 50 PLP


CodigoRemessa String 50 Código da remessa

TextoEtiquetaEnderecamento Text - Texto etiqueta endereçamento

XML de exemplo

Página 104 de 137


1) Habilitação da comercialização no cadastro da interface.

2) Habilitação do grupo de comercialização no cadastro da interface.

3) Habilitação das unidades de negócio no cadastro da interface.

Página 105 de 137


4) Definição dos pontos de replicação do pedido.

5) Execução do método para obter os pedidos disponíveis para integração.

REQUEST
<soapenv:Body>
<abac:PedidosDisponiveis> <abac:ChaveIdentificacao>1580A94C-11FB48D8-
82E5-
FFC6324771F4</abac:ChaveIdentificacao>
</abac:PedidosDisponiveis>
</soapenv:Body>

RESPONSE
<soap:Body>

Página 106 de 137


<PedidosDisponiveisResponse xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<PedidosDisponiveisResult>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operação "Selecionar os pedidos disponiveis na integração" efetuada
com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosPedidosDisponiveisWeb>
<CodigoPedidoAbacos>5614</CodigoPedidoAbacos>
<NumeroDoPedido>ME5614</NumeroDoPedido>
<ProtocoloPedido>05AC85FC-7211-47B8-86C5-12C1542F57F8</ProtocoloPedido>
<Comercializacao>VENDA DE PRODUTOS</Comercializacao>
<GrupoComercializacao>VENDA</GrupoComercializacao>
<StatusPedido>AGUARDANDO SEPARACAO DE MERCADORIAS</StatusPedido>
<Acao>aieManutencao</Acao>
<PedidoWeb>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operação "Selecionar os dados do pedido que está disponivel
na integração" efetuada com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo> </ResultadoOperacao>
<Rows>
<DadosPedidoWeb>
<CodigoPedido>5614</CodigoPedido>
<NumeroPedido>ME5614</NumeroPedido>
<CodigoUnidadeNegocio>1</CodigoUnidadeNegocio>
<EMail>homologacaokpl@gmail.com</EMail>
<CodigoCliente>1</CodigoCliente>
<ClienteCPFouCNPJ>05521031000101</ClienteCPFouCNPJ>
<NomeCliente>KPL SOLUÇÕES LTDA</NomeCliente>
<RepresentanteVendas>1</RepresentanteVendas>
<ValorPedido>19.75</ValorPedido>
<ValorFrete>0</ValorFrete>
<ValorEncargos>0</ValorEncargos>
<ValorDesconto>0</ValorDesconto>
<DataVenda>23022016 21:02:58.780</DataVenda>
<Transportadora>CORREIOS</Transportadora>
<ServicoEntrega>E-SEDEX</ServicoEntrega>
<Canal/>
<SubCanal/>
<EmitirNotaSimbolica>N</EmitirNotaSimbolica>
<DataPrazoEntregaFinal/>
<OptouNFPaulista>S</OptouNFPaulista>
<MensagemCorpoNota/>
<DiasEntregaPosPagamento/>
<DataPrazoEntrega/>
<DestNome>KPL SOLUÇÕES LTDA</DestNome>
<DestEndereco>ALAMEDA MADEIRA, 222 16 Andar - Sala
162</DestEndereco>
<DestEnderecoLogradouro>Alameda Cauaxi</DestEnderecoLogradouro>
<DestEnderecoNumero>222</DestEnderecoNumero>
<DestEnderecoComplemento>16 Andar - Sala
162</DestEnderecoComplemento>
<DestBairro>É ALPHAVILLE CENTRO INDUSTR E EMPRESARIAL</DestBairro>
<DestCep>06455-010</DestCep>
<DestMunicipio>BARUERI</DestMunicipio>
<DestEstado>SP</DestEstado>
<DestPais>BRASIL</DestPais>

Página 107 de 137


<DestSexo>E</DestSexo>
<DestEmail>homologacaokpl@gmail.com</DestEmail>
<DestTelefone>1141953780</DestTelefone>
<DestTipoPessoa>J</DestTipoPessoa>
<DestCPFouCNPJ>05521031000101</DestCPFouCNPJ>
<DestInscricaoEstadual>206001784110</DestInscricaoEstadual>
<DestInscricaoMunicipal>557444-1</DestInscricaoMunicipal>
<Anotacoes>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operação "Selecionar as anotações do pedido"
efetuada com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosPedidoAnotacaoWeb>
<CodigoPedido>5614</CodigoPedido>
<Anotacao>TESTE DE IMPRESSAO DA ANOTACAO DO
PEDIDO</Anotacao>
<DataAnotacao>23022016 21:04:05.773</DataAnotacao>
</DadosPedidoAnotacaoWeb>
</Rows>
</Anotacoes>
<PreVenda>Não</PreVenda>
<EstoqueMovimento>1</EstoqueMovimento>
<TipoFrete/>
<DestPontoReferencia/>
</DadosPedidoWeb>
</Rows>
</PedidoWeb>
<PedidoItens>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operação "Selecionar os dados dos itens do pedido que está
disponivel na integração e com estoque reservado" efetuada com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosPedidoItensWeb>
<CodigoItem>13365</CodigoItem>
<CodigoProdutoAbacos>6099</CodigoProdutoAbacos>
<CodigoProduto>14335</CodigoProduto>
<Quantidade>1</Quantidade>
<PrecoUnitarioLiquido>19.75</PrecoUnitarioLiquido>
<PrecoUnitarioBruto>19.75</PrecoUnitarioBruto>
<QuantidadeReservada>1</QuantidadeReservada>
<PersonalizacaoNome/>
<PersonalizacaoTexto/>
<NomeProduto>Condicionador Ameixa</NomeProduto>
<NomeComposto>Condicionador Ameixa</NomeComposto>
<CodigoBarras>000000000006099</CodigoBarras>
<Classe>Cabelo</Classe>
<CodigoRastreabilidade/>
<DataValidade/>
<DataVencimentoGarantia/>
<PreVenda>Não</PreVenda>
<EmbalagemPresente>N</EmbalagemPresente>
</DadosPedidoItensWeb>
</Rows>
</PedidoItens>

Página 108 de 137


<PedidoPagamento>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operação "Selecionar os dados dos pagamentos do pedido que
está disponivel na integração" efetuada com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosPedidoPagamentoWeb>
<CodigoPagamentoAbacos>6366</CodigoPagamentoAbacos>
<FormaPagamentoCodigo>2</FormaPagamentoCodigo>
<FormaPagamento>MASTERCARD</FormaPagamento>
<TipoFormaPagamentoSigla>CA</TipoFormaPagamentoSigla>
<Valor>19.75</Valor>
<ValorPago>19.75</ValorPago>
<TIDGateway/>
<Autorizacao/>
<NSU/>
<DataPagamento>23022016 21:05:09.210</DataPagamento>
<DataVencimentoBoleto>23022016
21:03:32.430</DataVencimentoBoleto> <Parcelas>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operação "Parcelas dos pagamento com cartão"
efetuada com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosPedidoPagamentoParcelasWeb>
<DataAprovacao>23022016</DataAprovacao>
<DataProvisaoPagamento>24032016</DataProvisaoPagamento>
<ValorBruto>19.75</ValorBruto>
<NumeroParcela>1</NumeroParcela>
<QuantidadeParcelas>1</QuantidadeParcelas>
</DadosPedidoPagamentoParcelasWeb>
</Rows>
</Parcelas>
</DadosPedidoPagamentoWeb>
</Rows>
</PedidoPagamento>
<PedidoVolumes>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porém não há dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
<Rows>
<DadosPedidoVolumeWeb>
<CodigoVolume>0</CodigoVolume>
<Sequencial>0</Sequencial>
<PesoLiquido>0</PesoLiquido>
<PesoBruto>0</PesoBruto>
<NroRastreio/>
<PLP/>
<CodigoRemessa/>
<TextoEtiquetaEnderecamento/>
</DadosPedidoVolumeWeb>
</Rows>
</PedidoVolumes>

Página 109 de 137


</DadosPedidosDisponiveisWeb>
</Rows> </PedidosDisponiveisResult>
</PedidosDisponiveisResponse>
</soap:Body>

Regras de negócio

 Confirmar recebimento do registro


Uma vez que o registro fica disponível para integração, é necessário informar que o mesmo foi recebido
e integrado corretamente para que não fique mais disponível na fila de integração. A confirmação de
recebimento e integração, deve ser feita através do método ConfirmarPedidosDisponiveis.

ProdutoExiste
Conceito

O método ProdutoExiste foi desenvolvido para permitir consultar se determinado produto existe na base de dados
do KPL.

Objetivo

Através desse método é possível identificar se o produto já foi cadastrado no KPL.


Pré-requisitos

Não se aplica.

Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


ProdutoExiste

ChaveIdentificacao String 36 Identificação única da interface


ListaDeNumerosDeProdutosRows

ListaDeNumerosDeProdutos

CodigoProduto String 50 Código do produto


CodigoProdutoAbacos Int - Código do produto KPL
CodigoBarras String 50 Código de barras do produto

LAYOUT RESPONSE

Campo Tipo Max Descrição


ProdutoExisteResult

VersaoWebservice String
VersãodoWebservice
ResultadoOperacao

Codigo Int - Código do Webservice: Operação realizada

Página 110 de 137


Descricao String 255 Descrição do erro
Tipo Enum - Valores possíveis: enumTipo
Rows

DadosProdutosExistentes

CodigoProduto String 50 Código do produto


CodigoProdutoAbacos Int - Código do produto KPL
CodigoBarras String 50 Código de barras do produto.
UnidadesNegocio String 100 Lista das siglas das unidades de negócio ativas configuradas
para o produto separadas por vírgula
CodigosInterfaces String 100 Código das interfaces ativas configuradas para o produto
separadas por vírgula
Existente Bool - Indica se o produto existe no KPL
ProdutoAtivo Bool - Indica se o produto esta ativo no KPL
Resultado

Codigo Int - Código do Webservice: Operação realizada


Descricao String 255 Descrição do erro
Tipo Enum - Valores possíveis: enumTipo
ExceptionMessage String 255 Mensagem de erro

XML de exemplo

1) Execução do método para verificar se o produto 14335 existe.

REQUEST
<soapenv:Body>
<abac:ProdutoExiste>
<abac:ChaveIdentificacao>1580A94C-11FB-48D8-82E5-
FFC6324771F4</abac:ChaveIdentificacao>
<abac:ListaDeNumerosDeProdutosRows>

Página 111 de 137


<abac:ListaDeNumerosDeProdutos>
<abac:CodigoProduto>14335</abac:CodigoProduto>
</abac:ListaDeNumerosDeProdutos>
</abac:ListaDeNumerosDeProdutosRows>
</abac:ProdutoExiste>
</soapenv:Body>

RESPONSE
<soap:Body> <ProdutoExisteResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<ProdutoExisteResult>
<VersaoWebservice>5.0.89.0</VersaoWebservice>
<ResultadoOperacao>
<Codigo>0</Codigo>
<Tipo>tdreIndefinido</Tipo>
</ResultadoOperacao>
<Rows>
<DadosProdutosExistentes>
<CodigoProduto>14335</CodigoProduto>
<CodigoProdutoAbacos>6099</CodigoProdutoAbacos>
<CodigoBarras>000000000006099</CodigoBarras>
<UnidadesNegocio>ME,RN</UnidadesNegocio>
<CodigosInterfaces/>
<Existente>true</Existente>
<ProdutoAtivo>true</ProdutoAtivo>
<Resultado>
<Codigo>200002</Codigo>
<Descricao>OK.</Descricao>
<Tipo>tdreSucesso</Tipo> </Resultado>
</DadosProdutosExistentes>
</Rows>
</ProdutoExisteResult>
</ProdutoExisteResponse>
</soap:Body>

Regras de negócio

 Pode ser consultado um ou uma lista de produtos de uma única vez.

Página 112 de 137


ProdutosDisponiveis
Conceito

O método ProdutosDisponiveis foi desenvolvido para disponibilizar as alterações nos produtos.


Objetivo

Através desse método é possível obter as informações dos produtos que estão disponíveis para integração.
Pré-requisitos

A informação se torna disponível para integração quando ocorre alguma alteração no cadastro do produto.

 Ativar replicação na interface

Ativar a replicação no cadastro da interface.

 Habilitar o produto na interface

Para que o produto fique disponível para integração, é necessário habilita-lo na interface.

Página 113 de 137


Menu:
Comercial e Faturamento -> Cadastros -> Produtos -> Produtos

Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


ProdutosDisponiveis

ChaveIdentificacao String 36 Identificação única da interface

LAYOUT RESPONSE

Campo Tipo Max Descrição


ProdutosDisponiveisResult

VersaoWebservice String Versão do webservice


ResultadoOperacao

Codigo Int Código do Webservice: Operação realizada


Descricao String 255 Descrição do erro
Tipo Enum Valores possíveis: enumTipo
ExceptionMessage String Mensagem de erro
Rows

DadosProdutos

ProtocoloProduto String 255 Protocolo do produto


Acao Enum - Valores disponíveis: enumAcao
CodigoProdutoAbacos Int - Código produto KPL
CodigoProduto String 50 Código produto
CodigoProdutoPai String 50 Código produto pai

Página 114 de 137


CodigoBarras String 50 Código barras
TipoProduto Enum - Valores disponíveis: enumTipoProduto
NomeProduto String 100 Nome do produto
Descricao Text - Descrição

CodigoMarca Int - Código marca


CodigoFabricante String 40 Código fabricante
CodigoClasse Int - Código classe
CodigoFamilia Int - Código família
CodigoGrupo Int - Código grupo
CodigoSubGrupo Int - Código subgrupo
Peso Float - Peso
Largura Float - Largura
Comprimento Float - Comprimento
Profundidade Float - Profundidade
Espessura Float - Espessura
Altura Float - Altura
QtdePorEmbalagem Int - Quantidade por embalagem
QtdeMinimaEstoque Float - Quantidade mínima estoque
QtdeMaximaEstoque Float - Quantidade máxima estoque
UnidadeMedidaNome String 50 Nome da unidade de medida
UnidadeMedidaAbrev String 3 Unida de medida abreviada
UnidadeMedidaQuilo String 1 Unidade de medida quilo
ProdutoTemFilhos String 1 Produto tem filhos?
PrazoEntregaDias Int - Prazo de entrega em dias
CampoCfg001/CampoCfg020 String 255 O campo se estende do 001 ao 020
CampoCfgInt001/ CampoCfgInt030 String 255 O campo se estende do 001 ao 030
CFOPNaoContribuinte Int - CFOP não contribuinte
CFOPContribuinte Int - CFOP contribuinte
UnidadeTributavel Float - Unidade tributável
CustoDoProduto Float - Custo do produto
CodigoExternoFornecedor String 50 Código externo fornecedor
DescontoMaxProduto Float - Desconto máximo do produto
PreVenda Bool - Pré-venda
PreVenda_DataInicio Datetime - Data início pré-venda
PreVenda_DataFinal Datetime - Data final pré-venda
DescritorSimples

DadosDescritorSimples

CodigoInterno Int - Código interno no KPL


Numero Int - Número do descritor simples: 1, 2 ou 3
Descricao String 500 Descrição/Nome do descritor
DescritorPreDefinido

DadosDescritorPreDefinido

CodigoInterno Int - Código interno no KPL

Página 115 de 137


Numero Int - Número do descritor pré-definido:1, 2 ou 3
Descricao String 500 Descrição/Nome do descritor.
GrupoCodigo Int - Grupo do descritor pré-definido
GrupoNome Int 100 Nome grupo do descritor pré-definido
AtributosEstendidos

DadosAtributosEstendidos

CodigoAtributo Int - Código do atributo estendido


NomeAtributo String 100 Nome do atributo estendido
NomeElemento String 255 Nome do elemento
TipoDado Char 1 Tipo de dado
CampoValor String Float Valor do campo
Ordenacao Int - Ordenação atributo estendido
CaracteristicasComplementares

DadosCaracteristicasComplementares

CodigoInterno Int - Código interno no KPL


TipoCodigo String 100 Tipo código cadastrado no KPL
TipoNome String 255 Descrição da Característica
TipoGrupoCodigo String 1 Tipo grupo código cadastrado no KPL
TipoGrupoNome String - Tipo grupo nome cadastrado no KPL
Texto Int - Texto da Informativo
NrConfigInterface Int - Identifica a descrições complementar de 1 a
Pr odutosSubstitutos

DadosProdutosSubstitutos

CodigoSubstituto String 50 Código Produto Substituto


C ategoriasDoSite

DadosCategoriasDoSite

CodigoCategoria Int - Código da categoria cadastrada no KPL


CodigoCategoriaPai Int - Código da categoria Pai cadastrada no KPL
ProdutosPersonalizacao

DadosProdutosPersonalizacao

ClassificacaoPersonalizacao Int - Classificação da personalização


CodigoProdutoPersonalizacao String 50 Código produto personalizado
CodigoProdutoPersonalizacaoPai String 50 Código produto pai personalizado
ProdutoPersonalizacaoLigacao Enum - Valores disponíveis: enumProdutoTipoLigacao
ComponentesKit

DadosComponentesKit

CodigoProdutoComponente String 50 Código componente


Quantidade Float - Quantidade

Página 116 de 137


DescritorPreDefinido1 String 100 Descritor pré-definido 1
DescritorPreDefinido2 String 100 Descritor pré-definido 2
DescritorPreDefinido3 String 100 Descritor pré-definido 3
CodigoDescritorPreDefinido1 Int - Código descritor pré-definido 1
CodigoDescritorPreDefinido2 Int - Código descritor pré-definido 2
CodigoDescritorPreDefinido3 Int - Código descritor pré-definido 3
DescritorSimples1 String 50 Descritor simples 1
DescritorSimples2 String 50 Descritor simples21
DescritorSimples3 String 50 Descritor simples 3
Preco Float - Preço
PrecoPromocional Float - Preço promocional
DataInicioPromocao Datetime - Data inicio promoção
DataTerminoPromocao Datetime - Data final da promoção
ProdutosAssociados

DadosProdutosAssociados

CodigoProdutoAbacos Int - Código interno produto


CodigoProduto String 50 Código produto
CodigoBarras String 50 Código de barras
OrdemAssociacao Int - Ordem associação
TipoAssociacao Int - Tipo associação
TipoAssociacaoNome String 100 Nome tipo associação
TipoCategoria String 1 Tipo categoria

TipoCategoriaNome String 50 Nome tipo categoria


DescricaoClasse String 50 Descrição classe
DescricaoMarca String 50 Descrição marca
DescricaoFamilia String 50 Descrição família
DescricaoGrupo String 50 Descrição grupo
DescricaoSubgrupo String 50 Descrição subgrupo
CodigoCategoriaFiscal Int - Código categoria fiscal
CodigoClassificacaoFiscal String 10 Código classificação fiscal
ClassificacaoFiscal String 15 Classificação Fiscal
DiasGarantia Int - Dias de garantia
PodeSerBrinde Bool - Pode ser brinde?
TipoRastreabilidade Int - Rastreabilidade tipo
TipoControleEstoque String 1 Tipo de controle de estoque
ProdutoKit String 1 Produto kit
EfetuarCheckOut String 1 Efetuar checkout
DescricaoNotaFiscal String 1 Descrição nota fiscal
ClassificacaoPersonalizacao Int - Classificação personalização
NaoImprimirEtqEntrada Bool - Imprimir etiqueta de entrada?
DadosLivros
DadosLivros

Página 117 de 137


NomeIdioma String 50 Nome do idioma pré-cadastrado
NomePais String 50 Nome do país pré-cadastrado
DataPublicacao Datetime - Data da publicação
NumeroPaginas Int - Número de páginas
Anopublicacao Int - Ano de publicação
ISBN10 String 50 International Standard Book Number (Número
padrão internacional do livro)
NumeroVolume Int - Número do volume
ImpressaoSobDemanda String 1
ComplementoEdicao String 100 Complemento da edição
NomeEncadernacao String 100 Nome da encadernação
NumeroEdicao Int - Número da edição
CodigoEdicaoAnterior Int - Código edição anterior
EdicaoAnterior Int - Edição anterior
DadosColecao

NomeColecao String 100 Nome da coleção


DadosContribuidor

NomeContribuidor String 100 Nome do contribuidor


NomeFuncao String 50 Nome da função
PrincipalFuncao String 3 Principal função
DadosAcompanhamento

NomeAcompanhamento String 100 Nome do Acompanhamento


DadosMultiplosCodigos

DadosMultiplosCodigos

CodigoTipoCodigo Int - Código que identifica o tipo de código


TipoCodigo String 100 Tipo do código
Codigo String 850 Código produto
PrecoTabela1 Float - Preço tabela 1
PrecoPromocao1 Float - Preço promoção 1
PrecoTabela2 Float - Preço tabela 2
PrecoPromocao2 Float - Preço promoção 2
DadosImagemProduto

FinalidadeImagem String 50 Finalidade de imagem


Repositorio String 500 Repositório
2.32.5 XML de exemplo

1) Alterações realizadas no cadastro do produto.

Inclusão da característica complementar.

Página 118 de 137


Inclusão do código do fabricante.

2) Execução do método para obter as informações que estão disponíveis para integração.
REQUEST
<soapenv:Body>
<abac:ProdutosDisponiveis>
<abac:ChaveIdentificacao>1580A94C-11FB-48D8-82E5-
FFC6324771F4</abac:ChaveIdentificacao>
</abac:ProdutosDisponiveis>
</soapenv:Body>

RESPONSE
<soap:Body>

Página 119 de 137


<ProdutosDisponiveisResponse xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<ProdutosDisponiveisResult>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>100001</Codigo>
<Descricao>Ocorreram erros durante a obtenção das informações pertinentes a
lista de itens. Verifique o retorno em cada item para maiores detalhes.</Descricao>
<Tipo>tdreAlerta</Tipo>
</ResultadoOperacao>
<Rows>
<DadosProdutos>
<ProtocoloProduto>A5EF5F82-F0C1-4CD2-A8F8-85FC273B9B49</ProtocoloProduto>
<Acao>aieManutencao</Acao>
<CodigoProdutoAbacos>6099</CodigoProdutoAbacos>
<CodigoProduto>14335</CodigoProduto>
<CodigoProdutoPai/>
<CodigoBarras>000000000006099</CodigoBarras>
<TipoProduto>tpreProduto</TipoProduto>
<NomeProduto>Condicionador Ameixa</NomeProduto>
<Descricao>N/SPA CONDICIONADOR AMEIXA 250ml</Descricao>
<CodigoMarca>98</CodigoMarca>
<CodigoFabricante>143350001</CodigoFabricante>
<CodigoClasse>9</CodigoClasse>
<CodigoFamilia>18</CodigoFamilia>
<CodigoGrupo>28</CodigoGrupo>
<CodigoSubGrupo>39</CodigoSubGrupo>
<Peso>0.362</Peso>
<Largura>6.6</Largura>
<Comprimento>5.6</Comprimento>
<Profundidade>5.6</Profundidade>
<Espessura>17.1</Espessura>
<Altura>17.1</Altura>
<QtdePorEmbalagem>1</QtdePorEmbalagem>
<QtdeMinimaEstoque>1</QtdeMinimaEstoque>
<QtdeMaximaEstoque>0</QtdeMaximaEstoque>
<UnidadeMedidaNome>UNIDADE</UnidadeMedidaNome>
<UnidadeMedidaAbrev>UN</UnidadeMedidaAbrev>
<UnidadeMedidaQuilo>false</UnidadeMedidaQuilo>
<ProdutoTemFilhos>false</ProdutoTemFilhos>
<PrazoEntregaDias>0</PrazoEntregaDias>
<CFOPNaoContribuinte>0</CFOPNaoContribuinte>
<CFOPContribuinte>0</CFOPContribuinte>
<UnidadeTributavel>0</UnidadeTributavel>
<CustoDoProduto>0</CustoDoProduto>
<CodigoExternoFornecedor/>
<DescontoMaxProduto>0</DescontoMaxProduto>
<PreVenda>Não</PreVenda>
<PreVenda_DataInicio/>
<PreVenda_DataFinal/>
<DescritorSimples>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porém não há dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
<rows>
<DadosDescritorSimples>
<CodigoInterno>0</CodigoInterno>
<Numero>0</Numero>
<Descricao/>
</DadosDescritorSimples>

Página 120 de 137


</rows>
</DescritorSimples>
<DescritorPreDefinido>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porém não há dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
<Rows>
<DadosDescritorPreDefinido>
<CodigoInterno>0</CodigoInterno>
<Numero>0</Numero>
<Descricao/>
<GrupoCodigo>0</GrupoCodigo>
<GrupoNome/>
</DadosDescritorPreDefinido>
</Rows>
</DescritorPreDefinido>
<AtributosEstendidos>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operação "Lista de atributos associados a um produto"
efetuada com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosAtributosEstendidos>
<CodigoAtributo>13</CodigoAtributo>
<NomeAtributo>Atributo homologacao para produto</NomeAtributo>
<NomeElemento>AtributoProduto1</NomeElemento>
<TipoDado>T</TipoDado>
<CampoValor>PADRAO</CampoValor>
<Ordenacao>2</Ordenacao>
</DadosAtributosEstendidos>
</Rows>
</AtributosEstendidos>
<CaracteristicasComplementares>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operação "Caracteristicas complementares associadas ao
produto" efetuada com sucesso.</Descricao> <Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosCaracteristicasComplementares>
<CodigoInterno>2746</CodigoInterno>
<TipoCodigo>3</TipoCodigo>
<TipoNome>EXTRA1</TipoNome>
<TipoGrupoCodigo>2</TipoGrupoCodigo>
<TipoGrupoNome>DESCRICAO COMPLEMENTAR</TipoGrupoNome>
<Texto>Integração</Texto>
<NrConfigInterface>0</NrConfigInterface>
</DadosCaracteristicasComplementares>
</Rows>
</CaracteristicasComplementares>
<ProdutosSubstitutos>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200003</Codigo>

Página 121 de 137


<Descricao>OK, porém não há dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo> </ResultadoOperacao>
<Rows>
<DadosProdutosSubstitutos>
<CodigoSubstituto/>
</DadosProdutosSubstitutos>
</Rows>
</ProdutosSubstitutos>
<CategoriasDoSite>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porém não há dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
<Rows>
<DadosCategoriasDoSite>
<CodigoCategoria>0</CodigoCategoria>
<CodigoCategoriaPai>0</CodigoCategoriaPai>
</DadosCategoriasDoSite>
</Rows>
</CategoriasDoSite>
<ProdutosPersonalizacao>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porém não há dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
<Rows>
<DadosProdutosPersonalizacao>
<ClassificacaoPersonalizacao>tpceNenhuma</ClassificacaoPersonalizacao>
<CodigoProdutoPersonalizacao/>
<CodigoProdutoPersonalizacaoPai/>
<ProdutoPersonalizacaoLigacao>tptleIndefinido</ProdutoPersonalizacaoLigacao>
</DadosProdutosPersonalizacao>
</Rows>
</ProdutosPersonalizacao>
<ComponentesKit>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porém não há dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
<Rows>
<DadosComponentesKit>
<CodigoProdutoComponente/>
<Quantidade>0</Quantidade>
<DescritorPreDefinido1/>
<DescritorPreDefinido2/>
<DescritorPreDefinido3/>
<CodigoDescritorPreDefinido1/>
<CodigoDescritorPreDefinido2/>
<CodigoDescritorPreDefinido3/>
<DescritorSimples1/>
<DescritorSimples2/>
<DescritorSimples3/>
<Preco>0</Preco>
<PrecoPromocional>0</PrecoPromocional>
</DadosComponentesKit>
</Rows>

Página 122 de 137


</ComponentesKit>
<ProdutosAssociados> <VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porém não há dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
<Rows>
<DadosProdutosAssociados>
<CodigoProdutoAbacos/>
<CodigoProduto/>
<CodigoBarras/>
<OrdemAssociacao/>
<TipoAssociacao/>
<TipoAssociacaoNome/>
<TipoCategoria/>
<TipoCategoriaNome/>
</DadosProdutosAssociados>
</Rows>
</ProdutosAssociados>
<DescricaoClasse>Cabelo</DescricaoClasse>
<DescricaoMarca>Nativa SPA</DescricaoMarca>
<DescricaoFamilia>CABELO</DescricaoFamilia>
<DescricaoGrupo>Condicionador</DescricaoGrupo>
<DescricaoSubgrupo>Aromas</DescricaoSubgrupo>
<CodigoCategoriaFiscal>1</CodigoCategoriaFiscal>
<CodigoClassificacaoFiscal>0</CodigoClassificacaoFiscal>
<ClassificacaoFiscal/>
<DiasGarantia>0</DiasGarantia>
<PodeSerBrinde>false</PodeSerBrinde>
<TipoRastreabilidade>0</TipoRastreabilidade>
<TipoControleEstoque>tceeControla</TipoControleEstoque>
<ProdutoKit>false</ProdutoKit>
<EfetuarCheckOut>true</EfetuarCheckOut>
<DescricaoNotaFiscal>false</DescricaoNotaFiscal>
<ClassificacaoPersonalizacao>tpceNenhuma</ClassificacaoPersonalizacao>
<NaoImprimirEtqEntrada>false</NaoImprimirEtqEntrada>
<DadosLivros>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porém não há dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
<Rows>
<DadosLivros>
<NomeIdioma/>
<NomePais/>
<DataPublicacao/>
<NumeroPaginas>0</NumeroPaginas>
<Anopublicacao>0</Anopublicacao>
<ISBN10/>
<NumeroVolume>0</NumeroVolume>
<ImpressaoSobDemanda/>
<ComplementoEdicao/>
<NomeEncadernacao/>
<NumeroEdicao>0</NumeroEdicao>
<CodigoEdicaoAnterior>0</CodigoEdicaoAnterior>
<EdicaoAnterior/>
<DadosColecao>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>

Página 123 de 137


<Codigo>0</Codigo>
<Tipo>tdreIndefinido</Tipo>
</ResultadoOperacao>
<Rows> <DadosColecao>
<NomeColecao/>
</DadosColecao>
</Rows>
</DadosColecao>
<DadosContribuidor>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porém não há dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
<Rows>
<DadosContribuidor>
<NomeContribuidor/>
<NomeFuncao/>
<PrincipalFuncao/>
</DadosContribuidor>
</Rows>
</DadosContribuidor>
<DadosAcompanhamento>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>0</Codigo>
<Tipo>tdreIndefinido</Tipo>
</ResultadoOperacao>
<Rows>
<DadosAcompanhamento>
<NomeAcompanhamento/>
</DadosAcompanhamento>
</Rows>
</DadosAcompanhamento>
</DadosLivros>
</Rows>
</DadosLivros>
<DadosMultiplosCodigos>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>0</Codigo>
<Tipo>tdreIndefinido</Tipo>
</ResultadoOperacao>
<Rows>
<DadosMultiplosCodigos>
<CodigoTipoCodigo/>
<TipoCodigo/>
<Codigo/>
</DadosMultiplosCodigos>
</Rows>
</DadosMultiplosCodigos>
<PrecoTabela1>0</PrecoTabela1>
<PrecoPromocao1>0</PrecoPromocao1>
<PrecoTabela2>0</PrecoTabela2>
<PrecoPromocao2>0</PrecoPromocao2>
<DadosImagemProduto>
<VersaoWebservice>5.0.90.3</VersaoWebservice>
<ResultadoOperacao>
<Codigo>300002</Codigo>
<Descricao>Erro na obtenção dos dados para a integração. Origem
"Imagens de produtos".</Descricao>

Página 124 de 137


<Tipo>tdreErroDataBase</Tipo>
<ExceptionMessage>Interface = 17 Msg = Operação não permitida, serviço
não está configurado para trabalhar quando as imagens estão armazenadas em um servidor Web e
não possuem nome padronizado</ExceptionMessage>
</ResultadoOperacao>
</DadosImagemProduto>
</DadosProdutos>
</Rows>
</ProdutosDisponiveisResult>
</ProdutosDisponiveisResponse>
</soap:Body>

Regras de negócio

 Podem ser retornados mais de um registro na mesma chamado do método.

 As alterações do mesmo produto são agrupadas no retorno do método.

 Uma vez que o registro fica disponível para integração, é necessário informar que o mesmo foi
recebido e integrado corretamente para que não fique mais disponível na fila de integração. A
confirmação de recebimento e integração, deve ser feita através do método
ConfirmarProdutosDisponiveis

RealizarRecebimentoMercadoria

Conceito

Efetuar recebimento de mercadoria para confrontar com quantidade fiscal da NF.

Objetivo

Efetuar o lançamento físico do recebimento.

Pré-requisitos

A nota fiscal estar lançada no KPL, com o status “AGUARDANDO RECEBIMENTO DE MERCADORIA”.

Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


RealizarRecebimentoMercadoria

ChaveIdentificacao String 36 Chave única de identificação da interface.


RecebimentoMercadoria

SerieNota String 50 Série da Nota Fiscal de Entrada, campo chave


em conjunto com o NumeroNota

Página 125 de 137


NumeroNota String 50 Número da Nota Fiscal de Entrada, campo
chave em conjunto com o SerieNota
Fornecedor String 50 CNPJ do Fornecedor
Itens

DadosItensMercadoria

CodigoProduto String 50 Código Externo Produto, campo chave para


localizar o produto. Ou informe o
CodigoBarras
Quantidade Float - Quantidade do Item da Nota Fiscal.
ProdutoAvariado Bool - Produto recebido está avariado?
Rastreabilidade String 30 Código de rastreabilidade
DataValidade Datetime - Data de validade do item
DataGarantia Datetime - Data de garantia do item

LAYOUT RESPONSE

Campo Tipo Max Descrição

RealizarRecebimentoMercadoriaResult

Codigo Int - Código do Webservice: Operação realizada

Descricao String 255 Descrição do erro

Tipo Enum - Valores possíveis: enumTipo

ExceptionMessage String 255 Mensagem de erro

2.33.5 XML de exemplo

1) Execução do método para efetivar o recebimento da mercadoria.

REQUEST
<soapenv:Body>
<abac:RealizarRecebimentoMercadoria>
<abac:ChaveIdentificacao>1580A94C-11FB-48D882E5FFC6324771F4</abac:ChaveIdentificacao>
<abac:RecebimentoMercadoria>
<abac:SerieNota>1</abac:SerieNota>
<abac:NumeroNota>103</abac:NumeroNota>
<abac:Fornecedor>05521031000101</abac:Fornecedor>
<abac:Itens>
<abac:DadosItensMercadoria>
<abac:CodigoProduto>14335</abac:CodigoProduto>
<abac:Quantidade>1</abac:Quantidade>
<abac:ProdutoAvariado>false</abac:ProdutoAvariado>
</abac:DadosItensMercadoria>
</abac:Itens>
</abac:RecebimentoMercadoria>
</abac:RealizarRecebimentoMercadoria>
</soapenv:Body>

RESPONSE
<soap:Body>
<RealizarRecebimentoMercadoriaResponse

Página 126 de 137


xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<RealizarRecebimentoMercadoriaResult>
<Codigo>200001</Codigo>
<Descricao>Operação "Confirmar Recebimento de Mercadoria" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</RealizarRecebimentoMercadoriaResult>
</RealizarRecebimentoMercadoriaResponse>
</soap:Body>

2) Tela do KPL com o recebimento realizado via webservice.

Regras de negócio

Não se aplica.

ReservarEstoque

Conceito

O método ReservarEstoque foi desenvolvido para permitir reservar o estoque no KPL via integração webservice.

Objetivo

Permite reservar o estoque da lista de pedidos.

Pré-requisitos

O pedido de venda deve existir cadastrado na base de dados do KPL e o status deve estar como “AGUARDANDO
ESTOQUE”.

 Ativar replicação na interface

Página 127 de 137


Ativar a replicação no cadastro da interface.

Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição


ReservarEstoque

ChaveIdentificacao String 36 Identificação única da interface


ListaPedidos

DadosListaPedidosReserva

NumeroPedido String 50 Número do pedido


CodigoPedido String 50 Código do pedido
CodigoProduto String 50 Código do produto
QuantidadeReservar String 1 Quantidade a reservar
QuantidadeReservar_specified String 1 Valores disponíveis: Sim ou Não

LAYOUT RESPONSE

Campo Tipo Max Descrição

Página 128 de 137


ReservarEstoqueResult

VersaoWebservice String Versão do webservice


ResultadoOperacao

Codigo Int - Código do Webservice: Operação realizada


Descricao String 255 Descrição do erro
Tipo Enum - Valores possíveis: enumTipo

Rows

DadosListaPedidosResultado

NumeroDoPedido String 50 Código externo do pedido

Resultado

Codigo Int - Código do Webservice: Operação realizada


Descricao String 255 Descrição do erro
Tipo Enum - Valores possíveis: enumTipo
ExceptionMessage String 255 Mensagem de erro

2.34.5 XML de exemplo

1) Foi criado um pedido com um item que não tinha estoque, então o pedido ficou com o status
“AGUARDANDO ESTOQUE”.

2) Então foi realizado o lançamento de uma NF para alimentar o estoque do item.

Página 129 de 137


Menu: Comercial e Faturamento -> Consultas -> Notas fiscais

3) Em seStringa foi executado o método para reservar estoque do item.


REQUEST
<soapenv:Body>
<abac:ReservarEstoque>
<abac:ChaveIdentificacao>1580A94C-11FB-48D8-82E5-
FFC6324771F4</abac:ChaveIdentificacao>
<abac:ListaPedidos>
<abac:DadosListaPedidosReserva>
<abac:NumeroPedido>ME5614</abac:NumeroPedido>
<abac:CodigoPedido>5614</abac:CodigoPedido>
<abac:CodigoProduto>14335</abac:CodigoProduto>
<abac:QuantidadeReservar>1</abac:QuantidadeReservar>

Página 130 de 137


<abac:QuantidadeReservar_specified>s</abac:QuantidadeReservar_specified>
</abac:DadosListaPedidosReserva>
</abac:ListaPedidos>
</abac:ReservarEstoque>
</soapenv:Body>

RESPONSE
<soap:Body>
<ReservarEstoqueResponse xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<ReservarEstoqueResult>
<VersaoWebservice>5.0.89.0</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200002</Codigo>
<Descricao>OK.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosListaPedidosResultado>
<NumeroDoPedido>ME5614</NumeroDoPedido>
<Resultado>
<Codigo>200001</Codigo>
<Descricao>Operação "Reservar estoque" efetuada com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</Resultado>
</DadosListaPedidosResultado>
</Rows>
</ReservarEstoqueResult>
</ReservarEstoqueResponse> </soap:Body>

Regras de negócio

Não se aplica.

StatusPedidoDisponiveis

Conceito

O método StatusPedidoDisponiveis foi desenvolvido para disponibilizar as alterações nos status dos pedidos.

Objetivo

Através desse método é possível obter os status dos pedidos que estão disponíveis para a integração.

Pré-requisitos

A informação se torna disponível para integração quando ocorre alguma alteração no status do pedido.

 Ativar replicação na interface

Ativar a replicação do status do pedido no cadastro da interface.

Página 131 de 137


 Configurar na interface os status que serão integrados

É necessário configurar no cadastro da interface os status do pedido que serão integrados. Caso o status não esteja
cadastrado, o mesmo não será disponibilizado para integração.

Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição

Página 132 de 137


StatusPedidoDisponiveis

ChaveIdentificacao String 36 Identificação única da interface

LAYOUT RESPONSE

Campo Tipo Max Descrição

StatusPedidoDisponiveisResult

VersaoWebservice String Versão do Webservice


ResultadoOperacao

Codigo Int - Código do Webservice: Operação realizada


Descricao String 255 Descrição do erro
Tipo Enum - Valores possíveis: enumTipo
ExceptionMessage String 255 Mensagem de erro
Rows

DadosStatusPedido

ProtocoloStatusPedido String 255 Protocolo status pedido


NumeroPedido String 50 Número do pedido
CodigoPedidoAbacos Int - Código do pedido no KPL
CodigoStatus String 15 Código status
StatusPedido String 100 Status do pedido
DataHora Datetime - Data e hora
SerieNota Char 3 Serie da nota
NumeroNota Int - Número da nota
DataEmissaoNota Datetime - Data de emissão da nota
NumeroObjeto String 20 Número do objeto
QuantidadeVolumes Int - Quantidade volumes
CodigoMotivoCancelamento Int - Código do motivo de cancelamento
MotivoCancelamento String 50 Motivo do cancelamento

2.35.5 XML de exemplo

1) Foi configurado na interface um novo status para ser integrado “CADASTRADO”.

Página 133 de 137


2) No momento em que o pedido ficou com o status “CADASTRADO”, foi executado
o método para verificar os status disponíveis para integração.

3) Execução do método com o retorno dos status disponíveis para integração.


REQUEST
<soapenv:Body>
<abac:StatusPedidoDisponiveis>
<abac:ChaveIdentificacao>1580A94C-11FB-48D8-82E5-
FFC6324771F4</abac:ChaveIdentificacao>
</abac:StatusPedidoDisponiveis>
</soapenv:Body>

RESPONSE
<soap:Body>
<StatusPedidoDisponiveisResponse

Página 134 de 137


xmlns="http://www.kplsolucoes.com.br/ABACOSWebservice">
<StatusPedidoDisponiveisResult>
<VersaoWebservice>5.0.89.0</VersaoWebservice>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operação "Status de pedidos" efetuada com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosStatusPedido>
<ProtocoloStatusPedido>4B6F10B1-1475-4399-B26B-
E5CD801E3342</ProtocoloStatusPedido>
<NumeroPedido>ME5614</NumeroPedido>
<CodigoPedidoAbacos>5614</CodigoPedidoAbacos>
<CodigoStatus>CADASTRADO</CodigoStatus>
<StatusPedido>CADASTRADO</StatusPedido>
<DataHora>23022016 21:03:58.193</DataHora>
<SerieNota/>
<NumeroNota>0</NumeroNota>
<DataEmissaoNota/>
<NumeroObjeto/>
<QuantidadeVolumes>0</QuantidadeVolumes>
<CodigoMotivoCancelamento/>
<MotivoCancelamento/>
</DadosStatusPedido>
</Rows>
</StatusPedidoDisponiveisResult>
</StatusPedidoDisponiveisResponse> </soap:Body>

Regras de negócio

 Confirmar recebimento do registro


Uma vez que o registro fica disponível para integração, é necessário informar que o mesmo foi recebido
e integrado corretamente para que não fique mais disponível na fila de integração. A confirmação de
recebimento e integração, deve ser feita através do método ConfirmarStatusPedidoDisponiveis.

GetVersion

Conceito

O método GetVersion foi desenvolvido para obter a versão do webservice de do KPL Enterprise.

Objetivo

Através desse método é possível ter conhecimento de forma prática da versão do webservice e KPL.

Pré-requisitos

Não se aplica.

Propriedades

LAYOUT REQUEST

Campo Tipo Max Obrig Descrição

Página 135 de 137


GetVersion

ChaveIdentificacao String 255 Identificação única da interface

LAYOUT RESPONSE

Campo Tipo Max Obrig Descrição


GetVersionResult

VersaoWebService String 255 Versão do webservice

VersaoAbacos String 255 Versão do KPL Enterprise

Info String 255 Informações framework

XML de exemplo

1) Após o recebimento do Traking, foi executado o método para obter o Traking disponível.

REQUEST
<soapenv:Body>
<abac:GetVersion>
<abac:ChaveIdentificacao>F01EF5DD-ACA8-4EBE-8562-
3EC30F3A809C</abac:ChaveIdentificacao>
</abac:GetVersion>
</soapenv:Body>

RESPONSE
<soap:Body>
<GetVersionResponse xmlns="http://www.kplsolucoes.com.br/ABACOSWebService">
<GetVersionResult>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operação "Dados da versão" efetuada com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<VersaoWebService>5.99.0.4604</VersaoWebService>
<VersaoAbacos>Versão 5 Build 99 Revisão 102</VersaoAbacos>
<Info>AbacosWSWMS .NET 4.5</Info>
</GetVersionResult>
</GetVersionResponse>
</soap:Body>

Regras de negócio

Não se aplica.

Página 136 de 137


Perguntas Frequentes

Acesse nosso site de developers através do link: Central de Ajuda Developers

Página 137 de 137

Você também pode gostar