0% acharam este documento útil (0 voto)

457 visualizações

KPL API Docs - WS Plataforma

KPL API

Enviado por

Marllon Felipe Muniz De Farias Alves

Direitos autorais

Levamos muito a sério os direitos de conteúdo. Se você suspeita que este conteúdo é seu, reivindique-o aqui.

Formatos disponíveis

Baixe no formato PDF, TXT ou leia on-line no Scribd

0% acharam este documento útil (0 voto)

457 visualizações

KPL API Docs - WS Plataforma

KPL API

Enviado por

Marllon Felipe Muniz De Farias Alves

Direitos autorais

Levamos muito a sério os direitos de conteúdo. Se você suspeita que este conteúdo é seu, reivindique-o aqui.

Formatos disponíveis

Baixe no formato PDF, TXT ou leia on-line no Scribd

Você está na página 1/ 186

API DOCS

WSPLATAFORMA

Copyright 2001-2014, KPL, Todos os direitos reservados.

Verso: 2.0 KPL ENTERPRISE

SUMRIO

SUMRIO................................................................................................................................................. 2
1 DICIONRIO DE DADOS DO WEBSERVICE KPL ENTERPRISE .............................................................. 12
1.1 OPERAO REALIZADA ................................................................................................................ 12
1.2 ENUMTIPO ................................................................................................................................... 12
1.3 ENUMACAO ................................................................................................................................. 12
1.4 ENUMTIPOPRODUTO................................................................................................................... 13
1.5 ENUMSEXO .................................................................................................................................. 13
1.6 ENUMTIPOATRIBUTOESTENDIDO ............................................................................................... 13
1.7 ENUMPRODUTOTIPOLIGACAO .................................................................................................... 13
1.8 ENUMTIPOLOCALENTREGA ......................................................................................................... 13
1.9 ENUMTIPOPESSOA ...................................................................................................................... 13
1.10 ENUMSTATUSPAGAMENTO ...................................................................................................... 14
1.11 ENUMOPTOUNFPAULISTA ......................................................................................................... 14
1.12 ENUMSTATUSATUAL ................................................................................................................. 14
1.13 ENUMTIPOLISTAPRESENTE ........................................................................................................ 14
1.14 ENUMTPERSONALIZACAOCLASSIFICACAO ................................................................................ 14
1.15 ENUMTIPOCONTROLEESTOQUE ................................................................................................ 14
1.16 ENUMTIPOCLIFOR...................................................................................................................... 15
1.17 ENUMTIPOCONTRIBUINTE ........................................................................................................ 15
2 MTODOS WSPLATAFORMA .............................................................................................................. 16
2.1 ALTERARITEMPEDIDOFRETE ........................................................................................................ 16
2.1.1 CONCEITO .............................................................................................................................. 16
2.1.2 OBJETIVO ............................................................................................................................... 16
2.1.3 PR-REQUISITOS .................................................................................................................... 16
2.1.4 PROPRIEDADES ...................................................................................................................... 16
2.1.5 XML DE EXEMPLO.................................................................................................................. 17
2.1.6 REGRAS DE NEGCIO ............................................................................................................ 18
2.1.7 PERGUNTAS FREQUENTES .................................................................................................... 18
2.1.8 HISTRICO DE ALTERAES .................................................................................................. 18
2.2 CADASTRARCLIENTE .................................................................................................................... 19
2.2.1 CONCEITO .............................................................................................................................. 19
2.2.2 OBJETIVO ............................................................................................................................... 19
2.2.3 PR-REQUISITOS .................................................................................................................... 19
2.2.4 PROPRIEDADES ...................................................................................................................... 23
2.2.5 XML DE EXEMPLO.................................................................................................................. 24
2.2.6 REGRAS DE NEGCIO ............................................................................................................ 26
2.2.7 PERGUNTAS FREQUENTES .................................................................................................... 26
2.2.8 HISTRICO DE ALTERAES .................................................................................................. 26
2.3 CANCELARPEDIDO ....................................................................................................................... 27
2.3.1 CONCEITO .............................................................................................................................. 27
2.3.2 OBJETIVO ............................................................................................................................... 27
2.3.3 PR-REQUISITOS .................................................................................................................... 27
2.3.4 PROPRIEDADES ...................................................................................................................... 28
2.3.5 XML DE EXEMPLO.................................................................................................................. 29
2.3.6 REGRAS DE NEGCIO ............................................................................................................ 30
www.kpl.com.br Pgina 2 de 186
Verso: 2.0 KPL ENTERPRISE

2.3.7 PERGUNTAS FREQUENTES .................................................................................................... 30

2.3.8 HISTRICO DE ALTERAES .................................................................................................. 30
2.4 CATEGORIASPRODUTOSDISPONIVEIS ......................................................................................... 31
2.4.1 CONCEITO .............................................................................................................................. 31
2.4.2 OBJETIVO ............................................................................................................................... 31
2.4.3 PR-REQUISITOS .................................................................................................................... 31
2.4.4 PROPRIEDADES ...................................................................................................................... 32
2.4.5 XML DE EXEMPLO.................................................................................................................. 33
2.4.6 REGRAS DE NEGCIO ............................................................................................................ 35
2.4.7 PERGUNTAS FREQUENTES .................................................................................................... 35
2.4.8 HISTRICO DE ALTERAES .................................................................................................. 35
2.5 CLASSESDISPONIVEIS ................................................................................................................... 36
2.5.1 CONCEITO .............................................................................................................................. 36
2.5.2 OBJETIVO ............................................................................................................................... 36
2.5.3 PR-REQUISITOS .................................................................................................................... 36
2.5.4 PROPRIEDADES ...................................................................................................................... 37
2.5.6 XML DE EXEMPLO.................................................................................................................. 37
2.5.7 REGRAS DE NEGCIO ............................................................................................................ 38
2.5.8 PERGUNTAS FREQUENTES .................................................................................................... 38
2.5.9 HISTRICO DE ALTERAES .................................................................................................. 38
2.6 CONFIRMARCATEGORIASITEATUALIZARCODIGO........................................................................ 39
2.6.1 CONCEITO .............................................................................................................................. 39
2.6.2 OBJETIVO ............................................................................................................................... 39
2.6.3 PR-REQUISITOS .................................................................................................................... 39
2.6.4 PROPRIEDADES ...................................................................................................................... 39
2.6.5 XML DE EXEMPLO.................................................................................................................. 39
2.6.6 REGRAS DE NEGCIO ............................................................................................................ 40
2.6.7 PERGUNTAS FREQUENTES .................................................................................................... 40
2.6.8 HISTRICO DE ALTERAES .................................................................................................. 40
2.7 CONFIRMARRECEBIMENTOPRECOLOTE .................................................................................. 41
2.7.1 CONCEITO .............................................................................................................................. 41
2.7.2 OBJETIVO ............................................................................................................................... 41
2.7.3 PR-REQUISITOS .................................................................................................................... 41
2.7.4 PROPRIEDADES ...................................................................................................................... 41
2.7.5 XML DE EXEMPLO.................................................................................................................. 41
2.7.6 REGRAS DE NEGCIO ............................................................................................................ 42
2.7.7 PERGUNTAS FREQUENTES .................................................................................................... 42
2.7.8 HISTRICO DE ALTERAES .................................................................................................. 42
2.8 CONFIRMARRECEBIMENTOPRODUTOLOTE ................................................................................ 43
2.8.1 CONCEITO .............................................................................................................................. 43
2.8.2 OBJETIVO ............................................................................................................................... 43
2.8.3 PR-REQUISITOS .................................................................................................................... 43
2.8.4 PROPRIEDADES ...................................................................................................................... 43
2.8.5 XML DE EXEMPLO.................................................................................................................. 43
2.8.6 REGRAS DE NEGCIO ............................................................................................................ 44
2.8.7 PERGUNTAS FREQUENTES .................................................................................................... 44
2.8.8 HISTRICO DE ALTERAES .................................................................................................. 44
www.kpl.com.br Pgina 3 de 186
Verso: 2.0 KPL ENTERPRISE

2.9 CONFIRMARPAGAMENTOS ......................................................................................................... 45

2.9.1 CONCEITO .............................................................................................................................. 45
2.9.2 OBJETIVO ............................................................................................................................... 45
2.9.3 PR-REQUISITOS .................................................................................................................... 45
2.9.4 PROPRIEDADES ...................................................................................................................... 45
2.9.5 XML DE EXEMPLO.................................................................................................................. 46
2.9.6 REGRAS DE NEGCIO ............................................................................................................ 47
2.9.7 PERGUNTAS FREQUENTES .................................................................................................... 47
2.9.8 HISTRICO DE ALTERAES .................................................................................................. 47
2.10 CONFIRMARPAGAMENTOSPEDIDOS ......................................................................................... 48
2.10.1 CONCEITO ............................................................................................................................ 48
2.10.2 OBJETIVO ............................................................................................................................. 48
2.10.3 PR-REQUISITOS .................................................................................................................. 48
2.10.4 PROPRIEDADES.................................................................................................................... 48
2.10.5 XML DE EXEMPLO................................................................................................................ 49
2.10.6 REGRAS DE NEGCIO .......................................................................................................... 50
2.10.7 PERGUNTAS FREQUENTES .................................................................................................. 50
2.10.8 HISTRICO DE ALTERAES ................................................................................................ 50
2.11 CONFIRMARPRODUTOATUALIZARCODIGO ............................................................................... 51
2.11.1 CONCEITO ............................................................................................................................ 51
2.11.2 OBJETIVO ............................................................................................................................. 51
2.11.3 PR-REQUISITOS .................................................................................................................. 51
2.11.4 PROPRIEDADES.................................................................................................................... 51
2.11.5 XML DE EXEMPLO................................................................................................................ 51
2.11.6 REGRAS DE NEGCIO .......................................................................................................... 52
2.11.7 PERGUNTAS FREQUENTES .................................................................................................. 52
2.11.8 HISTRICO DE ALTERAES ................................................................................................ 52
2.12 CONFIRMARRECEBIMENTOCATEGORIAPRODUTO ................................................................... 53
2.12.1 CONCEITO ............................................................................................................................ 53
2.12.2 OBJETIVO ............................................................................................................................. 53
2.12.3 PR-REQUISITOS .................................................................................................................. 53
2.12.4 PROPRIEDADES.................................................................................................................... 53
2.12.5 XML DE EXEMPLO................................................................................................................ 53
2.11.6 REGRAS DE NEGCIO .......................................................................................................... 54
2.12.7 PERGUNTAS FREQUENTES .................................................................................................. 54
2.12.8 HISTRICO DE ALTERAES ................................................................................................ 54
2.13 CONFIRMARRECEBIMENTOCLASSE ........................................................................................... 55
2.13.1 CONCEITO ............................................................................................................................ 55
2.13.2 OBJETIVO ............................................................................................................................. 55
2.13.3 PR-REQUISITOS .................................................................................................................. 55
2.13.4 PROPRIEDADES.................................................................................................................... 55
2.13.5 XML DE EXEMPLO................................................................................................................ 55
2.13.6 REGRAS DE NEGCIO .......................................................................................................... 56
2.13.7 PERGUNTAS FREQUENTES .................................................................................................. 56
2.13.8 HISTRICO DE ALTERAES ................................................................................................ 56
2.14 CONFIRMARRECEBIMENTODESCRITORPREDEFINIDO............................................................... 57
2.14.1 CONCEITO ............................................................................................................................ 57
www.kpl.com.br Pgina 4 de 186
Verso: 2.0 KPL ENTERPRISE

2.14.2 OBJETIVO ............................................................................................................................. 57

2.14.3 PR-REQUISITOS .................................................................................................................. 57
2.14.4 PROPRIEDADES.................................................................................................................... 57
2.14.5 XML DE EXEMPLO................................................................................................................ 57
2.14.6 REGRAS DE NEGCIO .......................................................................................................... 58
2.14.7 PERGUNTAS FREQUENTES .................................................................................................. 58
2.14.8 HISTRICO DE ALTERAES ................................................................................................ 58
2.15 CONFIRMARRECEBIMENTOESTOQUE ....................................................................................... 59
2.15.1 CONCEITO ............................................................................................................................ 59
2.15.2 OBJETIVO ............................................................................................................................. 59
2.15.3 PR-REQUISITOS .................................................................................................................. 59
2.15.4 PROPRIEDADES.................................................................................................................... 59
2.15.5 XML DE EXEMPLO................................................................................................................ 59
2.15.6 REGRAS DE NEGCIO .......................................................................................................... 60
2.15.7 PERGUNTAS FREQUENTES .................................................................................................. 60
2.15.8 HISTRICO DE ALTERAES ................................................................................................ 60
2.16 CONFIRMARRECEBIMENTOFAMILIA ......................................................................................... 61
2.16.1 CONCEITO ............................................................................................................................ 61
2.16.2 OBJETIVO ............................................................................................................................. 61
2.16.3 PR-REQUISITOS .................................................................................................................. 61
2.16.4 PROPRIEDADES.................................................................................................................... 61
2.16.5 XML DE EXEMPLO................................................................................................................ 61
2.16.6 REGRAS DE NEGCIO .......................................................................................................... 62
2.16.7 PERGUNTAS FREQUENTES .................................................................................................. 62
2.16.8 HISTRICO DE ALTERAES ................................................................................................ 62
2.17 CONFIRMARRECEBIMENTOGRUPOPRODUTO........................................................................... 63
2.17.1 CONCEITO ............................................................................................................................ 63
2.17.2 OBJETIVO ............................................................................................................................. 63
2.17.3 PR-REQUISITOS .................................................................................................................. 63
2.17.4 PROPRIEDADES.................................................................................................................... 63
2.17.5 XML DE EXEMPLO................................................................................................................ 63
2.17.6 REGRAS DE NEGCIO .......................................................................................................... 64
2.17.7 PERGUNTAS FREQUENTES .................................................................................................. 64
2.17.8 HISTRICO DE ALTERAES ................................................................................................ 64
2.18 CONFIRMARRECEBIMENTOLISTAPRESENTE .............................................................................. 65
2.18.1 CONCEITO ............................................................................................................................ 65
2.18.2 OBJETIVO ............................................................................................................................. 65
2.18.3 PR-REQUISITOS .................................................................................................................. 65
2.18.4 PROPRIEDADES.................................................................................................................... 65
2.18.5 XML DE EXEMPLO................................................................................................................ 65
2.18.6 REGRAS DE NEGCIO .......................................................................................................... 66
2.18.7 PERGUNTAS FREQUENTES .................................................................................................. 66
2.18.8 HISTRICO DE ALTERAES ................................................................................................ 66
2.19 CONFIRMARRECEBIMENTOMARCA ........................................................................................... 67
2.19.1 CONCEITO ............................................................................................................................ 67
2.19.2 OBJETIVO ............................................................................................................................. 67
2.19.3 PR-REQUISITOS .................................................................................................................. 67
www.kpl.com.br Pgina 5 de 186
Verso: 2.0 KPL ENTERPRISE

2.19.4 PROPRIEDADES.................................................................................................................... 67
2.19.5 XML DE EXEMPLO................................................................................................................ 67
2.19.6 REGRAS DE NEGCIO .......................................................................................................... 68
2.19.7 PERGUNTAS FREQUENTES .................................................................................................. 68
2.19.8 HISTRICO DE ALTERAES ................................................................................................ 68
2.20 CONFIRMARRECEBIMENTOPEDIDO .......................................................................................... 69
2.20.1 CONCEITO ............................................................................................................................ 69
2.20.2 OBJETIVO ............................................................................................................................. 69
2.20.3 PR-REQUISITOS .................................................................................................................. 69
2.20.4 PROPRIEDADES.................................................................................................................... 69
2.20.5 XML DE EXEMPLO................................................................................................................ 69
2.20.7 REGRAS DE NEGCIO .......................................................................................................... 70
2.20.8 PERGUNTAS FREQUENTES .................................................................................................. 70
2.20.9 HISTRICO DE ALTERAES ................................................................................................ 70
2.21 CONFIRMARRECEBIMENTOPRECO ............................................................................................ 71
2.21.1 CONCEITO ............................................................................................................................ 71
2.21.2 OBJETIVO ............................................................................................................................. 71
2.21.3 PR-REQUISITOS .................................................................................................................. 71
2.21.4 PROPRIEDADES.................................................................................................................... 71
2.21.5 XML DE EXEMPLO................................................................................................................ 71
2.21.6 REGRAS DE NEGCIO .......................................................................................................... 72
2.21.7 PERGUNTAS FREQUENTES .................................................................................................. 72
2.21.8 HISTRICO DE ALTERAES ................................................................................................ 72
2.22 CONFIRMARRECEBIMENTOPRODUTO ...................................................................................... 73
2.22.1 CONCEITO ............................................................................................................................ 73
2.22.2 OBJETIVO ............................................................................................................................. 73
2.22.3 PR-REQUISITOS .................................................................................................................. 73
2.22.4 PROPRIEDADES.................................................................................................................... 73
2.22.5 XML DE EXEMPLO................................................................................................................ 73
2.22.6 REGRAS DE NEGCIO .......................................................................................................... 74
2.22.7 PERGUNTAS FREQUENTES .................................................................................................. 74
2.22.8 HISTRICO DE ALTERAES ................................................................................................ 74
2.23 CONFIRMARRECEBIMENTOSTATUSPEDIDO .............................................................................. 75
2.23.1 CONCEITO ............................................................................................................................ 75
2.23.2 OBJETIVO ............................................................................................................................. 75
2.23.3 PR-REQUISITOS .................................................................................................................. 75
2.23.4 PROPRIEDADES.................................................................................................................... 75
2.23.5 XML DE EXEMPLO ........................................................................................................... 75
2.23.6 REGRAS DE NEGCIO .......................................................................................................... 76
2.23.7 PERGUNTAS FREQUENTES .................................................................................................. 76
2.23.8 HISTRICO DE ALTERAES ................................................................................................ 76
2.24 CONFIRMARRECEBIMENTOSTATUSTRAKING......................................................................... 77
2.24.1 CONCEITO ............................................................................................................................ 77
2.24.2 OBJETIVO ............................................................................................................................. 77
2.24.3 PR-REQUISITOS .................................................................................................................. 77
2.24.4 PROPRIEDADES.................................................................................................................... 77
2.24.5 XML DE EXEMPLO................................................................................................................ 77
www.kpl.com.br Pgina 6 de 186
Verso: 2.0 KPL ENTERPRISE

2.24.6 REGRAS DE NEGCIO .......................................................................................................... 78

2.24.7 PERGUNTAS FREQUENTES .................................................................................................. 78
2.24.8 HISTRICO DE ALTERAES ................................................................................................ 78
2.25 CONFIRMARRECEBIMENTOSUBGRUPOPRODUTO .................................................................... 79
2.25.1 CONCEITO ............................................................................................................................ 79
2.25.2 OBJETIVO ............................................................................................................................. 79
2.25.3 PR-REQUISITOS .................................................................................................................. 79
2.25.4 PROPRIEDADES.................................................................................................................... 79
2.25.5 XML DE EXEMPLO................................................................................................................ 79
2.25.6 REGRAS DE NEGCIO .......................................................................................................... 80
2.25.7 PERGUNTAS FREQUENTES .................................................................................................. 80
2.25.8 HISTRICO DE ALTERAES ................................................................................................ 80
2.26 DESCRITORESPREDEFINIDOSDISPONIVEIS ................................................................................ 81
2.26.1 CONCEITO ............................................................................................................................ 81
2.26.2 OBJETIVO ............................................................................................................................. 81
2.26.3 PR-REQUISITOS .................................................................................................................. 81
2.26.4 PROPRIEDADES.................................................................................................................... 82
2.26.5 XML DE EXEMPLO................................................................................................................ 83
2.26.6 REGRAS DE NEGCIO .......................................................................................................... 85
2.26.7 PERGUNTAS FREQUENTES .................................................................................................. 85
2.26.8 HISTRICO DE ALTERAES ................................................................................................ 85
2.27 ESTOQUEONLINE ....................................................................................................................... 86
2.27.1 CONCEITO ............................................................................................................................ 86
2.27.2 OBJETIVO ............................................................................................................................. 86
2.27.3 PR-REQUISITOS .................................................................................................................. 86
2.27.4 PROPRIEDADES.................................................................................................................... 86
2.27.5 XML DE EXEMPLO................................................................................................................ 86
2.27.6 REGRAS DE NEGCIO .......................................................................................................... 87
2.27.7 PERGUNTAS FREQUENTES .................................................................................................. 87
2.27.8 HISTRICO DE ALTERAES ................................................................................................ 87
2.28 ESTOQUEONLINESALDO ............................................................................................................ 88
2.28.1 CONCEITO ............................................................................................................................ 88
2.2.2 OBJETIVO ............................................................................................................................... 88
2.28.3 PR-REQUISITOS .................................................................................................................. 88
2.28.4 PROPRIEDADES.................................................................................................................... 88
2.28.5 XML DE EXEMPLO................................................................................................................ 89
2.28.6 REGRAS DE NEGCIO .......................................................................................................... 89
2.28.7 PERGUNTAS FREQUENTES .................................................................................................. 89
2.29 ESTOQUESDISPONIVEIS ............................................................................................................. 90
2.29.1 CONCEITO ............................................................................................................................ 90
2.29.2 OBJETIVO ............................................................................................................................. 90
2.29.3 PR-REQUISITOS .................................................................................................................. 90
2.29.4 PROPRIEDADES.................................................................................................................... 92
2.29.5 XML DE EXEMPLO................................................................................................................ 92
2.29.6 REGRAS DE NEGCIO .......................................................................................................... 94
2.29.7 PERGUNTAS FREQUENTES .................................................................................................. 94
2.29.8 HISTRICO DE ALTERAES ................................................................................................ 94
www.kpl.com.br Pgina 7 de 186
Verso: 2.0 KPL ENTERPRISE

2.30 FAMILIASDISPONIVEIS ............................................................................................................... 95

2.30.1 CONCEITO ............................................................................................................................ 95
2.30.2 OBJETIVO ............................................................................................................................. 95
2.30.3 PR-REQUISITOS .................................................................................................................. 95
2.29.4 PROPRIEDADES.................................................................................................................... 96
2.30.5 XML DE EXEMPLO................................................................................................................ 96
2.30.6 REGRAS DE NEGCIO .......................................................................................................... 97
2.30.7 PERGUNTAS FREQUENTES .................................................................................................. 97
2.30.8 HISTRICO DE ALTERAES ................................................................................................ 97
2.31 GRUPOPRODUTOSDISPONIVEIS ................................................................................................ 98
2.31.1 CONCEITO ............................................................................................................................ 98
2.31.2 OBJETIVO ............................................................................................................................. 98
2.31.3 PR-REQUISITOS .................................................................................................................. 98
2.31.4 PROPRIEDADES.................................................................................................................... 99
2.31.5 XML DE EXEMPLO................................................................................................................ 99
2.31.6 REGRAS DE NEGCIO ........................................................................................................ 100
2.31.7 PERGUNTAS FREQUENTES ................................................................................................ 100
2.31.8 HISTRICO DE ALTERAES .............................................................................................. 100
2.32 INSERIRLISTAPRESENTE ........................................................................................................... 101
2.32.1 CONCEITO .......................................................................................................................... 101
2.32.2 OBJETIVO ........................................................................................................................... 101
2.32.3 PR-REQUISITOS ................................................................................................................ 101
2.32.4 PROPRIEDADES.................................................................................................................. 101
2.32.5 XML DE EXEMPLO.............................................................................................................. 102
2.32.7 REGRAS DE NEGCIO ........................................................................................................ 103
2.32.8 PERGUNTAS FREQUENTES ................................................................................................ 103
2.32.9 HISTRICO DE ALTERAES .............................................................................................. 103
2.33 INSERIRPEDIDO ........................................................................................................................ 104
2.33.1 CONCEITO .......................................................................................................................... 104
2.33.2 OBJETIVO ........................................................................................................................... 104
2.33.3 PR-REQUISITOS ................................................................................................................ 104
2.33.4 PROPRIEDADES.................................................................................................................. 108
2.33.5 XML DE EXEMPLO.............................................................................................................. 112
2.33.6 REGRAS DE NEGCIO ........................................................................................................ 115
2.33.7 PERGUNTAS FREQUENTES ................................................................................................ 115
2.34 LISTAPRESENTEDISPONIVEIS ................................................................................................... 116
2.34.1 CONCEITO .......................................................................................................................... 116
2.34.2 OBJETIVO ........................................................................................................................... 116
2.34.3 PR-REQUISITOS ................................................................................................................ 116
2.34.4 PROPRIEDADES.................................................................................................................. 116
2.34.5 XML DE EXEMPLO.............................................................................................................. 119
2.34.6 REGRAS DE NEGCIO ........................................................................................................ 122
2.34.7 PERGUNTAS FREQUENTES ................................................................................................ 122
2.34.8 HISTRICO DE ALTERAES .............................................................................................. 122
2.35 MARCASDISPONIVEIS .............................................................................................................. 123
2.35.1 CONCEITO .......................................................................................................................... 123
2.35.2 OBJETIVO ........................................................................................................................... 123
www.kpl.com.br Pgina 8 de 186
Verso: 2.0 KPL ENTERPRISE

2.35.3 PR-REQUISITOS ................................................................................................................ 123

2.35.4 PROPRIEDADES.................................................................................................................. 124
2.35.5 XML DE EXEMPLO.............................................................................................................. 124
2.35.6 REGRAS DE NEGCIO ........................................................................................................ 125
2.35.7 PERGUNTAS FREQUENTES ................................................................................................ 125
2.35.8 HISTRICO DE ALTERAES .............................................................................................. 125
2.36 MONITORIAINTEGRACAO ........................................................................................................ 126
2.36.1 CONCEITO .......................................................................................................................... 126
2.36.2 OBJETIVO ........................................................................................................................... 126
2.36.3 PR-REQUISITOS ................................................................................................................ 126
2.36.4 PROPRIEDADES.................................................................................................................. 126
2.36.5 XML DE EXEMPLO.............................................................................................................. 126
2.36.6 REGRAS DE NEGCIO ........................................................................................................ 128
2.36.7 PERGUNTAS FREQUENTES ................................................................................................ 128
2.36.8 HISTRICO DE ALTERAES .............................................................................................. 128
2.37 PAGAMENTOPEDIDODISPONIVEL ........................................................................................... 129
2.37.1 CONCEITO .......................................................................................................................... 129
2.37.2 OBJETIVO ........................................................................................................................... 129
2.37.3 PR-REQUISITOS ................................................................................................................ 129
2.37.4 PROPRIEDADES.................................................................................................................. 129
2.37.5 XML DE EXEMPLO.............................................................................................................. 129
2.37.6 REGRAS DE NEGCIO ........................................................................................................ 132
2.37.7 PERGUNTAS FREQUENTES ................................................................................................ 132
2.37.3 HISTRICO DE ALTERAES .............................................................................................. 132
2.38 PEDIDOEXISTE .......................................................................................................................... 133
2.38.1 CONCEITO .......................................................................................................................... 133
2.38.2 OBJETIVO ........................................................................................................................... 133
2.38.3 PR-REQUISITOS ................................................................................................................ 133
2.38.4 PROPRIEDADES.................................................................................................................. 133
2.38.5 XML DE EXEMPLO.............................................................................................................. 134
2.38.6 REGRAS DE NEGCIO ........................................................................................................ 135
2.38.7 PERGUNTAS FREQUENTES ................................................................................................ 135
2.38.8 HISTRICO DE ALTERAES .............................................................................................. 135
2.39 PEDIDOSDISPONIVEIS .............................................................................................................. 136
2.39.1 CONCEITO .......................................................................................................................... 136
2.39.2 OBJETIVO ........................................................................................................................... 136
2.39.3 PR-REQUISITOS ................................................................................................................ 136
2.39.4 PROPRIEDADES.................................................................................................................. 139
2.39.5 XML DE EXEMPLO.............................................................................................................. 141
2.39.6 REGRAS DE NEGCIO ........................................................................................................ 145
2.39.7 PERGUNTAS FREQUENTES ................................................................................................ 145
2.39.8 HISTRICO DE ALTERAES .............................................................................................. 145
2.40 STATUSPEDIDODISPONIVEIS ................................................................................................... 146
2.40.1 CONCEITO .......................................................................................................................... 146
2.40.2 OBJETIVO ........................................................................................................................... 146
2.40.3 PR-REQUISITOS ................................................................................................................ 146
2.40.4 PROPRIEDADES.................................................................................................................. 147
www.kpl.com.br Pgina 9 de 186
Verso: 2.0 KPL ENTERPRISE

2.40.5 XML DE EXEMPLO.............................................................................................................. 148

2.40.6 REGRAS DE NEGCIO ........................................................................................................ 149
2.40.7 PERGUNTAS FREQUENTES ................................................................................................ 150
2.40.8 HISTRICO DE ALTERAES .............................................................................................. 150
2.41 PRECOSDISPONIVEIS ................................................................................................................ 151
2.41.1 CONCEITO .......................................................................................................................... 151
2.41.2 OBJETIVO ........................................................................................................................... 151
2.41.3 PR-REQUISITOS ................................................................................................................ 151
2.41.4 PROPRIEDADES.................................................................................................................. 152
2.41.5 XML DE EXEMPLO.............................................................................................................. 153
2.41.6 REGRAS DE NEGCIO ........................................................................................................ 155
2.41.8 PERGUNTAS FREQUENTES ................................................................................................ 155
2.41.8 HISTRICO DE ALTERAES .............................................................................................. 155
2.42 PRECOONLINE .......................................................................................................................... 156
2.42.1 CONCEITO .......................................................................................................................... 156
2.42.2 OBJETIVO ........................................................................................................................... 156
2.42.3 PR-REQUISITOS ................................................................................................................ 156
2.42.4 PROPRIEDADES.................................................................................................................. 157
2.42.5 XML DE EXEMPLO.............................................................................................................. 157
2.42.6 REGRAS DE NEGCIO ........................................................................................................ 159
2.42.7 PERGUNTAS FREQUENTES ................................................................................................ 159
2.42.8 HISTRICO DE ALTERAES .............................................................................................. 159
2.43 PRODUTOEXISTE ...................................................................................................................... 160
2.43.1 CONCEITO .......................................................................................................................... 160
2.43.2 OBJETIVO ........................................................................................................................... 160
2.43.3 PR-REQUISITOS ................................................................................................................ 160
2.43.4 PROPRIEDADES.................................................................................................................. 160
2.43.5 XML DE EXEMPLO.............................................................................................................. 161
2.43.6 REGRAS DE NEGCIO ........................................................................................................ 162
2.43.7 PERGUNTAS FREQUENTES ................................................................................................ 162
2.43.8 HISTRICO DE ALTERAES .............................................................................................. 162
2.44 PRODUTOSDISPONIVEIS .......................................................................................................... 163
2.44.1 CONCEITO .......................................................................................................................... 163
2.44.2 OBJETIVO ........................................................................................................................... 163
2.44.3 PR-REQUISITOS ................................................................................................................ 163
2.44.4 PROPRIEDADES.................................................................................................................. 164
2.44.5 XML DE EXEMPLO.............................................................................................................. 168
2.44.6 REGRAS DE NEGCIO ........................................................................................................ 175
2.44.7 PERGUNTAS FREQUENTES ................................................................................................ 176
2.44.8 HISTRICO DE ALTERAES .............................................................................................. 176
2.45 STATUSPEDIDOTRAKING.......................................................................................................... 177
2.45.1 CONCEITO .......................................................................................................................... 177
2.45.2 OBJETIVO ........................................................................................................................... 177
2.45.3 PR-REQUISITOS ................................................................................................................ 177
2.45.4 PROPRIEDADES.................................................................................................................. 177
2.45.5 XML DE EXEMPLO.............................................................................................................. 178
2.45.7 REGRAS DE NEGCIO ........................................................................................................ 178
www.kpl.com.br Pgina 10 de 186
Verso: 2.0 KPL ENTERPRISE

2.45.8 PERGUNTAS FREQUENTES ................................................................................................ 179

2.45.9 HISTRICO DE ALTERAES .............................................................................................. 179
2.46 SUBGRUPOPRODUTOSDISPONIVEIS ........................................................................................ 180
2.46.1 CONCEITO .......................................................................................................................... 180
2.46.2 OBJETIVO ........................................................................................................................... 180
2.46.3 PR-REQUISITOS ................................................................................................................ 180
2.46.4 PROPRIEDADES.................................................................................................................. 181
2.46.5 XML DE EXEMPLO.............................................................................................................. 181
2.46.6 REGRAS DE NEGCIO ........................................................................................................ 183
2.46.7 PERGUNTAS FREQUENTES ................................................................................................ 183
2.46.8 HISTRICO DE ALTERAES .............................................................................................. 183
2.47 GETVERSION ............................................................................................................................ 184
2.47.1 CONCEITO .......................................................................................................................... 184
2.47.2 OBJETIVO ........................................................................................................................... 184
2.47.3 PR-REQUISITOS ................................................................................................................ 184
2.47.4 PROPRIEDADES.................................................................................................................. 184
2.44.5 XML DE EXEMPLO.............................................................................................................. 184
2.47.6 HISTRICO DE ALTERAES .............................................................................................. 185
3. ALTERAES VERSO DELPPHI PARA C# ..................................................................................... 186
3.1 TIPOCONTRIBUINTEENUM ........................................................................................................ 186

www.kpl.com.br Pgina 11 de 186

Verso: 2.0 KPL ENTERPRISE

1 DICIONRIO DE DADOS DO WEBSERVICE KPL ENTERPRISE

Descrio de legendas
Campo obrigatrio. necessrio informar valor para o campo indicado.
Necessrio enviar um dos campos.
Campo no deve ser enviado.
Campo obrigatrio desde que exista o node.
Chave nica.
Chave composta.
Chave alternativa.
Protocolo chave de confirmao.
Chave de identificao da interface.
Nota: Os campos que no possurem obrigatoriedade no devem ser enviados nos nodes do XML.

1.1 Operao realizada

Cdigo Tipo Mensagem apresentada

100001 tdreAlerta Ocorreram erros durante a obteno das informaes pertinentes a lista de
itens. Verifique o retorno em cada item para maiores detalhes.
200001 tdreSucesso Operao {0} efetuada com sucesso.

Parmetros: {0} Descrio da operao que foi realizada. Exemplo: Lista de

produtos disponveis para integrao.
200002 tdreSucesso OK.
200003 tdreSucessoSemDados OK, porm no h dados.
300001 tdreErroAplicacao Cdigo do erro no encontrado. Cdigo nr.: {0}.

Parmetros: {0} Nmero do cdigo de erro que no se encontra na lista.

300002 tdreErroDataBase Erro na obteno dos dados para a integrao. Origem "{0}. Parmetros:
{0} Descreve a origem dos dados onde ocorreu o erro. Exemplo: Lista de
marcas disponveis para integrao.

1.2 enumTipo

Dado Enumerado Descrio TipoDeResultadoEnum

tdreSucesso Sucesso na execuo do Mtodo invocado.
tdreSucessoSemDados Sucesso na execuo do Mtodo invocado, porm sem retorno de dados.
tdreAlerta Alerta na execuo do Mtodo invocado.
tdreErroAplicacao Erro no Web Service durante a execuo do Mtodo invocado.
tdreErroDataBase Erro no Banco de dados durante a execuo do Mtodo invocado.
tdreErroDados Erro nos dados durante a execuo do Mtodo invocado.
tdreErroGeral Erro Geral durante a execuo do Mtodo invocado.
tdreMensagem Uma mensagem no relacionada a um erro. Serve para enviar mensagens
padronizadas.

1.3 enumAcao

Dado Enumerado Descrio TipoDeResultadoEnum

aieEnum Indica a ao para a integrao. Pode ser dos seguintes tipos:
aieIndefinido = Ao no indefinida
aieManutencao = Incluso ou alterao
aieExclusao = Excluso

www.kpl.com.br Pgina 12 de 186

Verso: 2.0 KPL ENTERPRISE

1.4 enumTipoProduto

Dado Enumerado Descrio 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 servio.

1.5 enumSexo

Dado Enumerado Descrio TipoDeResultadoEnum

tseEnum O sexo da pessoa pode ser:
tseFeminino = sexo feminino
tseMasculino = sexo masculino
tseEmpresa = empresa

1.6 enumTipoAtributoEstendido

Dado Enumerado Descrio TipoDeResultadoEnum

TipoAEP O tipo do atributo estendido do produto pode ser:
V = CampoValor
I = CampoInteiro
D = CampoData
S = CampoString
T = CampoTxt

1.7 enumProdutoTipoLigacao

Dado Enumerado Descrio TipoDeResultadoEnum

tptleEnum O tipo da classificao da personalizao do produto pode ser:
tptleIndefinido
tptleProdutoPAI
tptleProdutoFILHO
tptleProdutoKit
tptleProdutoSimples

1.8 enumTipoLocalEntrega

Dado Enumerado Descrio TipoDeResultadoEnum

tleeEnum O tipo de local de entrega pode ser:
tleeDesconhecido = Desconhecido
tleeResidencial = Residencial
tleeComercial = Comercial

1.9 enumTipoPessoa

Dado Enumerado Descrio TipoDeResultadoEnum

tpeEnum O tipo pessoa pode ser:
tpeFisica = Pessoa Fsica
tpeJuridica = Pessoa Jurdica

www.kpl.com.br Pgina 13 de 186

Verso: 2.0 KPL ENTERPRISE

1.10 enumStatusPagamento

Dado Enumerado Descrio TipoDeResultadoEnum

tleeEnum O status do pagamento pode ser:
speNenhum =Nenhum
speRecusado = Pagamento recusado
speConfirmado = Pagamento confirmado

1.11 enumOptouNFPaulista

Dado Enumerado Descrio TipoDeResultadoEnum

tbneEnum O clienteoptou por NF Paulista?
tbneNenhum
tbneSim = Optou NFP
tbneNao = No optou NFP

1.12 enumStatusAtual

Dado Enumerado Descrio TipoDeResultadoEnum

tspeeEnum Status atual do pedido:
tspeeNaoEncontrado = Pedido no encontrado
tspeeEmAndamento = Pedido em andamento
tspeeFaturado = Pedido faturado
tspeeDespachado = Pedido despachado
tspeeEntregue = Pedido entregue
tspeeCancelado = Pedido cancelado

1.13 enumTipoListaPresente

Dado Enumerado Descrio TipoDeResultadoEnum

tlpeEnum Valores disponveis:
tlpeFinanceira
tlpeProdutos

1.14 enumTPersonalizacaoClassificacao

Dado Enumerado Descrio TipoDeResultadoEnum

tpceEnum Valores disponveis:
tpceNenhuma
tpceNomeDeCamisa
tpceNumeroDeCamisa
tpcePatchDeCamisa
tpceNomeNumeroDeCamisa

1.15 enumTipoControleEstoque

Dado Enumerado Descrio TipoDeResultadoEnum

tceeEnum Valores disponveis:
tceeControle
tceeNaoControlaNaoSepara
tceeSeparaNaoControla

www.kpl.com.br Pgina 14 de 186

Verso: 2.0 KPL ENTERPRISE

1.16 enumTipoCliFor

Dado Enumerado Descrio TipoDeResultadoEnum

tipoCliFor Valores disponveis:
tcfIndefinido
tcfCliente
tcfFornecedor
tcfOrcamento

1.17 enumTipoContribuinte

Dado Enumerado Descrio TipoDeResultadoEnum

tipoContribuinte Valores disponveis:
tctrInvalido
tctrContribuinte
tctrNaoContribuinte
tctrIsento

www.kpl.com.br Pgina 15 de 186

Verso: 2.0 KPL ENTERPRISE

2 MTODOS WSPLATAFORMA

2.1 AlterarItemPedidoFrete

2.1.1 Conceito

O mtodo AlterarItemPedidoFrete foi desenvolvido com o objetivo de fazer alteraes no pedido, aps ter
sido includo no KPL.

2.1.2 Objetivo

Atravs deste mtodo ser permitido alterar a quantidade de itens j existentes, excluir itens do pedido e
alterar o valor do frete de um pedido.

2.1.3 Pr-requisitos

S podero ser alterados pedidos j existentes na base de dados do KPL.

2.1.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig. Descrio
ChaveIdentificacao String 36 Identificao nica da interface
ListaDeDadosItemPedidoFrete
DadosItemPedidoFrete
CodigoPedido String 50 Cdigo do produto (externo)
ValorFrete Float - Valor do frete obrigatrio se ValorFrete_specified = 'S'
ValorFrete_specified Char 1 S ou N
ValorDesconto Float - Valor do desconto no pedido obrigatrio se
ValorDesconto_specified='S'. O valor do desconto
rateado proporcionalmente ao valor de cada produto
do pedido.
ValorDesconto_specified Char 1 S ou N
Produtos
DadosProdutosItemPedidoFrete
CodigoProduto String 50 Cdigo do produto (externo)
QuantidadeReduzir String 50 Quantidade reduzir do item, 0 - no ir reduzir, acima
de 0 a quantidade a reduzir

LAYOUT RESPONSE
Campo Tipo Max Descrio
DadosItemPedidoFreteResultado
CodigoPedido String 50 Cdigo Pedido
Resultado
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo Enum - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro

www.kpl.com.br Pgina 16 de 186

Verso: 2.0 KPL ENTERPRISE

2.1.5 XML de exemplo

1) Criao do pedido

2) Foi executado o XML abaixo para aplicar o valor do frete e desconto.

www.kpl.com.br Pgina 17 de 186

Verso: 2.0 KPL ENTERPRISE

3) Tela do KPL com as alteraes aplicadas.

2.1.6 Regras de negcio

A quantidade de itens quando informada ser sempre para reduo, nunca para adio.

Os pedidos podero ser alterados somente se todos os pagamentos (TCOM_PAGPDS) estiverem

pendentes (PAGP_VAL_PAG = 0 and PAGP_DAT_PAG is null).

Aps a alterao, deve-se reiniciar o fluxo do pedido.

O valor do frete rateado pelos itens do pedido. Logo, se este valor for modificado, os valores de frete
cobrado nos itens tambm o sero.

Ao alterar o valor do pedido (sejam por excluir item ou alterar o valor do frete), os valores de desconto
do pedido antigo devem ser rateados nos pagamentos existentes. Exemplificando, se o pedido anterior
era de 120,00 em 3 pagamentos e o novo valor do pedido de 90,00, de cada pagamento ser
descontado 10,00, totalizando 30,00 por pagamento.

2.1.7 Perguntas frequentes

2.1.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 18 de 186

Verso: 2.0 KPL ENTERPRISE

2.2 CadastrarCliente
2.2.1 Conceito

O mtodo CadastrarCliente foi desenvolvido para permitir o cadastro de clientes e/ou fornecedores no KPL
via webservice.

2.2.2 Objetivo

Atravs do mtodo possvel incluir clientes ou fornecedores no KPL via integrao webservice.

Alm de cadastrar, o mtodo permite tambm fazer alteraes no cliente e/ou fornecedor. O
funcionamento ocorre da seguinte maneira, caso o registro no exista na base de dados, o mesmo ser
includo e caso j exista, o KPL realizar as alteraes informadas no XML.

2.2.3 Pr-requisitos

Antes de iniciar a integrao de clientes via integrao webservice, necessrio configurar os parmetros na
interface, conforme seguem:

Ativar replicao na interface

Ativar a replicao no cadastro da interface.

www.kpl.com.br Pgina 19 de 186

Verso: 2.0 KPL ENTERPRISE

Categoria fiscal do cliente

Cadastrar as categorias fiscais no KPL.

Menu: Comercial e Faturamento -> Cadastros -> Clientes e Fornecedores -> Categorias fiscais de clientes

E configurar a categoria fiscal na interface.

Caso a categoria fiscal no esteja configurada, ser exibida a mensagem abaixo no momento da integrao:
Interface = 57 Msg = falta configurar a categoria fiscal do cliente.

www.kpl.com.br Pgina 20 de 186

Verso: 2.0 KPL ENTERPRISE

Campo utilizado como chave nica para o cadastro do cliente

Caso a chave no esteja configurada, ser exibida a mensagem abaixo no momento da integrao:
Interface = 57 Msg = falta configurar a chave de unicidade do cadastro de cliente.

Ramo de atividade

Cadastrar os ramos de atividade no KPL.

Menu: Comercial e Faturamento -> Cadastros -> Clientes e Fornecedores -> Ramos de atividades

www.kpl.com.br Pgina 21 de 186

Verso: 2.0 KPL ENTERPRISE

E configurar o ramo da atividade na interface.

Caso o ramo de atividade no esteja configurado, ser exibida a mensagem abaixo no momento da
integrao: Interface = 57 Msg = falta configurar o ramo de atividade.

Configurar na interface DE-PARA de Pases

No cadastro da interface, deve configurar o DE-PARA de Pases.

Caso o de-para do pais no esteja cadastrado, ser exibida a mensagem abaixo no momento da integrao:
Interface = 57 Cliente = 1712 Msg = Endereo principal: Pas (Brasil) informado no encontrado na interface
De-Para.
www.kpl.com.br Pgina 22 de 186
Verso: 2.0 KPL ENTERPRISE

2.2.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
CadastrarCliente
ChaveIdentificacao String 36 Identificao nica da interface
ListaDeClientes
DadosClientes
VersaoWebService String Verso do webservice
Email String 100 E-mail
CPFouCNPJ String 14 CPF ou CNPJ
Codigo String 50 Cdigo do cliente/fornecedor
TipoPessoa String 1 Valores disponveis: 1.9 enumTipoPessoa
Documento String 14 Nmero de documento
InscricaoEstadual String 14 Inscrio estadual
InscricaoMunicipal String 14 Inscrio municipal
Classificacao String 50 Classificao do cliente/fornecedor
Nome String 100 Nome do cliente (Razo social para pessoa
jurdica)
NomeReduzido String 20 Nome reduzido do cliente (Nome fantasia para
pessoa jurdica)
Sexo String - Valores disponves: 1.5 enumSexo
DataNascimento String 21 Data de nascimento
Profissao String 50 Profisso
Site String 100 Site
Telefone String 15 Telefone
Fax String 15 Fax
Celular String 15 Celular
DataCadastro String 21 Data de cadastro
TipoContribuinte Enum - Valores disponvies: 1.17 enumTipoContribuinte
Endereco
Logradouro String 80 Logradouro
NumeroLogradouro String 50 Nmero do endereo
ComplementoEndereco String 30 Complemento do endereo
Bairro String 60 Bairro
Municipio String 60 Cidade / Municpio / Municpio estrangeiro
Estado String 60 UF / Estado / Estado Estrangeiro
Cep String 20 CEP
TipoLocalEntrega String - Valores disponvies: 1.8 enumTipoLocalEntrega
ReferenciaEndereco String 60 Referncia do endereo
Pais String 100 Pas
EndCodigoIBGE String 8 Cdigo IBGE
EndCobranca
Logradouro String 80 Logradouro
NumeroLogradouro String 50 Nmero do endereo
ComplementoEndereco String 30 Complemento do endereo
Bairro String 60 Bairro
Municipio String 60 Cidade / Municpio / Municpio estrangeiro
Estado String 60 UF / Estado / Estado Estrangeiro
Cep String 20 CEP
TipoLocalEntrega String - Valores disponvies: 1.8 enumTipoLocalEntrega
ReferenciaEndereco String 60 Referncia do endereo
Pais String 100 Pas

www.kpl.com.br Pgina 23 de 186

Verso: 2.0 KPL ENTERPRISE

EndCodigoIBGE String 8 Cdigo IBGE

EndEntrega
Logradouro String 80 Logradouro
NumeroLogradouro String 50 Nmero do endereo
ComplementoEndereco String 50 Complemento do endereo
Bairro String 60 Bairro
Municipio String 60 Cidade / Municpio / Municpio estrangeiro
Estado String 60 UF / Estado / Estado Estrangeiro
Cep String 20 CEP
TipoLocalEntrega String 1 Valores disponvies: 1.8 enumTipoLocalEntrega
ReferenciaEndereco String 60 Referncia do endereo
Pais String 100 Pas
EndCodigoIBGE String 8 Cdigo IBGE do endereo
SubRegiao Char 50 Sub-regio do cliente
ClienteEstrangeiro Char 1 Flag para identificar cliente estrangeiro S ou N
CategoriaFiscal String 100 Categoria Fiscal do cliente
RegimeTributario String Regime tributrio
GrupoCliente String 50 Grupo do cliente
ClientesAtributosEstendidos
VersaoWebService String Verso do webservice
Rows
DadosClienteAtributosEstendidos
Acao String - Valores disponveis: 1.3 enumAcao
NomeAtributo String 255 Nome do atributo
ValorAtributo String 8000 Valor do atributo

LAYOUT RESPONSE
Campo Tipo Max Descrio
DadosClientesResultado
EMail String 100 E-mail
CPFouCNPJ String 14 CPF ou CNPJ
TipoPessoa String - Valores possiveis: 1.9 enumTipoPessoa
Codigo String 50 Cdigo do cliente
Resultado
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo

2.2.5 XML de exemplo

1) Foi executado o XML abaixo para incluso do cliente no KPL.

www.kpl.com.br Pgina 24 de 186

Verso: 2.0 KPL ENTERPRISE

<abac:Documento>111111111</abac:Documento>
<abac:InscricaoEstadual>333333333</abac:InscricaoEstadual>
<abac:InscricaoMunicipal>44444444</abac:InscricaoMunicipal>
<abac:Classificacao>CONSUMIDOR</abac:Classificacao>
<abac:Nome>TESTE INTEGRACAO KPL</abac:Nome>
<abac:NomeReduzido>INTEGRACAO KPL</abac:NomeReduzido>
<abac:Sexo>tseFeminino</abac:Sexo>
<abac:DataNascimento>17122015</abac:DataNascimento>
<abac:Profissao>E-commerce</abac:Profissao>
<abac:Site>www.kplsolucoes.com.br</abac:Site>
<abac:Telefone>11 24247380</abac:Telefone>
<abac:Fax>11 24247380</abac:Fax>
<abac:Celular>11 24247380</abac:Celular>
<abac:DataCadastro>17122015</abac:DataCadastro>
<abac:Endereco>
<abac:Logradouro>Alameda Cauaxi</abac:Logradouro>
<abac:NumeroLogradouro>350</abac:NumeroLogradouro>
<abac:ComplementoEndereco>5 andar</abac:ComplementoEndereco>
<abac:Bairro>Alphaville Industrial</abac:Bairro>
<abac:Municipio>Barueri</abac:Municipio>
<abac:Estado>SP</abac:Estado>
<abac:Cep>06454020</abac:Cep>
<abac:TipoLocalEntrega>tleeDesconhecido</abac:TipoLocalEntrega>
<abac:ReferenciaEndereco>Amil</abac:ReferenciaEndereco>
<abac:Pais>Brasil</abac:Pais>
<abac:EndCodigoIBGE></abac:EndCodigoIBGE>
</abac:Endereco>
<abac:EndCobranca>
<abac:Logradouro>Alameda Cauaxi</abac:Logradouro>
<abac:NumeroLogradouro>350</abac:NumeroLogradouro>
<abac:ComplementoEndereco>5 andar</abac:ComplementoEndereco>
<abac:Bairro>Alphaville Induatrial</abac:Bairro>
<abac:Municipio>Barueri</abac:Municipio>
<abac:Estado>SP</abac:Estado>
<abac:Cep>06454020</abac:Cep>
<abac:TipoLocalEntrega>tleeDesconhecido</abac:TipoLocalEntrega>
<abac:ReferenciaEndereco>Amil</abac:ReferenciaEndereco>
<abac:Pais>Brasil</abac:Pais>
<abac:EndCodigoIBGE></abac:EndCodigoIBGE>
</abac:EndCobranca>
<abac:EndEntrega>
<abac:Logradouro>Alameda Cauaxi</abac:Logradouro>
<abac:NumeroLogradouro>350</abac:NumeroLogradouro>
<abac:ComplementoEndereco>5 anda</abac:ComplementoEndereco>
<abac:Bairro>Alphavile Induatrial</abac:Bairro>
<abac:Municipio>Barueri</abac:Municipio>
<abac:Estado>SP</abac:Estado>
<abac:Cep>06454020</abac:Cep>
<abac:TipoLocalEntrega>tleeDesconhecido</abac:TipoLocalEntrega>
<abac:ReferenciaEndereco>Amil</abac:ReferenciaEndereco>
<abac:Pais>Brasil</abac:Pais>
<abac:EndCodigoIBGE></abac:EndCodigoIBGE>
</abac:EndEntrega>
<abac:SubRegiao>Suldeste</abac:SubRegiao>
<abac:ClienteEstrangeiro></abac:ClienteEstrangeiro>
<abac:CategoriaFiscal></abac:CategoriaFiscal>
<abac:RegimeTributario></abac:RegimeTributario>
<abac:GrupoCliente>Cliente</abac:GrupoCliente>
</abac:DadosClientes>
</abac:ListaDeClientes>
</abac:CadastrarCliente>
</soapenv:Body>
</soapenv:Envelope>

www.kpl.com.br Pgina 25 de 186

Verso: 2.0 KPL ENTERPRISE

2) Cliente cadastrado KPL atravs da integrao webservice.

2.2.6 Regras de negcio

Pode ser enviado um fornecedor ou uma lista de fornecedores por vez.

2.2.7 Perguntas frequentes

2.2.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 26 de 186

Verso: 2.0 KPL ENTERPRISE

2.3 CancelarPedido

2.3.1 Conceito

O mtodo CancelarPedido foi desenvolvido para permitir fazer o cancelamento de pedidos de venda via
integrao webservice.

2.3.2 Objetivo

Atravs deste mtodo ser permitido cancelar pedidos de venda no KPL.

2.3.3 Pr-requisitos

O pedido tem que existir na base de dados dos KPL e com status abaixo de faturado. Caso seja solicitado
o cancelamento de um pedido j faturado, ser retornada a mensagem no XML.

<CancelarPedidoResult>
<CodigoPedido>ME5648</CodigoPedido>
<Resultado>
<Codigo>300005</Codigo>
<Descricao>A execuo da rotina gerou uma crtica. Detalhes: * Origem: Cancelar
pedido * Linha em que ocorreu o erro: 53 * Nome do objeto onde ocorreu o erro:
PGEN_P_RAISERROR * Cdigo de erro do banco de dados: 50000</Descricao>
<Tipo>tdreErroDataBase</Tipo>
<ExceptionMessage>CANPED: PEDIDO JA FOI FATURADO E NAO PODE MAIS SER CANCELADO
(ME5648)erro ao tentar cancelar pedido</ExceptionMessage>
</Resultado>
</CancelarPedidoResult>

Usurio padro

Para executar o cancelamento do pedido via integrao webservice, necessrio definir na interface o
usurio padro que ir efetuar o log do cancelamento.

www.kpl.com.br Pgina 27 de 186

Verso: 2.0 KPL ENTERPRISE

Motivos para cancelamento

Os motivos de cancelamento enviados no webservice, devero estar cadastrados no KPL.

Menu: Comercial e Faturamento -> Movimentaes -> Pedidos -> Outras funes -> Cancelar pedidos

2.3.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ChaveIdentificacao String 36 Identificao nica da interface
DadosCancelamentoPedido
CodigoPedido String 50 Cdigo do pedido para ser cancelado
CodigoMotivoCancelamento Int - Cdigo do motivo de cancelamento. Ser includo no
campo Motivo
MensagemCancelamento String 200 Mensagem de cancelamento. Ser includo no campo
Observao do status

LAYOUT RESPONSE
Campo Tipo Max Descrio
CancelarPedidoResult
CodigoPedido String 50 Cdigo Pedido
Resultado
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo Enum - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro

www.kpl.com.br Pgina 28 de 186

Verso: 2.0 KPL ENTERPRISE

2.3.5 XML de exemplo

1) Foi criado um novo pedido e ficou com o status Aguardando estoque.

2) Em seguida, foi executado o mtodo CancelarPedido, atravs do XML abaixo e o status do pedido no
KPL ficou Cancelado.

www.kpl.com.br Pgina 29 de 186

Verso: 2.0 KPL ENTERPRISE

</CancelarPedidoResponse>
</soap:Body>
</soap:Envelope>

3) Tela do KPL com o pedido cancelado.

2.3.6 Regras de negcio

S pode ser realizado o cancelamento de um pedido por vez.

2.3.7 Perguntas frequentes

2.3.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 30 de 186

Verso: 2.0 KPL ENTERPRISE

2.4 CategoriasProdutosDisponiveis

2.4.1 Conceito

O mtodo CategoriasProdutosDisponiveis foi desenvolvido para disponibilizar as categorias de produtos do

site para integrao.

2.4.2 Objetivo

Atravs desse mtodo possvel obter as informaes de categorias de produtos para o site que esto
disponveis para integrao.

2.4.3 Pr-requisitos

A informao se torna disponvel para integrao quando ocorre uma incluso, alterao ou excluso de
alguma informao.

Ativar replicao de sada

Deve ser habilitada na interface a replicao de sada das categorias do site.

www.kpl.com.br Pgina 31 de 186

Verso: 2.0 KPL ENTERPRISE

Habilitar categorias do site

necessrio habilitar na interface as categorias para integrao.

2.4.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ChaveIdentificacao String 36 Identificao nica da interface

LAYOUT RESPONSE
Campo Tipo Max Descrio
CategoriasProdutoDisponiveisResult
VersaoWebService String Verso do webservice
ResultadoOperacao
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro
Rows
DadosCategoriasProduto
ProtocoloCategoriaProduto String 255 Protocolo categoria produto
Acao String - Valores disponveis: 1.3 enumAcao
CodigoCategoriaProduto Int - Cdigo categoria produto
CodigoCategoriaProdutoPai Int - Cdigo categoria produto pai
Nome String 100 Nome
Classificacao Int - Classificao
OrdemSequencial Int - Ordem sequencial
CodigoTipoAbacos Int - Cdigo no KPL do tipo
CodigoTipo String 50 Tipo cdigo
NomeTipo String 100 Tipo nome
CodigoExternoCategoriaProduto String 50 Cdigo externo do produto
CodigoExternoCategoriaProdutoPai String 50 Cdigo externo categoria do produto pai
www.kpl.com.br Pgina 32 de 186
Verso: 2.0 KPL ENTERPRISE

2.4.5 XML de exemplo

1) Criao de um novo tipo de categoria.

Menu: Comercial e Faturamento -> Cadastros -> Produtos -> Classificaes -> Tipos de categorias do site

2) Habilitao na interface do novo tipo de categoria para integrao.

Menu: Integrao -> Replicao de dados -> Configurao de interfaces

www.kpl.com.br Pgina 33 de 186

Verso: 2.0 KPL ENTERPRISE

3) Alterao nas categorias do site.

Menu: Comercial e Faturamento -> Cadastros -> Produtos -> Classificaes -> Categoria do site

4) Retorno do mtodo com a categoria alterada.

<Classificacao>1</Classificacao>
<OrdemSequencial>2847</OrdemSequencial>
<CodigoTipoAbacos>5</CodigoTipoAbacos>
<CodigoTipo>IN</CodigoTipo>
<NomeTipo>Integracao</NomeTipo>
<CodigoExternoCategoriaProduto/>
<CodigoExternoCategoriaProdutoPai/>
</DadosCategoriasProduto>
</Rows>
</CategoriasProdutoDisponiveisResult>
</CategoriasProdutoDisponiveisResponse>
</soap:Body>
</soap:Envelope>

2.4.6 Regras de negcio

Uma vez que o registro fica disponvel para integrao, necessrio informar que o mesmo foi recebido
e integrado corretamente para que no fique mais disponvel na fila de integrao. A confirmao de
recebimento e integrao, deve ser feita atravs do mtodo 2.11
ConfirmarRecebimentoCategoriaProduto

2.4.7 Perguntas frequentes

2.4.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 35 de 186

Verso: 2.0 KPL ENTERPRISE

2.5 ClassesDisponiveis

2.5.1 Conceito

O mtodo ClassesDisponiveis foi desenvolvido para disponibilizar as classes de produtos disponveis para
integrao.

2.5.2 Objetivo

Atravs desse mtodo possvel obter as informaes de classes de produtos que esto disponveis para
integrao.

2.5.3 Pr-requisitos

A informao se torna disponvel para integrao quando ocorre uma incluso, alterao ou excluso de
alguma informao.

Ativar replicao de sada

Deve ser habilitada na interface a replicao de sada das classes.

www.kpl.com.br Pgina 36 de 186

Verso: 2.0 KPL ENTERPRISE

2.5.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ChaveIdentificacao String 36 Identificao nica da interface

LAYOUT RESPONSE
Campo Tipo Max Descrio
ClassesDisponiveisResult
VersaoWebService String Verso do WebService
ResultadoOperacao
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro
Rows
DadosClassesProdutos
ProtocoloClasse String 255 Protocolo da classe
Acao Int - Valores disponveis: 1.3 enumAcao
Nome Char 50 Nome
CodigoExternoClasse String 50 Cdigo externo da classe
CodigoClasse Int - Cdigo interno da classe

2.5.6 XML de exemplo

1) Criao de uma nova classe.

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

2) Retorno do mtodo com a (s) classe (s) alterada.

<soapenv:Body>
<abac:ClassesDisponiveis>

<abac:ChaveIdentificacao>A8CBDC81-11A7-4A65-9993-38028E20D5AA</abac:ChaveIdentificacao>
</abac:ClassesDisponiveis>
</soapenv:Body>
</soapenv:Envelope>

2.5.7 Regras de negcio

2.5.8 Perguntas frequentes

2.5.9 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 38 de 186

Verso: 2.0 KPL ENTERPRISE

2.6 ConfirmarCategoriaSiteAtualizarCodigo

2.6.1 Conceito

O mtodo ConfirmarCategoriaSiteAtualizarCodigo foi desenvolvido para permitir informar que a categoria

junto com a categoria do parceiro foi recebida e integrada corretamente.

2.6.2 Objetivo

Uma vez que a categoria ficou disponvel para integrao, ela se torna um item de uma lista at que seja
retirada da mesma. Para retir-lo da lista necessrio informar que a sua integrao foi bem sucedida. Caso
a confirmao no ocorra o registro ir permanecer na lista.

2.6.3 Pr-requisitos

O protocolo de integrao da categoria e o cdigo da categoria do parceiro tem que existir na base de dados
de integrao.

2.6.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ConfirmarCategoriaSiteAtualizarCodigo
ProtocoloCategoria String 255 Protocolo categoria
CodigoCategoriaParceiro String 50 Cdigo da categoria no site

LAYOUT RESPONSE
Campo Tipo Max Descrio
ConfirmarCategoriaSiteAtualizarCodigoResult
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo Enum - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro

2.6.5 XML de exemplo

1) Execuo do mtodo para confirmao de recebimento e integrao da categoria.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:abac="http://www.kplsolucoes.com.br/ABACOSWebService">
<soapenv:Header/>
<soapenv:Body>
<abac:ConfirmarCategoriaSiteAtualizarCodigo>

<abac:ProtocoloCategoria>A65BB350-4EA8-4B1B-9E70-
A25DA8684F68</abac:ProtocoloCategoria>

<abac:CodigoCategoriaParceiro>3169</abac:CodigoCategoriaParceiro>
</abac:ConfirmarCategoriaSiteAtualizarCodigo>
</soapenv:Body>
</soapenv:Envelope>

2) Confirmao de recebimento e integrao da categoria.

www.kpl.com.br Pgina 39 de 186

Verso: 2.0 KPL ENTERPRISE

3) Aps a execuo, a categoria no fica mais disponvel para integrao.

<soap:Body>
<CategoriasProdutoDisponiveisResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebService">
<CategoriasProdutoDisponiveisResult>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porm no h dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
</CategoriasProdutoDisponiveisResult>
</CategoriasProdutoDisponiveisResponse>
</soap:Body>

2.6.6 Regras de negcio

2.6.7 Perguntas frequentes

2.6.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 40 de 186

Verso: 2.0 KPL ENTERPRISE

2.7 ConfirmarRecebimentoPrecoLote

2.7.1 Conceito

O mtodo ConfirmarRecebimentoPrecoLote foi desenvolvido para permitir informar que uma lista de preos
foi recebida e integrada corretamente.

2.7.2 Objetivo

Uma vez que o preo ficou disponvel para integrao, ele se torna um item de uma lista at que seja
retirado da mesma. Para retir-lo da lista necessrio informar que a sua integrao foi bem sucedida. Caso
a confirmao no ocorra o registro ir permanecer na lista.

2.7.3 Pr-requisitos

O protocolo de integrao do preo tem que existir na base de dados de integrao.

2.7.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ConfirmaRecebimentoPrecoLote
ChaveIdentificacao String 36 Identificao nica da interface
ListaDePrecoRows
ListaDePreco
ProtocoloPreco String 100 Protocolo do preo

LAYOUT RESPONSE
Campo Tipo Max Descrio
ConfirmarRecebimentoPrecoResult
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo Enum - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro

2.7.5 XML de exemplo

1) Execuo do mtodo para confirmao de recebimento e integrao de uma lista de preo.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:abac="http://www.kplsolucoes.com.br/ABACOSWebService">
<soapenv:Header/>
<soapenv:Body>
<abac:ConfirmaRecebimentoPrecoLote>
<abac:ListaDePrecoRows>
<abac:ListaDePreco>
<abac:ProtocoloPreco>F4A96D2A-640C-4CF4-B25A-
23AB6686DED2</abac:ProtocoloPreco>
<abac:ProtocoloPreco>6EF84037-A952-424C-97AD-
C61865743658</abac:ProtocoloPreco>
</abac:ListaDePreco>
</abac:ListaDePrecoRows>
</abac:ConfirmaRecebimentoPrecoLote>
</soapenv:Body>
</soapenv:Envelope>

www.kpl.com.br Pgina 41 de 186

Verso: 2.0 KPL ENTERPRISE

2) Retorno do mtodo de confirmao de recebimento e integrao de uma lista de preo.

2.7.6 Regras de negcio

Pode ser enviada uma lista de protocolos para confirmao de preo de uma nica vez.

2.7.7 Perguntas frequentes

2.7.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 42 de 186

Verso: 2.0 KPL ENTERPRISE

2.8 ConfirmarRecebimentoProdutoLote

2.8.1 Conceito

O mtodo ConfirmarRecebimentoProdutoLote foi desenvolvido para permitir informar uma lista de

produtos que foram recebidos e integrados corretamente.

2.8.2 Objetivo

Uma vez que o produto ficou disponvel para integrao, ele se torna um item de uma lista at que seja
retirado da mesma. Para retir-lo da lista necessrio informar que a sua integrao foi bem sucedida. Caso
a confirmao no ocorra o registro ir permanecer na lista.

2.8.3 Pr-requisitos

O protocolo de integrao do pedido tem que existir na base de dados de integrao.

2.8.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ConfirmaRecebimentoProdutoLote
ChaveIdentificacao String 100 Identificao nica da interface
ListaDeNumerosDeProtocoloRows
ListaDeNumerosDeProtocolo
ProtocoloProduto String 100 Protocolo do produto

LAYOUT RESPONSE
Campo Tipo Max Descrio
ConfirmarRecebimentoProdutoResult
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo Enum - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro

2.8.5 XML de exemplo

1) Execuo do mtodo para confirmao de recebimento e integrao do produto.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:abac="http://www.kplsolucoes.com.br/ABACOSWebService">
<soapenv:Header/>
<soapenv:Body>
<abac:ConfirmaRecebimentoProdutoLote>
<abac:ListaDeNumerosDeProtocoloRows>
<abac:ListaDeNumerosDeProtocolo>
<abac:ProtocoloProduto>D0548534-80FA-4FC1-B881-
AE56F1DD0C56</abac:ProtocoloProduto>
<abac:ProtocoloProduto>5947F93A-A59C-400C-9532-
160C09F5AA99</abac:ProtocoloProduto>
</abac:ListaDeNumerosDeProtocolo>
</abac:ListaDeNumerosDeProtocoloRows>
</abac:ConfirmaRecebimentoProdutoLote>
</soapenv:Body>
</soapenv:Envelope>
www.kpl.com.br Pgina 43 de 186
Verso: 2.0 KPL ENTERPRISE

2) Retorno do mtodo de confirmao de recebimento e integrao do produto.

3) Aps a execuo do mtodo, o status do produto no fica mais disponvel para integrao.

2.8.6 Regras de negcio

2.8.7 Perguntas frequentes

2.8.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 44 de 186

Verso: 2.0 KPL ENTERPRISE

2.9 ConfirmarPagamentos

2.9.1 Conceito

O mtodo ConfirmarPagamentos foi desenvolvido para permitir baixar o pagamento do pedido de venda no
KPL.

2.9.2 Objetivo

Este mtodo deve ser utilizado para confirmar o pagamento de pedidos, em situaes em que integrado
da plataforma com o status aguardando confirmao do pagamento, e posteriormente confirma-se o
pagamento do mesmo. Caso o pedido tenha mais de uma forma de pagamento, esse mtodo permite
confirmar cada forma de pagamento em momentos separados.

2.9.3 Pr-requisitos

O pedido tem que existir na base de dados e estar no estgio de aguardando confirmao do pagamento.

2.9.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ConfirmarPagamentos
ChaveIdentificacao String 36 Identificao nica da interface
ListaDePagamentos
DadosConfirmarPagamentos
CodigoPedido String 50 Nmero do pedido
CodigoPagamento String 50 Cdigo do pagamento
DataPagamento String 21 Data do pagamento
CartaoCodigoAutorizacao String 50 Cdigo autorizao carto
CartaoNSU String 50 Carto NSU
CartaoTID String 50 Carto TID
StatusPagamento String - Valores disponveis: 1.8 enumStatusPagamento

LAYOUT RESPONSE
Campo Tipo Max Descrio
ConfirmarPagamentosPedidosResult
VersaoWebService String Verso do WebService
ResultadoOperacao
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
Rows
DadosPgtoPedidoResultado
NumeroPedido String 50 Nmero do pedido
Resultado
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro

www.kpl.com.br Pgina 45 de 186

Verso: 2.0 KPL ENTERPRISE

2.9.5 XML de exemplo

1) Execuo do mtodo de confirmao de pagamento do pedido de venda.

2) Retorno do mtodo de confirmao de pagamento do pedido de venda.

www.kpl.com.br Pgina 46 de 186

Verso: 2.0 KPL ENTERPRISE

3) Consulta do pedido no KPL.

2.9.6 Regras de negcio

2.9.7 Perguntas frequentes

2.9.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 47 de 186

Verso: 2.0 KPL ENTERPRISE

2.10 ConfirmarPagamentosPedidos

2.10.1 Conceito

O mtodo ConfirmarPagamentosPedidos foi desenvolvido para permitir baixar o pagamento do pedido no

KPL.

2.10.2 Objetivo

2.10.3 Pr-requisitos

O pedido tem que existir na base de dados e estar no estgio de aguardando confirmao do pagamento.

2.10.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ConfirmarPagamentosPedidos
ChaveIdentificacao String 36 Identificao nica da interface
ListaDePagamentos
DadosPgtoPedido
NumeroPedido String 50 Nmero do pedido
DataPagamento String 21 Data do pagamento
CartaoCodigoAutorizacao String 50 Cdigo autorizao carto
CartaoNSU String 50 Carto NSU
CartaoTID String 50 Carto TID
CartaoCodigoRetorno String 15 Cdigo de retorno do carto
CartaoMensagemRetorno String 255 Cdigo de retorno do carto
StatusPagamento String - Valores disponveis: 1.8 enumStatusPagamento

www.kpl.com.br Pgina 48 de 186

Verso: 2.0 KPL ENTERPRISE

2.10.5 XML de exemplo

1) Criao do pedido no KPL, com o status AGUARDANDO CONFIRMAO DO PAGAMENTO.

(2) Foi executado o mtodo de confirmao de pagamento, que ficou logado no histrico do pedido e o
status do pedido evoluiu para AGUARDANDO SEPARAO DE MERCADORIAS.

<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operao "Liberar o pagamento do pedido" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosPgtoPedidoResultado>
<NumeroPedido>ME5582</NumeroPedido>
<Resultado>
<Codigo>200002</Codigo>
<Descricao>OK.</Descricao>
<Tipo>tdreSucesso</Tipo>
</Resultado>
</DadosPgtoPedidoResultado>
</Rows>
</ConfirmarPagamentosPedidosResult>
</ConfirmarPagamentosPedidosResponse>
</soap:Body>
</soap:Envelope>

2) Tela do KPL com o histrico de pagamento confirmado.

2.10.6 Regras de negcio

Podem ser enviada uma lista de protocolos de pagamentos de pedidos de uma nica vez.

2.10.7 Perguntas frequentes

2.10.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 50 de 186

Verso: 2.0 KPL ENTERPRISE

2.11 ConfirmarProdutoAtualizarCodigo

2.11.1 Conceito

O mtodo ConfirmarProdutoAtualizarCodigo foi desenvolvido para permitir informar que o produto junto
com o cdigo do produto parceiro foi recebido e integrado corretamente.

2.11.2 Objetivo

2.11.3 Pr-requisitos

O protocolo de integrao do produto e o cdigo do produto parceiro tem que existir na base de dados de
integrao.

2.11.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ConfirmarProdutoAtualizarCodigo
ProtocoloProduto String 255 Protocolo produto
CodigoProdutoParceiro String 50 Cdigo do produto no parceiro

LAYOUT RESPONSE
Campo Tipo Max Descrio
ConfirmarProdutoAtualizarCodigoResult
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo Enum - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro

2.11.5 XML de exemplo

1) Execuo do mtodo para confirmao de recebimento e integrao do produto.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:abac="http://www.kplsolucoes.com.br/ABACOSWebService">
<soapenv:Header/>
<soapenv:Body>
<abac:ConfirmarProdutoAtualizarCodigo>
<abac:ProtocoloProduto>D0548534-80FA-4FC1-B881-
AE56F1DD0C56</abac:ProtocoloProduto>
<abac:CodigoProdutoParceiro>MULTIBARRAS012</abac:CodigoProdutoParceiro>
</abac:ConfirmarProdutoAtualizarCodigo>
</soapenv:Body>
</soapenv:Envelope>

2) Confirmao de recebimento e integrao do produto.

<ConfirmarProdutoAtualizarCodigoResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebService">
<ConfirmarProdutoAtualizarCodigoResult>
<Codigo>200001</Codigo>
<Descricao>Operao "Atualizar cdigo do produto no parceiro e confirmar
recebimento do produto" efetuada com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ConfirmarProdutoAtualizarCodigoResult>
</ConfirmarProdutoAtualizarCodigoResponse>
</soap:Body>
</soap:Envelope>

3) Aps a execuo, o produto no fica mais disponvel para integrao.

2.11.6 Regras de negcio

2.11.7 Perguntas frequentes

2.11.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 52 de 186

Verso: 2.0 KPL ENTERPRISE

2.12 ConfirmarRecebimentoCategoriaProduto

2.12.1 Conceito

O mtodo ConfirmarRecebimentoCategoriaProduto foi desenvolvido para permitir informar que a famlia foi
recebida e integrada corretamente.

2.12.2 Objetivo

Uma vez que a categoria ficou disponvel para integrao, ela se torna um item de uma lista at que seja
retirada da mesma. Para retir-la da lista necessrio informar que a sua integrao foi bem sucedida. Caso
a confirmao no ocorra o registro ir permanecer na lista.

2.12.3 Pr-requisitos

O protocolo de integrao da categoria tem que existir na base de dados de integrao.

2.12.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ConfirmarRecebimentoCategoriaProduto
ProtocoloCategoriaProduto String 255 Protocolo da categoria de produto

2.12.5 XML de exemplo

1) Execuo do mtodo para confirmao de recebimento e integrao da categoria.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:abac="http://www.kplsolucoes.com.br/ABACOSWebService">
<soapenv:Header/>
<soapenv:Body>
<abac:ConfirmarRecebimentoCategoriaProduto>

<abac:ProtocoloCategoriaProduto>76876CB8-4F1E-4B93-8C95-
97193B6B4FAD</abac:ProtocoloCategoriaProduto>
</abac:ConfirmarRecebimentoCategoriaProduto>
</soapenv:Body>
</soapenv:Envelope>

2) Confirmao de recebimento e integrao da categoria.

<Codigo>200001</Codigo>
<Descricao>Operao "Confirmao da incluso da categoria" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ConfirmarRecebimentoCategoriaProdutoResult>
</ConfirmarRecebimentoCategoriaProdutoResponse>
</soap:Body>
</soap:Envelope>

3) Aps a execuo, a categoria no fica mais disponvel para integrao.

2.11.6 Regras de negcio

S pode ser realizada a confirmao de um registro por vez.

2.12.7 Perguntas frequentes

2.12.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 54 de 186

Verso: 2.0 KPL ENTERPRISE

2.13 ConfirmarRecebimentoClasse

2.13.1 Conceito

O mtodo ConfirmarRecebimentoClasse foi desenvolvido para permitir informar que a classe foi recebida e
integrada corretamente.

2.13.2 Objetivo

Uma vez que a classe ficou disponvel para integrao, ela se torna um item de uma lista at que seja
retirado da mesma. Para retir-lo da lista necessrio informar que a sua integrao foi bem sucedida. Caso
a confirmao no ocorra o registro ir permanecer na lista.

2.13.3 Pr-requisitos

O protocolo de integrao da classe tem que existir na base de dados de integrao.

2.13.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ConfirmarRecebimentoClasse
ProtocoloClasse String 255 Protocolo da classe

LAYOUT RESPONSE
Campo Tipo Max Descrio
ConfirmarRecebimentoClasseResult
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo Enum - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro

2.13.5 XML de exemplo

1) Execuo do mtodo para confirmao de recebimento e integrao da classe.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:abac="http://www.kplsolucoes.com.br/ABACOSWebService">
<soapenv:Header/>
<soapenv:Body>
<abac:ConfirmarRecebimentoClasse>

<abac:ProtocoloClasse>E714DD01-0E99-40AE-AF7E-
88E62DE60242</abac:ProtocoloClasse>
</abac:ConfirmarRecebimentoClasse>
</soapenv:Body>
</soapenv:Envelope>

2) Retorno do mtodo de confirmao de recebimento e integrao da classe.

www.kpl.com.br Pgina 55 de 186

Verso: 2.0 KPL ENTERPRISE

xmlns="http://www.kplsolucoes.com.br/ABACOSWebService">
<ConfirmarRecebimentoClasseResult>
<Codigo>200001</Codigo>
<Descricao>Operao "Confirmar a incluso da classe de produto" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ConfirmarRecebimentoClasseResult>
</ConfirmarRecebimentoClasseResponse>
</soap:Body>
</soap:Envelope>

3) Aps a execuo, a classe no fica mais disponvel para integrao.

2.13.6 Regras de negcio

2.13.7 Perguntas frequentes

2.13.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 56 de 186

Verso: 2.0 KPL ENTERPRISE

2.14 ConfirmarRecebimentoDescritorPreDefinido

2.14.1 Conceito

O mtodo ConfirmarRecebimentoDescritorPreDefinido foi desenvolvido para permitir informar que o

descritor foi recebido e integrado corretamente.

2.14.2 Objetivo

Uma vez que o descritor pr-definido ficou disponvel para integrao, ele se torna um item de uma lista at
que seja retirado da mesma. Para retir-lo da lista necessrio informar que a sua integrao foi bem
sucedida. Caso a confirmao no ocorra o registro ir permanecer na lista.

2.14.3 Pr-requisitos

O protocolo de integrao do descritor pr-definido tem que existir na base de dados de integrao.

2.14.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ConfirmarRecebimentoCategoriaProduto
ProtocoloDescritorPreDefinido String 255 Protocolo do descritor pr-definido

LAYOUT RESPONSE
Campo Tipo Max Descrio
ConfirmarRecebimentoDescritorPreDefinidoResult
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo Enum - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro

2.14.5 XML de exemplo

1) Execuo do mtodo para confirmao de recebimento e integrao do descritor pr-definido.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:abac="http://www.kplsolucoes.com.br/ABACOSWebService">
<soapenv:Header/>
<soapenv:Body>
<abac:ConfirmarRecebimentoDescritorPreDefinido>

<abac:ProtocoloDescritorPreDefinido>8E9C9319-4582-48CA-86FB-
68FF2C4A9D6B</abac:ProtocoloDescritorPreDefinido>
</abac:ConfirmarRecebimentoDescritorPreDefinido>
</soapenv:Body>
</soapenv:Envelope>

2) Confirmao de recebimento e integrao do descritor pr-definido.

www.kpl.com.br Pgina 57 de 186

Verso: 2.0 KPL ENTERPRISE

<ConfirmarRecebimentoDescritorPreDefinidoResult>
<Codigo>200001</Codigo>
<Descricao>Operao "Confirmar a incluso de descritores pr-definidos do
produto" efetuada com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ConfirmarRecebimentoDescritorPreDefinidoResult>
</ConfirmarRecebimentoDescritorPreDefinidoResponse>
</soap:Body>
</soap:Envelope>

3) Aps a execuo, a categoria no fica mais disponvel para integrao.

2.14.6 Regras de negcio

S pode ser realizada a confirmao de um registro por vez.

2.14.7 Perguntas frequentes

2.14.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 58 de 186

Verso: 2.0 KPL ENTERPRISE

2.15 ConfirmarRecebimentoEstoque

2.15.1 Conceito

O mtodo ConfirmarRecebimentoEstoque foi desenvolvido para permitir informar que o saldo de estoque
foi recebido e integrado corretamente.

2.15.2 Objetivo

Uma vez que o saldo de estoque ficou disponvel para integrao, ele se torna um item de uma lista at que
seja retirada da mesma. Para retir-la da lista necessrio informar que a sua integrao foi bem sucedida.
Caso a confirmao no ocorra o registro ir permanecer na lista.

2.15.3 Pr-requisitos

O protocolo de integrao do saldo de estoque tem que existir na base de dados de integrao.

2.15.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ConfirmarRecebimentoEstoque
ProtocoloEstoque String 255 Protocolo do saldo de estoque do produto

LAYOUT RESPONSE
Campo Tipo Max Descrio
EstoquesDisponiveisResult
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo Enum - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro

2.15.5 XML de exemplo

1) Execuo do mtodo para confirmao de recebimento e integrao do saldo de estoque.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:abac="http://www.kplsolucoes.com.br/ABACOSWebService">
<soapenv:Header/>
<soapenv:Body>
<abac:ConfirmarRecebimentoEstoque>

<abac:ProtocoloEstoque>be488aee-db7d-48c2-a5a8-
9c028c260f70</abac:ProtocoloEstoque>
</abac:ConfirmarRecebimentoEstoque>
</soapenv:Body>
</soapenv:Envelope>

2) Confirmao de recebimento e integrao do saldo de estoque.

<Codigo>200001</Codigo>
<Descricao>Operao "Confirmao da incluso dos dados de estoque" efetuada
com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ConfirmarRecebimentoEstoqueResult>
</ConfirmarRecebimentoEstoqueResponse>
</soap:Body>
</soap:Envelope>

3) Aps a execuo, o saldo do estoque no fica mais disponvel para integrao.

2.15.6 Regras de negcio

S pode ser realizada a confirmao de um registro por vez.

2.15.7 Perguntas frequentes

2.15.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 60 de 186

Verso: 2.0 KPL ENTERPRISE

2.16 ConfirmarRecebimentoFamilia

2.16.1 Conceito

O mtodo ConfirmarRecebimentoFamilia foi desenvolvido para permitir informar que a famlia foi recebida
e integrada corretamente.

2.16.2 Objetivo

Uma vez que a famlia ficou disponvel para integrao, ela se torna um item de uma lista at que seja
retirada da mesma. Para retir-la da lista necessrio informar que a sua integrao foi bem sucedida. Caso
a confirmao no ocorra o registro ir permanecer na lista.

2.16.3 Pr-requisitos

O protocolo de integrao da famlia tem que existir na base de dados de integrao.

2.16.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ConfirmarRecebimentoFamilia
ProtocoloFamilia String 255 Protocolo da famlia

LAYOUT RESPONSE
Campo Tipo Max Descrio
ConfirmarRecebimentoFamiliaResult
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo Enum - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro

2.16.5 XML de exemplo

1) Execuo do mtodo para confirmao de recebimento e integrao da famlia.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:abac="http://www.kplsolucoes.com.br/ABACOSWebService">
<soapenv:Header/>
<soapenv:Body>
<abac:ConfirmarRecebimentoFamilia>

<abac:ProtocoloFamilia>2490B71B-7A98-427D-B70B-
57EE76D27A17</abac:ProtocoloFamilia>
</abac:ConfirmarRecebimentoFamilia>
</soapenv:Body>
</soapenv:Envelope>

2) Retorno do mtodo de confirmao de recebimento e integrao da famlia.

www.kpl.com.br Pgina 61 de 186

Verso: 2.0 KPL ENTERPRISE

<ConfirmarRecebimentoFamiliaResult>
<Codigo>200001</Codigo>
<Descricao>Operao "Confirmar a incluso da familia de produto" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ConfirmarRecebimentoFamiliaResult>
</ConfirmarRecebimentoFamiliaResponse>
</soap:Body>
</soap:Envelope>

3) Aps a execuo, a famlia no fica mais disponvel para integrao.

2.16.6 Regras de negcio

2.16.7 Perguntas frequentes

2.16.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 62 de 186

Verso: 2.0 KPL ENTERPRISE

2.17 ConfirmarRecebimentoGrupoProduto

2.17.1 Conceito

O mtodo ConfirmarRecebimentoGrupoProduto foi desenvolvido para permitir informar que o grupo foi
recebido e integrado corretamente.

2.17.2 Objetivo

Uma vez que o grupo ficou disponvel para integrao, ele se torna um item de uma lista at que seja
retirado da mesma. Para retir-la da lista necessrio informar que a sua integrao foi bem sucedida. Caso
a confirmao no ocorra o registro ir permanecer na lista.

2.17.3 Pr-requisitos

O protocolo de integrao do grupo tem que existir na base de dados de integrao.

2.17.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ConfirmarRecebimentoGrupoProduto
ProtocoloGrupoProduto String 255 Protocolo grupo do produto

LAYOUT RESPONSE
Campo Tipo Max Descrio
ConfirmarRecebimentoGrupoProdutoResult
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo Enum - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro

2.17.5 XML de exemplo

1) Execuo do mtodo para confirmao de recebimento e integrao do grupo.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:abac="http://www.kplsolucoes.com.br/ABACOSWebService">
<soapenv:Header/>
<soapenv:Body>
<abac:ConfirmarRecebimentoGrupoProduto>

<abac:ProtocoloGrupoProduto>132C4D90-C8B4-4D46-A4D7-
B630B72DB1E2</abac:ProtocoloGrupoProduto>
</abac:ConfirmarRecebimentoGrupoProduto>
</soapenv:Body>
</soapenv:Envelope>

2) Retorno do mtodo de confirmao de recebimento e integrao do grupo.

www.kpl.com.br Pgina 63 de 186

Verso: 2.0 KPL ENTERPRISE

xmlns="http://www.kplsolucoes.com.br/ABACOSWebService">
<ConfirmarRecebimentoGrupoProdutoResult>
<Codigo>200001</Codigo>
<Descricao>Operao "Confirmar a incluso do grupo de produto" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ConfirmarRecebimentoGrupoProdutoResult>
</ConfirmarRecebimentoGrupoProdutoResponse>
</soap:Body>
</soap:Envelope>

3) Aps a execuo do mtodo de confirmao, o grupo no fica mais disponvel para integrao.

<soap:Body>
<GrupoProdutosDisponiveisResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebService">
<GrupoProdutosDisponiveisResult>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porm no h dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
</GrupoProdutosDisponiveisResult>
</GrupoProdutosDisponiveisResponse>
</soap:Body>

2.17.6 Regras de negcio

2.17.7 Perguntas frequentes

2.17.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 64 de 186

Verso: 2.0 KPL ENTERPRISE

2.18 ConfirmarRecebimentoListaPresente

2.18.1 Conceito

O mtodo ConfirmarRecebimentoListaPresente foi desenvolvido para permitir informar que a lista de

presente foi recebida e integrada corretamente.

2.18.2 Objetivo

Uma vez que a lista de presente ficou disponvel para integrao, ela se torna um item de uma lista at que
seja retirado da mesma. Para retir-lo da lista necessrio informar que a sua integrao foi bem sucedida.
Caso a confirmao no ocorra o registro ir permanecer na lista.

2.18.3 Pr-requisitos

O protocolo de integrao da lista de presente tem que existir na base de dados de integrao.

2.18.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ConfirmarRecebimentoListaPresente
ProtocoloListaPresente String 255 Protocolo da lista de presente

LAYOUT RESPONSE
Campo Tipo Max Descrio
ConfirmarRecebimentoListaPresenteResult
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo Enum - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro

2.18.5 XML de exemplo

1) Execuo do mtodo para confirmao de recebimento e integrao da lista de presente.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:abac="http://www.kplsolucoes.com.br/ABACOSWebService">
<soapenv:Header/>
<soapenv:Body>
<abac:ConfirmarRecebimentoListaPresente>

<abac:ProtocoloListaPresente>6B3A7006-D145-424E-A9D6-
7A8D15EA3EEF</abac:ProtocoloListaPresente>
</abac:ConfirmarRecebimentoListaPresente>
</soapenv:Body>
</soapenv:Envelope>

2) Retorno do mtodo de confirmao de recebimento e integrao da lista de presente.

www.kpl.com.br Pgina 65 de 186

Verso: 2.0 KPL ENTERPRISE

xmlns="http://www.kplsolucoes.com.br/ABACOSWebService">
<ConfirmarRecebimentoListaPresenteResult>
<Codigo>200001</Codigo>
<Descricao>Operao "Confirmar recebimento lista de presente" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ConfirmarRecebimentoListaPresenteResult>
</ConfirmarRecebimentoListaPresenteResponse>
</soap:Body>
</soap:Envelope>

3) Aps a execuo do mtodo de confirmao, a lista de presente no fica mais disponvel para
integrao.
<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>
<ListaPresenteDisponiveisResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebService">
<ListaPresenteDisponiveisResult>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porm no h dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
</ListaPresenteDisponiveisResult>
</ListaPresenteDisponiveisResponse>
</soap:Body>
</soap:Envelope>

2.18.6 Regras de negcio

2.18.7 Perguntas frequentes

2.18.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 66 de 186

Verso: 2.0 KPL ENTERPRISE

2.19 ConfirmarRecebimentoMarca

2.19.1 Conceito

O mtodo ConfirmarRecebimentoMarca foi desenvolvido para permitir informar que o subgrupo foi
recebido e integrado corretamente.

2.19.2 Objetivo

Uma vez que a marca ficou disponvel para integrao, ela se torna um item de uma lista at que seja
retirado da mesma. Para retir-lo da lista necessrio informar que a sua integrao foi bem sucedida. Caso
a confirmao no ocorra o registro ir permanecer na lista.

2.19.3 Pr-requisitos

O protocolo de integrao da marca tem que existir na base de dados de integrao.

2.19.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ConfirmarRecebimentoMarca
ProtocoloMarca String 255 Protocolo do grupo produto

LAYOUT RESPONSE
Campo Tipo Max Descrio
ConfirmarRecebimentoMarcaResult
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo Enum - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro

2.19.5 XML de exemplo

1) Execuo do mtodo para confirmao de recebimento e integrao da marca.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:abac="http://www.kplsolucoes.com.br/ABACOSWebService">
<soapenv:Header/>
<soapenv:Body>
<abac:ConfirmarRecebimentoMarca>

<abac:ProtocoloMarca>B11710D3-0FBC-4751-B382-BA933483BACA</abac:ProtocoloMarca>
</abac:ConfirmarRecebimentoMarca>
</soapenv:Body>
</soapenv:Envelope>

2) Retorno do mtodo de confirmao de recebimento e integrao da marca.

www.kpl.com.br Pgina 67 de 186

Verso: 2.0 KPL ENTERPRISE

<ConfirmarRecebimentoMarcaResult>
<Codigo>200001</Codigo>
<Descricao>Operao "Confirmao da incluso de marcas" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ConfirmarRecebimentoMarcaResult>
</ConfirmarRecebimentoMarcaResponse>
</soap:Body>
</soap:Envelope>

3) Aps a execuo do mtodo de confirmao, a marca no fica mais disponvel para integrao.
<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>
<MarcasDisponiveisResponse xmlns="http://www.kplsolucoes.com.br/ABACOSWebService">
<MarcasDisponiveisResult>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porm no h dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
</MarcasDisponiveisResult>
</MarcasDisponiveisResponse>
</soap:Body>
</soap:Envelope>

2.19.6 Regras de negcio

2.19.7 Perguntas frequentes

2.19.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 68 de 186

Verso: 2.0 KPL ENTERPRISE

2.20 ConfirmarRecebimentoPedido

2.20.1 Conceito

O mtodo ConfirmarRecebimentoPedido foi desenvolvido para permitir informar que o pedido foi recebido
e integrado corretamente.

2.20.2 Objetivo

Uma vez que o pedido ficou disponvel para integrao, ele se torna um item de uma lista at que seja
retirado da mesma. Para retir-lo da lista necessrio informar que a sua integrao foi bem sucedida. Caso
a confirmao no ocorra o registro ir permanecer na lista.

2.20.3 Pr-requisitos

O protocolo de integrao do preo tem que existir na base de dados de integrao.

2.20.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ConfirmarRecebimentoPedido
ProtocoloPedido String 255 Protocolo do pedido

LAYOUT RESPONSE
Campo Tipo Max Descrio
ConfirmarRecebimentoPedidoResult
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo Enum - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro

2.20.5 XML de exemplo

1) Execuo do mtodo para confirmao de recebimento e integrao do pedido.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:abac="http://www.kplsolucoes.com.br/ABACOSWebService">
<soapenv:Header/>
<soapenv:Body>
<abac:ConfirmarRecebimentoPedido>

<abac:ProtocoloPedido>B8E0FE10-7257-4C11-A4DB-
8515ED883154</abac:ProtocoloPedido>
</abac:ConfirmarRecebimentoPedido>
</soapenv:Body>
</soapenv:Envelope>

3) Retorno do mtodo de confirmao de recebimento e integrao do pedido.

www.kpl.com.br Pgina 69 de 186

Verso: 2.0 KPL ENTERPRISE

xmlns="http://www.kplsolucoes.com.br/ABACOSWebService">
<ConfirmarRecebimentoPedidoResult>
<Codigo>200001</Codigo>
<Descricao>Operao "Confirmar recebimento pedido" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ConfirmarRecebimentoPedidoResult>
</ConfirmarRecebimentoPedidoResponse>
</soap:Body>
</soap:Envelope>

4) Aps a execuo do mtodo, o pedido no fica mais disponvel para integrao.

2.20.7 Regras de negcio

2.20.8 Perguntas frequentes

2.20.9 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 70 de 186

Verso: 2.0 KPL ENTERPRISE

2.21 ConfirmarRecebimentoPreco

2.21.1 Conceito

O mtodo ConfirmarRecebimentoPreco foi desenvolvido para permitir informar que o preo foi recebido e
integrado corretamente.

2.21.2 Objetivo

2.21.3 Pr-requisitos

O protocolo de integrao do preo tem que existir na base de dados de integrao.

2.21.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ConfirmarRecebimentoPreco
ProtocoloPreco String 255 Protocolo preo

2.21.5 XML de exemplo

1) Execuo do mtodo para confirmao de recebimento e integrao do preo.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:abac="http://www.kplsolucoes.com.br/ABACOSWebService">
<soapenv:Header/>
<soapenv:Body>
<abac:ConfirmarRecebimentoPreco>

<abac:ProtocoloPreco>A8CBDC81-11A7-4A65-9993-38028E20D5AA</abac:ProtocoloPreco>
</abac:ConfirmarRecebimentoPreco>
</soapenv:Body>
</soapenv:Envelope>

2) Retorno do mtodo de confirmao de recebimento e integrao do preo.

www.kpl.com.br Pgina 71 de 186

Verso: 2.0 KPL ENTERPRISE

<ConfirmarRecebimentoPrecoResult>
<Codigo>200001</Codigo>
<Descricao>Operao "Confirmao da incluso dos dados de preos" efetuada
com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ConfirmarRecebimentoPrecoResult>
</ConfirmarRecebimentoPrecoResponse>
</soap:Body>
</soap:Envelope>

3) Aps a execuo do mtodo, o preo no fica mais disponvel para integrao.

2.21.6 Regras de negcio

2.21.7 Perguntas frequentes

2.21.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 72 de 186

Verso: 2.0 KPL ENTERPRISE

2.22 ConfirmarRecebimentoProduto

2.22.1 Conceito

O mtodo ConfirmarRecebimentoProduto foi desenvolvido para permitir informar que o produto foi
recebido e integrado corretamente.

2.22.2 Objetivo

2.22.3 Pr-requisitos

O protocolo de integrao do pedido tem que existir na base de dados de integrao.

2.22.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ConfirmarRecebimentoProduto
ProtocoloProduto String 255 Protocolo do produto

2.22.5 XML de exemplo

1) Execuo do mtodo para confirmao de recebimento e integrao do produto.

2) Retorno do mtodo de confirmao de recebimento e integrao do produto.

www.kpl.com.br Pgina 73 de 186

Verso: 2.0 KPL ENTERPRISE

xmlns="http://www.kplsolucoes.com.br/ABACOSWebService">
<ConfirmarRecebimentoProdutoResult>
<Codigo>200001</Codigo>
<Descricao>Operao "Confirmao da incluso de produtos" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ConfirmarRecebimentoProdutoResult>
</ConfirmarRecebimentoProdutoResponse>
</soap:Body>
</soap:Envelope>

3) Aps a execuo do mtodo, o produto no fica mais disponvel para integrao.

2.22.6 Regras de negcio

2.22.7 Perguntas frequentes

2.22.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 74 de 186

Verso: 2.0 KPL ENTERPRISE

2.23 ConfirmarRecebimentoStatusPedido

2.23.1 Conceito

O mtodo ConfirmarRecebimentoStatusPedido foi desenvolvido para permitir informar que o status do

pedido foi recebido e integrado corretamente.

2.23.2 Objetivo

Uma vez que o status do pedido ficou disponvel para integrao, ele se torna um item de uma lista at que
seja retirado da mesma. Para retir-lo da lista necessrio informar que a sua integrao foi bem sucedida.
Caso a confirmao no ocorra o registro ir permanecer na lista.

2.23.3 Pr-requisitos

O protocolo de integrao do status do pedido tem que existir na base de dados de integrao.

2.23.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ConfirmarRecebimentoStatusPedido
ProtocoloStatusPedido String 255 Confirmao de status pedido

LAYOUT RESPONSE
Campo Tipo Max Descrio
ConfirmarRecebimentoStatusPedidoResult
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo Enum - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro

2.23.5 XML de exemplo

1) Execuo do mtodo para confirmao de recebimento e integrao do status do pedido.

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:abac="http://www.kplsolucoes.com.br/ABACOSWebService">
<soap:Header/>
<soap:Body>
<abac:ConfirmarRecebimentoStatusPedido>

<abac:ProtocoloStatusPedido>197EA1CC-612A-4904-A822-
FC82AF602BF7</abac:ProtocoloStatusPedido>
</abac:ConfirmarRecebimentoStatusPedido>
</soap:Body>
</soap:Envelope>

2) Retorno do mtodo de confirmao de recebimento e integrao do status do pedido.

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<ConfirmarRecebimentoStatusPedidoResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebService">
www.kpl.com.br Pgina 75 de 186
Verso: 2.0 KPL ENTERPRISE

<ConfirmarRecebimentoStatusPedidoResult>
<Codigo>200001</Codigo>
<Descricao>Operao "Status de pedidos" efetuada com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ConfirmarRecebimentoStatusPedidoResult>
</ConfirmarRecebimentoStatusPedidoResponse>
</soap:Body>
</soap:Envelope>

3) Aps a execuo do mtodo, o status do pedido no fica mais disponvel para integrao.
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<StatusPedidoDisponiveisResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebService">
<StatusPedidoDisponiveisResult>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porm no h dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
</StatusPedidoDisponiveisResult>
</StatusPedidoDisponiveisResponse>
</soap:Body>
</soap:Envelope>

2.23.6 Regras de negcio

2.23.7 Perguntas frequentes

2.23.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 76 de 186

Verso: 2.0 KPL ENTERPRISE

2.24 ConfirmarRecebimentoStatusTraking

2.24.1 Conceito

O mtodo ConfirmarRecebimentoStatusTraking foi desenvolvido para permitir informar que o status do

Traking foi recebido e integrado corretamente.

2.24.2 Objetivo

Uma vez que o status Traking ficou disponvel para integrao, ele se torna um item de uma lista at que
seja retirado da mesma. Para retir-lo da lista necessrio informar que a sua integrao foi bem sucedida.
Caso a confirmao no ocorra o registro ir permanecer na lista.

2.24.3 Pr-requisitos

O protocolo de integrao do status do pedido durante o Traking tem que existir na base de dados de
integrao.

2.24.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ConfirmarRecebimentoStatusTraking
ProtocoloStatusTraking String 255 Protocolo do Status Traking

LAYOUT RESPONSE
Campo Tipo Max Descrio
ConfirmarRecebimentoStatusTrakingResult
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo Enum - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro

2.24.5 XML de exemplo

1) Execuo do mtodo para confirmao de recebimento e integrao do status do Traking.

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:abac="http://www.kplsolucoes.com.br/ABACOSWebService">
<soap:Header/>
<soap:Body>
<abac:ConfirmarRecebimentoStatusTraking>

<abac:ProtocoloStatusTraking>6AA48A2F-9838-44DE-A197-
E9A9EE5C2E89</abac:ProtocoloStatusTraking>
</abac:ConfirmarRecebimentoStatusTraking>
</soap:Body>
</soap:Envelope>

2) Retorno do mtodo de confirmao de recebimento e integrao do status do Traking.

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>

www.kpl.com.br Pgina 77 de 186

Verso: 2.0 KPL ENTERPRISE

<ConfirmarRecebimentoStatusTrakingResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebService">
<ConfirmarRecebimentoStatusTrakingResult>
<Codigo>200001</Codigo>
<Descricao>Operao "Confirmar o status do pedido durante o Traking" efetuada
com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ConfirmarRecebimentoStatusTrakingResult>
</ConfirmarRecebimentoStatusTrakingResponse>
</soap:Body>
</soap:Envelope>

3) Aps a execuo do mtodo de confirmao, o status do Traking no fica mais disponvel para
integrao.
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<StatusPedidoTrakingResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebService">
<StatusPedidoTrakingResult>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porm no h dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
<Rows>
<DadosStatusPedidoTraking>
<CodigoPedidoInterno>0</CodigoPedidoInterno>
<CodigoStatusPedido>0</CodigoStatusPedido>
</DadosStatusPedidoTraking>
</Rows>
</StatusPedidoTrakingResult>
</StatusPedidoTrakingResponse>
</soap:Body>
</soap:Envelope>

2.24.6 Regras de negcio

2.24.7 Perguntas frequentes

2.24.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 78 de 186

Verso: 2.0 KPL ENTERPRISE

2.25 ConfirmarRecebimentoSubGrupoProduto

2.25.1 Conceito

O mtodo ConfirmarRecebimentoSubGrupoProduto foi desenvolvido para permitir informar que o subgrupo

foi recebido e integrado corretamente.

2.25.2 Objetivo

Uma vez que o subgrupo ficou disponvel para integrao, ele se torna um item de uma lista at que seja
retirado da mesma. Para retir-lo da lista necessrio informar que a sua integrao foi bem sucedida. Caso
a confirmao no ocorra o registro ir permanecer na lista.

2.25.3 Pr-requisitos

O protocolo de integrao do subgrupo tem que existir na base de dados de integrao.

2.25.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ConfirmarRecebimentoGrupoProduto
ProtocoloGrupoProduto String 255 Protocolo do grupo produto

2.25.5 XML de exemplo

1) Execuo do mtodo para confirmao de recebimento e integrao do subgrupo.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:abac="http://www.kplsolucoes.com.br/ABACOSWebService">
<soapenv:Header/>
<soapenv:Body>
<abac:ConfirmarRecebimentoSubGrupoProduto>

<abac:ProtocoloSubGrupoProduto>55FB6BCF-4878-4ED2-BCF2-
952F3E571B2E</abac:ProtocoloSubGrupoProduto>
</abac:ConfirmarRecebimentoSubGrupoProduto>
</soapenv:Body>
</soapenv:Envelope>

2) Retorno do mtodo de confirmao de recebimento e integrao da subgrupo.

<Codigo>200001</Codigo>
<Descricao>Operao "Confirmar a incluso do sub-grupo de produto" efetuada
com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ConfirmarRecebimentoSubGrupoProdutoResult>
</ConfirmarRecebimentoSubGrupoProdutoResponse>
</soap:Body>
</soap:Envelope>

3) Aps a execuo do mtodo de confirmao, o subgrupo no fica mais disponvel para integrao.
<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>
<SubGrupoProdutosDisponiveisResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebService">
<SubGrupoProdutosDisponiveisResult>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porm no h dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
</SubGrupoProdutosDisponiveisResult>
</SubGrupoProdutosDisponiveisResponse>
</soap:Body>
</soap:Envelope>

2.25.6 Regras de negcio

2.25.7 Perguntas frequentes

2.25.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 80 de 186

Verso: 2.0 KPL ENTERPRISE

2.26 DescritoresPreDefinidosDisponiveis

2.26.1 Conceito

O mtodo DescritoresPreDefinicosDisponiveis foi desenvolvido para disponibilizar os descritores pr-

definidos de produtos disponveis para integrao.

2.26.2 Objetivo

Atravs desse mtodo possvel obter as informaes de descritores pr-definidos de produtos que esto
disponveis para integrao.

2.26.3 Pr-requisitos

A informao se torna disponvel para integrao quando ocorre uma incluso, alterao ou excluso de
alguma informao.

Ativar replicao de sada

Deve ser habilitada na interface a replicao de sada dos descritores pr-definidos.

www.kpl.com.br Pgina 81 de 186

Verso: 2.0 KPL ENTERPRISE

Definir grupos de descritores habilitados

Deve ser definido na interface os grupos habilitados para integrao.

2.26.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ChaveIdentificacao String 36 Identificao nica da interface

LAYOUT RESPONSE
Campo Tipo Max Descrio
DescritoresPreDefinidosDisponiveisResult
VersaoWebService String 10 Verso do webservice
ResultadoOperacao
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro
Rows
DadosDescritoresPreDefinidosProdutos
ProtocoloDescritorPreDefinido String 255 Protocolo descritor pr-definido
Acao String - Valores disponveis: 1.3 enumAcao
Nome String 100 Nome
CodigoDescritorPreDefinido Int - Cdigo do descritor pr-definido
Numero Int - Numero
GrupoCodigo Int - Cdigo do grupo
GrupoNome String 50 Nome do grupo

www.kpl.com.br Pgina 82 de 186

Verso: 2.0 KPL ENTERPRISE

2.26.5 XML de exemplo

1) Criao de novo grupo de descritores pr-definidos.

Menu: Comercial e Faturamento -> Cadastros -> Produtos -> Descritores -> Grupos de descritores pr-
definidos
2) Habilitao do novo grupo para integrao.

www.kpl.com.br Pgina 83 de 186

Verso: 2.0 KPL ENTERPRISE

3) Criao de novo descritor pr-definido.

4) Retorno do mtodo com o novo descritor pr-definido.

www.kpl.com.br Pgina 84 de 186

Verso: 2.0 KPL ENTERPRISE

2.26.6 Regras de negcio

Uma vez que o registro fica disponvel para integrao necessrio informar que o mesmo foi recebido
e integrado corretamente para que no fique mais disponvel na fila de integrao. A confirmao de
recebimento e integrao, deve ser feita atravs do mtodo 2.13
ConfirmarRecebimentoDescritorPreDefinido

2.26.7 Perguntas frequentes

2.26.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 85 de 186

Verso: 2.0 KPL ENTERPRISE

2.27 EstoqueOnline

2.27.1 Conceito

O mtodo 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.

2.27.2 Objetivo

Atravs desse mtodo possvel obter o saldo de estoque de qualquer produto com a posio do momento,
ou seja, obter o saldo de estoque online.

2.27.3 Pr-requisitos

Pr-requitos descritos no capitulo: 2.28 EstoquesDisponiveis

2.27.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ChaveIdentificacao String 36 Identificao nica da interface
ListaDeCodigosProdutos
String String Cdigo externo do produto

LAYOUT RESPONSE
Campo Tipo Max Descrio
EstoqueOnLineResult
VersaoWebService String 10 Verso do webservice
ResultadoOperacao
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
Rows
DadosEstoqueResultado
CodigoProduto String 50 Cdigo do Produto
SaldoMinimo Float - Saldo mnimo
SaldoDisponivel Float - Saldo disponvel
ProdutoTipoLigacao String - Valores Possveis: 1.7 enumProdutoTipoLigacao
SiglaEstoque String 3 Sigla do estoque
NomeEstoque String 50 Nome do estoque
Resultado
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro

2.27.5 XML de exemplo

1) Execuo do mtodo para obter o saldo online do produto 17228.

REQUEST
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
www.kpl.com.br Pgina 86 de 186
Verso: 2.0 KPL ENTERPRISE

xmlns:abac="http://www.kplsolucoes.com.br/ABACOSWebService">
<soapenv:Header/>
<soapenv:Body>
<abac:EstoqueOnLine>
<abac:ChaveIdentificacao>A8CBDC81-11A7-4A65-9993-38028E20D5AA</abac:ChaveIdentificacao>
<abac:ListaDeCodigosProdutos>
<abac:string>17228</abac:string>
</abac:ListaDeCodigosProdutos>
</abac:EstoqueOnLine>
</soapenv:Body>
</soapenv:Envelope>

2.27.6 Regras de negcio

possvel solicitar o saldo de estoque online de um nico produto ou de uma lista de produtos.

No retorno do mtodo, todos os produtos que estavam presentes na solicitao so apresentados com os seus
respectivos resultados (sucesso ou erro).

2.27.7 Perguntas frequentes

2.27.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 87 de 186

Verso: 2.0 KPL ENTERPRISE

2.28 EstoqueOnlineSaldo

2.28.1 Conceito

O mtodo EstoqueOnline foi desenvolvido para permitir consultar o saldo de estoque de qualquer produto
existente na base de dados do KPL.

2.2.2 Objetivo

Atravs desse mtodo possvel obter o saldo de estoque de qualquer produto com a posio do momento,
ou seja, obter o saldo de estoque online.

2.28.3 Pr-requisitos

Pr-requitos descritos no capitulo: 2.28 EstoquesDisponiveis

2.28.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ChaveIdentificacao String 36 Identificao nica da interface
CodigosProduto String 50 Cdigo do Produto buscado

LAYOUT RESPONSE
Campo Tipo Max Descrio
EstoqueOnLineSaldoResult
VersaoWebService String 10 Verso do webservice
ResultadoOperacao
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
Rows
DadosEstoqueResultado
CodigoProduto String 50 Cdigo do Produto
SaldoMinimo Float - Saldo mnimo
SaldoDisponivel Float - Saldo disponvel
ProdutoTipoLigacao String - Valores Possveis: 1.7 enumProdutoTipoLigacao
SiglaEstoque String 3 Sigla do estoque
NomeEstoque String 50 Nome do estoque
Resultado
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro

www.kpl.com.br Pgina 88 de 186

Verso: 2.0 KPL ENTERPRISE

2.28.5 XML de exemplo

2) Execuo do mtodo para obter o saldo online do produto 17228.

2.28.6 Regras de negcio

possvel solicitar o saldo de estoque de um nico produto por vez.

No retorno do mtodo, todos os produtos que estavam presentes na solicitao so apresentados com
os seus respectivos resultados (sucesso ou erro).

2.28.7 Perguntas frequentes

www.kpl.com.br Pgina 89 de 186

Verso: 2.0 KPL ENTERPRISE

2.29 EstoquesDisponiveis

2.29.1 Conceito

O mtodo EstoquesDisponiveis foi desenvolvido para disponibilizar as categorias de produtos do site,

disponveis para integrao.

2.29.2 Objetivo

Atravs desse mtodo possvel obter as informaes de estoques de produtos, que esto disponveis para
integrao.

2.29.3 Pr-requisitos

A informao se torna disponvel para integrao quando ocorre uma incluso, alterao ou excluso de
alguma informao.

Ativar replicao na interface

Ativar a replicao no cadastro da interface.

www.kpl.com.br Pgina 90 de 186

Verso: 2.0 KPL ENTERPRISE

Habilitar o produto na interface

Para que o produto fique disponvel para integrao, necessrio habilita-lo na interface.

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

Configurar almoxarifados para integrao

Devem ser configurados no cadastro da interface os almoxarifados para integrao.

www.kpl.com.br Pgina 91 de 186

Verso: 2.0 KPL ENTERPRISE

2.29.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ChaveIdentificacao String 36 Identificao nica da interface

LAYOUT RESPONSE
Campo Tipo Max Descrio
EstoquesDisponiveisResult
VersaoWebService String 10 Verso do webservice
ResultadoOperacao
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro
Rows
DadosEstoque
ProtocoloEstoque String 255 Protocolo estoque
CodigoProdutoPai String 50 Cdigo do produto Pai
CodigoProduto String 50 Cdigo do produto
CodigoProdutoAbacos String 50 Cdigo produto KPL
SaldoMinimo Float - Saldo mnimo
SaldoDisponivel Float - Saldo disponvel
NomeAlmoxarifadoOrigem String 50 Nome do estoque de origem
IdentificadorProduto String 255 Identificador do produto
CodigoProdutoParceiro String 50 Cdigo externo do produto

2.29.5 XML de exemplo

1) Consulta do estoque antes do inicio da operao.

Menu: Comercial e Faturamento -> Consultas -> Produtos

www.kpl.com.br Pgina 92 de 186

Verso: 2.0 KPL ENTERPRISE

2) Movimentao de estoque.

Menu: Estoque -> Movimentaes -> Documento auxiliar de movimentao de estoque

3) Consulta do estoque aps a movimentao de estoque.

Menu: Comercial e Faturamento -> Consultas -> Produtos

4) Execuo do mtodo para retorno das informaes.

<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operao "Lista dados de estoques disponveis" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosEstoque>
<ProtocoloEstoque>be488aee-db7d-48c2-a5a8-
9c028c260f70</ProtocoloEstoque>
<CodigoProdutoPai>412342</CodigoProdutoPai>
<CodigoProduto>17228</CodigoProduto>
<CodigoProdutoAbacos>6082</CodigoProdutoAbacos>
<SaldoMinimo>1</SaldoMinimo>
<SaldoDisponivel>80</SaldoDisponivel>
<NomeAlmoxarifadoOrigem/>
<IdentificadorProduto>1147dbdb-8100-47da-b5eb-
9abfb34895a9</IdentificadorProduto>
<CodigoProdutoParceiro/>
</DadosEstoque>
</Rows>
</EstoquesDisponiveisResult>
</EstoquesDisponiveisResponse>
</soap:Body>
</soap:Envelope>

2.29.6 Regras de negcio

As movimentaes do mesmo produto so agrupadas no retorno do mtodo.

2.29.7 Perguntas frequentes

2.29.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 94 de 186

Verso: 2.0 KPL ENTERPRISE

2.30 FamiliasDisponiveis

2.30.1 Conceito

O mtodo FamiliasDisponiveis foi desenvolvido para disponibilizar as famlias de produtos disponveis para
integrao.

2.30.2 Objetivo

Atravs desse mtodo possvel obter as informaes de famlias de produtos que esto disponveis para
integrao.

2.30.3 Pr-requisitos

A informao se torna disponvel para integrao quando ocorre uma incluso, alterao ou excluso de
alguma informao.

Ativar replicao de sada

Deve ser habilitada na interface a replicao de sada das famlias.

www.kpl.com.br Pgina 95 de 186

Verso: 2.0 KPL ENTERPRISE

2.29.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ChaveIdentificacao String 36 Identificao nica da interface

LAYOUT RESPONSE
Campo Tipo Max Descrio
ClassesDisponiveisResult
VersaoWebService String 10 Verso do WebService
ResultadoOperacao
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro
Rows
DadosClassesProdutos
ProtocoloFamiilia String 255 Protocolo da famlia
Acao String - Valores disponveis: 1.3 enumAcao
Nome Char 50 Nome
CodigoExternoFamilia String 50 Cdigo externo famlia
CodigoFamilia Int - Cdigo famlia no KPL

2.30.5 XML de exemplo

1) Criao de uma nova famlia.

www.kpl.com.br Pgina 96 de 186

Verso: 2.0 KPL ENTERPRISE

2) Retorno do mtodo com a classe alterada.

2.30.6 Regras de negcio

2.30.7 Perguntas frequentes

2.30.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 97 de 186

Verso: 2.0 KPL ENTERPRISE

2.31 GrupoProdutosDisponiveis

2.31.1 Conceito

O mtodo GrupoProdutosDisponiveis foi desenvolvido para disponibilizar os grupos de produtos disponveis

para integrao.

2.31.2 Objetivo

Atravs desse mtodo possvel obter as informaes dos grupos de produtos que esto disponveis para
integrao.

2.31.3 Pr-requisitos

A informao se torna disponvel para integrao quando ocorre uma incluso, alterao ou excluso de
alguma informao.

Ativar replicao de sada

Deve ser habilitada na interface a replicao de sada dos grupos de produtos.

www.kpl.com.br Pgina 98 de 186

Verso: 2.0 KPL ENTERPRISE

2.31.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
GrupoProdutosDisponiveis
ChaveIdentificacao String 36 Identificao nica da interface

LAYOUT RESPONSE
Campo Tipo Max Descrio
GrupoProdutosDisponiveisResult
VersaoWebService String 10 Verso do webservice
ResultadoOperacao
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
Rows
DadosGruposProdutos
ProtocoloGrupo String 255 Protocolo do grupo
Acao String - Valores disponveis: 1.3 enumAcao
Nome Char 50 Nome
CodigoExternoGrupo String 50 Cdigo externo grupo
CodigoGrupo Int - Cdigo do grupo no KPL

2.31.5 XML de exemplo

1) Incluso de novo grupo de produtos.

2) Execuo do mtodo para retorno dos grupos disponveis para integrao.

REQUEST
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:abac="http://www.kplsolucoes.com.br/ABACOSWebService">
<soapenv:Header/>

www.kpl.com.br Pgina 99 de 186

Verso: 2.0 KPL ENTERPRISE

<soapenv:Body>
<abac:GrupoProdutosDisponiveis>

<abac:ChaveIdentificacao>A8CBDC81-11A7-4A65-9993-
38028E20D5AA</abac:ChaveIdentificacao>
</abac:GrupoProdutosDisponiveis>
</soapenv:Body>
</soapenv:Envelope>

RESPONSE
<soap:Body>
<GrupoProdutosDisponiveisResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebService">
<GrupoProdutosDisponiveisResult>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operao "Grupo de produto" efetuada com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosGruposProdutos>
<ProtocoloGrupo>132C4D90-C8B4-4D46-A4D7-B630B72DB1E2</ProtocoloGrupo>
<Acao>aieManutencao</Acao>
<Nome>Integracao</Nome>
<CodigoExternoGrupo/>
<CodigoGrupo>46</CodigoGrupo>
</DadosGruposProdutos>
</Rows>
</GrupoProdutosDisponiveisResult>
</GrupoProdutosDisponiveisResponse>
</soap:Body>

2.31.6 Regras de negcio

Podem ser enviados diversos pagamentos de pedidos de uma nica vez.

2.31.7 Perguntas frequentes

2.31.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 100 de 186

Verso: 2.0 KPL ENTERPRISE

2.32 InserirListaPresente
2.32.1 Conceito

O mtodo InserirListaPresente foi desenvolvido para cadastrar lista de presente via integrao.

2.32.2 Objetivo

Atravs do mtodo possvel incluir lista de presente de casamento no KPL via integrao webservice.

2.32.3 Pr-requisitos

Ativar replicao na interface

Ativar a replicao no cadastro da interface.

2.32.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
InserirListaPresente
ChaveIdentificacao String 36 Identificao nica da interface
ListaDePresentes
DadosListaPresente
CodigoListaPresente String 50 Cdigo da lista de presente
TipoListaPresente String - Valores disponveis: 1.13
enumTipoListaPresente
NomeListaPresente String 255 Nome da lista
CodigoValePresente String 100 Nmero do vale presente
DataInicialLista Datetime - Data de inicio da lista
DataFinalLista Datetime - Data de termino da lista
DataEvento Datetime - data do evento
www.kpl.com.br Pgina 101 de 186
Verso: 2.0 KPL ENTERPRISE

CPFouCNPJ String 14 CPF ou CNPJ

CodigoCliente String 50 Cdigo do cliente
DataValidadeVale Datetime - Data de validade do vale presente

LAYOUT RESPONSE
Campo Tipo Max Descrio
InserirListaPresenteResult
VersaoWebService String 10 Verso do WebService
ResultadoOperacao
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro
Rows
DadosListaPresenteResultado
CodigoListaPresente String 50 Cdigo da lista de presente
Resultado
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro

2.32.5 XML de exemplo

1) Execuo do mtodo para incluso da lista de presentes no KPL.

REQUEST
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:abac="http://www.kplsolucoes.com.br/ABACOSWebService">
<soap:Header/>
<soap:Body>
<abac:InserirListaPresente>
<abac:ChaveIdentificacao>A8CBDC81-11A7-4A65-9993-
38028E20D5AA</abac:ChaveIdentificacao>
<abac:ListaDePresentes>
<abac:DadosListaPresente>
<abac:CodigoInterface>57</abac:CodigoInterface>
<abac:CodigoListaPresente>2603</abac:CodigoListaPresente>
<abac:TipoListaPresente>tlpeProdutos</abac:TipoListaPresente>
<abac:NomeListaPresente>KPL-MercadoLivre</abac:NomeListaPresente>
<abac:DataInicialLista>26012015</abac:DataInicialLista>
<abac:DataFinalLista>26032015</abac:DataFinalLista>
<abac:DataEvento>26032015</abac:DataEvento>
<abac:CPFouCNPJ>05521031000101</abac:CPFouCNPJ>
<abac:CodigoCliente>1604</abac:CodigoCliente>
<abac:DataValidadeVale>26032015</abac:DataValidadeVale>
</abac:DadosListaPresente>
</abac:ListaDePresentes>
</abac:InserirListaPresente>
</soap:Body>
</soap:Envelope>

www.kpl.com.br Pgina 102 de 186

Verso: 2.0 KPL ENTERPRISE

<InserirListaPresenteResult>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200002</Codigo>
<Descricao>OK.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosListaPresenteResultado>
<CodigoListaPresente>2603</CodigoListaPresente>
<Resultado>
<Codigo>200002</Codigo>
<Descricao>OK.</Descricao>
<Tipo>tdreSucesso</Tipo>
</Resultado>
</DadosListaPresenteResultado>
</Rows>
</InserirListaPresenteResult>
</InserirListaPresenteResponse>
</soap:Body>
</soap:Envelope>

2) Tela com a incluso da lista de presente.

2.32.7 Regras de negcio

Podem ser enviadas vrias listas em uma nica vez.

2.32.8 Perguntas frequentes

2.32.9 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 103 de 186

Verso: 2.0 KPL ENTERPRISE

2.33 InserirPedido

2.33.1 Conceito

O mtodo InserirPedido foi desenvolvido para cadastrar pedidos de venda no KPL via integrao.

2.33.2 Objetivo

Atravs do mtodo ser possvel incluir pedidos de venda no KPL via integrao webservice.

2.33.3 Pr-requisitos

Antes de iniciar a integrao de pedidos de venda via integrao webservice, necessrio configurar os
parmetros na interface, conforme seguem:

Ativar replicao na interface

Ativar a replicao no cadastro da interface.

www.kpl.com.br Pgina 104 de 186

Verso: 2.0 KPL ENTERPRISE

Configurar na interface o DE-PARA de Paises

No cadastro da interface, deve configurar o DE-PARA de Pases.

Caso o DE-PARA de Pases no esteja configurada, ser exibida a mensagem abaixo no momento da
integrao: Interface = 57 Cliente = 05521031000101 Msg = Destinatrio: Pas (Brasil) informado no
encontrado na interface De-Para.

Configurar na interface o DE-PARA de Forma de Pagamento

No cadastro da interface, deve configurar o DE-PARA de Forma de Pagamento.

Caso o DE-PARA de Forma de Pagamento no esteja configurada, ser exibida a mensagem abaixo no
momento da integrao: Interface = 57 Forma de pagamento = Mastercard Msg = Forma de pagamento
no encontrada.
www.kpl.com.br Pgina 105 de 186
Verso: 2.0 KPL ENTERPRISE

Configurar usurio

No cadastro da interface, deve configurar o usurio.

Configurar lote do pedido

Deve ser configurado o lote do pedido na interface.

Caso o lote do pedido no esteja configurado, ser exibida a mensagem abaixo no momento da integrao:
Interface = 57 Pedido = 1401 Msg = falta configurar o lote de pedido.

www.kpl.com.br Pgina 106 de 186

Verso: 2.0 KPL ENTERPRISE

Classificao para gravar observao do pedido

Deve configurar a classificao do pedido que ser utilizada na observao.

Caso a classificao para gravar a observao do pedido no esteja configurada, ser exibida a mensagem
abaixo no momento da integrao: Interface = 57 Pedido = 1401 Msg = falta configurar a classificao para
gravar a observao do pedido (tipo 1).

Configurar o DE-PARA da Transportadora/Servio de Entrega na interface

No cadastro da interface, deve configurar o DE-PARA da Transportadora/Servio de Entrega.

Caso o DE-PARA da Transportadora/Servio de Entrega no esteja configurado, ser exibida a mensagem

www.kpl.com.br Pgina 107 de 186

Verso: 2.0 KPL ENTERPRISE

abaixo no momento da integrao: Interface = 57 Cliente = 05521031000101 Msg = transportadora /

servico de entrega (CORREIOS - PAC) nao cadastrados.

Tambm possvel configurar na interface um valor default para Transportadora/Servio de Entrega. Caso
no seja enviado nenhum valor no XML, o KPL utiliza o valor default cadastrado na interface.

Caso no tenha valor default e no seja enviada nenhuma informao no XML, ser exibida a mensagem
abaixo no momento da integrao: Interface = 57 Cliente = 05521031000101 Msg = transportadora /
servico de entrega () nao cadastrados.

2.33.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
InserirPedido
ChaveIdentificacao String 36 Identificao nica da interface
ListaDePedidos
DadosPedidos
NumeroDoPedido String 50 Cdigo do pedido
EMail String 100 E-mail (Se for digitado o cdigo do cliente
no ser necessrio digitar o e-mail e nem
CPF)
CPFouCNPJ String 14 CPF ou CNPJ (Se for digitado o cdigo do
cliente, no ser necessrio digitar o
CPF/CNPJ e nem o e-mail)
CodigoCliente String 50 Cdigo do cliente
RepresentanteVendas String 50 Representante de vendas
CondicaoPagamento String 50 Nome da condio de pagamento
ValorPedido Float - Valor do pedido
ValorFrete Float - Valor do frete
ValorEncargos Float - Valor de encargos
ValorDesconto Float - Valor do desconto concedido no pedido
ValorEmbalagemPresente Float - Valor de embalagens para presente

www.kpl.com.br Pgina 108 de 186

Verso: 2.0 KPL ENTERPRISE

ValorReceberEntrega String 50 Valor a receber

ValorTrocoEntrega String 50 Valor de troco
DataVenda Datetime - Data venda
Transportadora String 50 Nome da transportadora
ServicoEntrega String 50 Nome do servio de entrega
Canal String 50 Canal
SubCanal String 50 SubCanal
EmitirNotaSimbolica Bool - Emitir nota fiscal simblica?
Serve para pedidos para presente onde a
nota fiscal deve ser enviada ao presentado
ValorCupomDesconto Float - Valor do cupom de desconto
NumeroCupomDesconto String 40 Nmero do cupom de desconto
Lote String 50 Lote do pedido de venda
DestNome String 50 Destinatrio Nome
DestSexo Char 1 Destinatrio Sexo
DestEmail String 100 Destinatrio - E-Mail
DestTelefone String 15 Destinatrio Telefone
DestLogradouro String 80 Destinatrio Logradouro
DestNumeroLogradouro String 50 Destinatrio - Nmero
DestComplementoEndereco String 50 Destinatrio Complemento
DestBairro String 60 Destinatrio - Bairro
DestMunicipio String 60 Destinatrio - Municpio
DestEstado String 50 Destinatrio - Estado
DestCep String 20 Destinatrio - CEP
DestTipoLocalEntrega String - Valores disponiveis: 1.8
enumTipoLocalEntrega
DestEstrangeiro Char 1 Destinatrio - Flag estrangeiro
DestPais String 100 Destinatrio - Pas
DestCPF String 14 Destinatrio - CPF ou CNPJ
DestTipoPessoa String - Valore disponveis: 1.9 enumTipoPessoa
DestDocumento Char 14 Destinatrio - Nmero de documento
DestInscricaoEstadual Char 14 Destinatrio - Inscrio estadual
DestInscricaoMunicipal Char 15 Destinatrio - Inscrio municipal
DestReferencia String 60 Destinatrio - Referncia
Anotacao1 Text - Anotao
Anotacao2 Text - Anotao
Anotacao3 Text - Anotao
PedidoJaPago Bool - Pedido j foi pago?
DataDoPagamento Datetime - Data do pagamento
FormasDePagamento
DadosPedidosFormaPgto
FormaPagamentoCodigo Int Cdigo da forma de pagamento. O KPL no
aceita duas formas de pagamento do tipo
cupom de desconto.
Valor Float - Valor
CartaoNumero String 255 Numero do carto
CartaoCodigoSeguranca String 255 Cdigo do carto de segurana
CartaoValidade String 255 Validade do carto
CartaoNomeImpresso String 50 Nome impresso no carto
CartaoQtdeParcelas Int - Quantidade de parcelas
CartaoCodigoAutorizacao String 50 Cdigo autorizao carto
BoletoVencimento Datetime - Boleto vencimento
BoletoNumeroBancario String 20 Numero bancrio boleto
CartaoCPFouCNPJTitular Char 14 CPF ou CNPJ do titular do carto de crdito
www.kpl.com.br Pgina 109 de 186
Verso: 2.0 KPL ENTERPRISE

CartaoDataNascimentoTitular Datetime - Data de nascimento do titular do carto

DebitoEmContaNumeroBanco String 10 Nmero do banco para dbito em conta
corrente
DebitoEmContaCodigoAgencia String 10 Cdigo da agncia para dbito em conta
corrente
DebitoEmContaDVCodigoAgencia Char 2 Digito da agencia para debito em conta
DebitoEmContaContaCorrente String 20 Debito em conta
DebitoEmContaDVContaCorrente Char 2 Nmero do dgito da conta para dbito em
conta corrente
PreAutorizadaNaPlataforma Bool - Identificar se o pedido teve ou no sua pr-
autorizao na Plataforma.
CartaoTID String 50 Cdigo da transao da empresa
intermediria de cobrana.
CartaoNSU String 50 Nmero sequencial nico da transao de
carto.
CartaoNumeroToken String 50 Nmero Token do carto de crdito.
CodigoTransacaoGateway String 100 Identificador da transao no gateway.
Itens
DadosPedidosItem
CodigoProduto String 50 Cdigo do produto
QuantidadeProduto Float - Quantidade de produtos
PrecoUnitario Float - Preo unitrio
EmbalagemPresente Bool - Embalagem para presente?
MensagemPresente Text - Mensagem presente
PrecoUnitarioBruto Float - Preo unitrio bruto
Brinde Bool - Brinde?
ValorReferencia Float - Valor referencia
Personalizacao
DadosPedidosItemPersonalizacao
CodigoProdutoPersonalizacao String 50 Cdigo do produto personalizao
PrecoUnitarioLiquido Float - Preo unitrio liquido
PrecoUnitarioBruto Float - Preo unitrio bruto
TextoPersonalizacao Text - Texto associado personalizao do item do
pedido
DescritorSimples1 String 100 Descritor simples do produto
DescritorSimples2 String 100 Descritor simples do produto
DescritorSimples3 String 100 Descritor simples do produto
DescritorPreDefinido1 String 100 Nome do descritor pr-definido do produto
DescritorPreDefinido2 String 100 Nome do descritor pr-definido do produto
DescritorPreDefinido3 String 100 Nome do descritor pr-definido do produto
OptouNFPaulista String - Valores possveis: 1.11 enumOptouNFPaulista
CodigoCartaoPresente String 50 Cdigo do carto presente
MensagemCartaoPresente Text - Mensagem para o carto
AssinaturaCartaoPresente String 100 Assinatura do carto
ValorTotalCartaoPresente Float - Valor total do carto
CartaoPresenteBrinde Bool - O carto de presente um brinde?
TempoEntregaTransportadora Int - Tempo de entrega da transportadora
DataPrazoEntregaInicial Datetime - Data inicial do prazo de entrega
DataPrazoEntregaFinal Datetime - Data final do prazo de entrega
TipoEntrega String 50 Tipo de entrega
CodigoLocalRetirada String 50 Local retirada
SenhaRetirada String 50 Senha retirada
IPComprador String 50 IP do usurio quando este efetuou a compra
ComercializacaoOutrasSaidas Int - Comercializao outras sadas
www.kpl.com.br Pgina 110 de 186
Verso: 2.0 KPL ENTERPRISE

PrazoEntregaPosPagamento Float - Prazo de entrega ps-pagamento

Volumes
NumeroObjeto String 50 Numero de rastreio da encomenda do volume
PesoLiquido Double - Peso liquido do volume
PesoBruto Double - Peso bruto do volume
Especie String 50 Espcie do volume
Marca String 50 Marca do volume
Descricao String 50 Descrio do Volume
TipoServico String 2 Tipo de servio do volume
PLP String 50 PLP
CodigoRemessa String 50 Cdigo da remessa (ShipmentId)
TextoEtiquetaEnderecamento String 8000 Etiqueta (LabelText)
NotaRemessa
NumeroNotaFiscal Int - Numero da Nota para Remessa
SerieNotaFiscal String 3 Serie da Nota para Remessa
DataEmissaoNotaFiscal Datetime - Data de emisso da Nota para Remessa
ValorFretePagar Float - Valor do frete a ser pago pela empresa
CampoUsoLivre String 50 Campo uso livre
CodigoListaPresente String 50 Cdigo lista de presente
TelefoneSMS String 20 Numero de telefone para SMS

LAYOUT RESPONSE
Campo Tipo Max Descrio
InserirPedidoResult
VersaoWebService String 10 Verso do WebService
ResultadoOperacao
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
Rows
DadosPedidosResultado
NumeroDoPedido String 50 Nmero do pedido de venda
Resultado
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
FormasDePagamentoResultado
DadosPedidosFormaPgtoResultado
FormaPagamento String 50 Forma de pagamento
Resultado
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
ItensResultado
DadosPedidosItemResultado
CodigoProduto String 50 Cdigo do produto
Resultado
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo

www.kpl.com.br Pgina 111 de 186

Verso: 2.0 KPL ENTERPRISE

2.33.5 XML de exemplo

1) XML executado para incluso do pedido de venda no KPL.

REQUEST
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:abac="http://www.kplsolucoes.com.br/ABACOSWebService">
<soapenv:Header/>
<soapenv:Body>
<abac:InserirPedido>
<abac:ChaveIdentificacao>A8CBDC81-11A7-4A65-9993-38028E20D5AA</abac:ChaveIdentificacao>
<abac:ListaDePedidos>
<abac:DadosPedidos>
<abac:NumeroDoPedido>1401</abac:NumeroDoPedido>
<abac:EMail>integracao@kpl.com.br</abac:EMail>
<abac:CPFouCNPJ>05521031000101</abac:CPFouCNPJ>
<abac:CodigoCliente>KPL</abac:CodigoCliente>
<abac:ValorPedido>57.81</abac:ValorPedido>
<abac:ValorFrete>0</abac:ValorFrete>
<abac:ValorEncargos>0</abac:ValorEncargos>
<abac:ValorDesconto>0</abac:ValorDesconto>
<abac:ValorEmbalagemPresente>0</abac:ValorEmbalagemPresente>
<abac:DataVenda>14012016</abac:DataVenda>
<abac:Transportadora>Integracao</abac:Transportadora>
<abac:EmitirNotaSimbolica>false</abac:EmitirNotaSimbolica>
<abac:ValorCupomDesconto>0</abac:ValorCupomDesconto>
<abac:NumeroCupomDesconto>0</abac:NumeroCupomDesconto>
<abac:DestNome>KPL</abac:DestNome>
<abac:DestSexo>tseMasculino</abac:DestSexo>
<abac:DestEmail>integracao@kpl.com.br</abac:DestEmail>
<abac:DestTelefone>21879090</abac:DestTelefone>
<abac:DestLogradouro>Alameda Cauaxi</abac:DestLogradouro>
<abac:DestNumeroLogradouro>350</abac:DestNumeroLogradouro>
<abac:DestComplementoEndereco>5 andar</abac:DestComplementoEndereco>
<abac:DestBairro>Alphaville</abac:DestBairro>
<abac:DestMunicipio>Barueri</abac:DestMunicipio>
<abac:DestEstado>SP</abac:DestEstado>
<abac:DestCep>06454020</abac:DestCep>
<abac:DestTipoLocalEntrega>tleeComercial</abac:DestTipoLocalEntrega>
<abac:DestEstrangeiro>N</abac:DestEstrangeiro>
<abac:DestPais>Brasil</abac:DestPais>
<abac:DestCPF>05521031000101</abac:DestCPF>
<abac:DestTipoPessoa>tpeJuridica</abac:DestTipoPessoa>
<abac:Anotacao1>Integracao</abac:Anotacao1>
<abac:PedidoJaPago>false</abac:PedidoJaPago>
<abac:DataDoPagamento>14012016</abac:DataDoPagamento>
<abac:FormasDePagamento>
<abac:DadosPedidosFormaPgto>
<abac:FormaPagamentoCodigo>Mastercard</abac:FormaPagamentoCodigo>
<abac:Valor>57.81</abac:Valor>
<abac:CartaoNumero>4012001037141112</abac:CartaoNumero>
<abac:CartaoCodigoSeguranca>123</abac:CartaoCodigoSeguranca>
<abac:CartaoValidade>122015</abac:CartaoValidade>
<abac:CartaoNomeImpresso>KPL Solucoes</abac:CartaoNomeImpresso>
<abac:CartaoQtdeParcelas>1</abac:CartaoQtdeParcelas>
<abac:CartaoCodigoAutorizacao>4444444444</abac:CartaoCodigoAutorizacao>
<abac:CartaoCPFouCNPJTitular>05521031000101</abac:CartaoCPFouCNPJTitular>
<abac:CartaoDataNascimentoTitular>16041989</abac:CartaoDataNascimentoTitular>
<abac:PreAutorizadaNaPlataforma>true</abac:PreAutorizadaNaPlataforma>
<abac:CartaoTID>1111111</abac:CartaoTID>
<abac:CartaoNSU>2222222</abac:CartaoNSU>
<abac:CartaoNumeroToken>3333333</abac:CartaoNumeroToken>
<abac:CodigoTransacaoGateway>001</abac:CodigoTransacaoGateway>
</abac:DadosPedidosFormaPgto>
</abac:FormasDePagamento>
<abac:Itens>
www.kpl.com.br Pgina 112 de 186
Verso: 2.0 KPL ENTERPRISE

<abac:DadosPedidosItem>
<abac:CodigoProduto>17228</abac:CodigoProduto>
<abac:QuantidadeProduto>1</abac:QuantidadeProduto>
<abac:PrecoUnitario>57.81</abac:PrecoUnitario>
<abac:EmbalagemPresente>false</abac:EmbalagemPresente>
<abac:MensagemPresente/>
<abac:PrecoUnitarioBruto>28</abac:PrecoUnitarioBruto>
<abac:Brinde>false</abac:Brinde>
</abac:DadosPedidosItem>
</abac:Itens>
<abac:OptouNFPaulista>tbneNao</abac:OptouNFPaulista>
<abac:ValorTotalCartaoPresente>0</abac:ValorTotalCartaoPresente>
<abac:CartaoPresenteBrinde>false</abac:CartaoPresenteBrinde>
</abac:DadosPedidos>
</abac:ListaDePedidos>
</abac:InserirPedido>
</soapenv:Body>
</soapenv:Envelope>

2) Tela do KPL com o pedido de venda cadastrado atravs integrao webservice.

www.kpl.com.br Pgina 114 de 186

Verso: 2.0 KPL ENTERPRISE

2.33.6 Regras de negcio

Podem ser enviados vrios pedidos de uma nica vez.

2.33.7 Perguntas frequentes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 115 de 186

Verso: 2.0 KPL ENTERPRISE

2.34 ListaPresenteDisponiveis

2.34.1 Conceito

O mtodo ListaPresenteDisponiveis foi desenvolvido para disponibilizar as listas de presentes disponveis

para integrao.

2.34.2 Objetivo

Atravs desse mtodo possvel obter as informaes de lista de presente que esto disponveis para a
integrao.

2.34.3 Pr-requisitos

A informao se torna disponvel para integrao quando ocorre uma concluso da digitao da lista no KPL.

2.34.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ChaveIdentificacao String 36 Identificao nica da interface

LAYOUT RESPONSE
Campo Tipo Max Descrio
ListaPresenteDisponiveisResult
VersaoWebService String 10 Vereso do Webservice
ResultadoOperacao
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro
Rows
DadosListaPresenteDisponiveisWeb
CodigoListaPresenteAbacos Int - Cdigo da lista de presente no KPL
ProtocoloListaPresente
Acao String - Valores disponveis: 1.3 enumAcao
ListaPresenteWeb
DadosListaPresenteWeb
CodigoListaPresenteAbacos Int - Cdigo da lista de presente no KPL
CodigoTipoLista Int - Cdigo tipo da lista
DataInicioEvento Datetime - Data inicio do evento
DataFinalEvento Datetime - Data final do evento
NomeListaPresente Char 50 Nome da lista de presente
NumeroValePresente String 255 Numero do vale presente
CodigoCliente Int - Cdigo do cliente
NomeCliente Char 50 Nome do cliente
NomeNoivo Char 50 Nome do noivo
NomeNoiva Char 50 Nome da noiva
EmailNoivo String 100 Email do noivo
EmailNoiva String 100 Email da noiva
DataEvento Datetime - Data do evento
LocalEvento String 50 Local do evento
CodigoListaPresente String 50 Cdigo da lista de presente
www.kpl.com.br Pgina 116 de 186
Verso: 2.0 KPL ENTERPRISE

DataValidadeValePresente Datetime - Data validade do vale presente

EntregaAgrupada Bool - Entrega agrupada?
Mensagem String 500 Mensagem
DadosCliFor
DadosListaPresenteWeb
EMail String 100 E-mail
CPFouCNPJ String 14 CPF ou CNPJ
Codigo String 50 Cdigo do cliente/fornecedor
TipoPessoa String 1 Valores disponveis: 1.9 enumTipoPessoa
Documento String 14 Nmero de documento
InscricaoEstadual String 14 Inscrio estadual
InscricaoMunicipal String 14 Inscrio municipal
Classificacao String 50 Classificao do cliente/fornecedor
Nome String 100 Nome do cliente (Razo social para pessoa jurdica)
NomeReduzido String 20 Nome reduzido do cliente (Nome fantasia para pessoa
jurdica)
Sexo String - Valores disponves: 1.5 enumSexo
DataNascimento String 21 Data de nascimento
Profissao String 50 Profisso
Site String 100 Site
Telefone String 15 Telefone
Fax String 15 Fax
Celular String 15 Celular
DataCadastro String 21 Data de cadastro
Endereco
Logradouro String 80 Logradouro
NumeroLogradouro String 50 Nmero do endereo
ComplementoEndereco String 30 Complemento do endereo
Bairro String 60 Bairro
Municipio String 60 Cidade / Municpio / Municpio estrangeiro
Estado String 60 UF / Estado / Estado Estrangeiro
Cep String 20 CEP
TipoLocalEntrega String - Valores disponveis: 1.8 enumTipoLocalEntrega
ReferenciaEndereco String 60 Referncia do endereo
EndCodigoIBGE String Endereo cdigo IBGE
SubRegiao Char 50 Sub-regio do cliente
CategoriaFiscal Char 50 Categoria fiscal
CodigoCliForAbacos Int - Cdigo cliente/fornecedor no KPL
CodigoClassificacaoCliFor Int - Cdigo classificao cliente/fornecedor
CodigoRamoAtividade Char 50 Cdigo ramo da atividade
CodigoSubRegiao Char 50 Cdigo da sub-regio
CodigoRegiao Int - Cdigo da regio
RamoAtividade Char 50 Ramo da atividade
Regiao Char 50 Regio
TipoCliFor Char 1 Tipo de cliente ou fornecedor 1.8 TipoCliForEnum
DataUltimaAlteracao Datetime - Data ltima alterao
DataInicialOperacao Datetime - Data incio operao
DataDesativacao Datetime - Data desativao
DataRevisaoCadastro Datetime - Data reviso cadastro
NumeroSuframa Char 14 Nmero suframa
NumeroIbama Char 14 Numero Ibama
LocalizadoZonaFranca Bool - Zona Franca?
CodigoCategoriaFiscal Int - Cdigo categoria fiscal
Cnae String 7 CNAE
www.kpl.com.br Pgina 117 de 186
Verso: 2.0 KPL ENTERPRISE

EnderecoCobranca
Logradouro String 80 Logradouro
NumeroLogradouro String 50 Nmero do endereo
ComplementoEndereco String 30 Complemento do endereo
Bairro String 60 Bairro
Municipio String 60 Cidade / Municpio / Municpio estrangeiro
Estado String 60 UF / Estado / Estado Estrangeiro
Cep String 20 CEP
TipoLocalEntrega String - Valores disponveis: 1.8 enumTipoLocalEntrega
ReferenciaEndereco String 60 Referncia do endereo
EndCodigoIBGE String Endereo cdigo IBGE
EnderecoEntrega
Logradouro String 80 Logradouro
NumeroLogradouro String 50 Nmero do endereo
ComplementoEndereco String 30 Complemento do endereo
Bairro String 60 Bairro
Municipio String 60 Cidade / Municpio / Municpio estrangeiro
Estado String 60 UF / Estado / Estado Estrangeiro
Cep String 20 CEP
TipoLocalEntrega String - Valores disponveis: 1.8 enumTipoLocalEntrega
ReferenciaEndereco String 60 Referncia do endereo
EndCodigoIBGE String Endereo cdigo IBGE
ListaPresenteItensWeb
DadosListaPresenteItensWeb
CodigoItem Int - Cdigo do item
CodigoProdutoAbacos Int - Cdigo do produto no KPL
CodigoProduto String 50 Cdigo externo do produto
QuantidadeSolicitada Float - Quantidade solicitada
QuantidadeComprada Float - Quantidade comprada

www.kpl.com.br Pgina 118 de 186

Verso: 2.0 KPL ENTERPRISE

2.34.5 XML de exemplo

1) Criao de uma nova lista de presentes no KPL.

Menu: Comercial e Faturamento -> Cadastros -> Pedidos -> Listas de presente

2) Finalizao de digitao da lista de presente.

3) Execuo do mtodo para retorno das listas disponveis para integrao.

REQUEST
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:abac="http://www.kplsolucoes.com.br/ABACOSWebService">

www.kpl.com.br Pgina 119 de 186

Verso: 2.0 KPL ENTERPRISE

<soapenv:Header/>
<soapenv:Body>
<abac:ListaPresenteDisponiveis>

<abac:ChaveIdentificacao>?</abac:ChaveIdentificacao>
</abac:ListaPresenteDisponiveis>
</soapenv:Body>
</soapenv:Envelope>

RESPONSE
<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>
<ListaPresenteDisponiveisResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebService">
<ListaPresenteDisponiveisResult>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operao "Lista de presentes disponveis" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosListaPresenteDisponiveisWeb>
<CodigoListaPresenteAbacos>113</CodigoListaPresenteAbacos>
<ProtocoloListaPresente>6B3A7006-D145-424E-A9D6-
7A8D15EA3EEF</ProtocoloListaPresente>
<Acao>aieManutencao</Acao>
<ListaPresenteWeb>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operao "Lista de presentes On-line" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosListaPresenteWeb>
<CodigoListaPresenteAbacos>113</CodigoListaPresenteAbacos>
<CodigoTipoLista>1</CodigoTipoLista>
<DataInicioEvento>27/01/2016 00:00:00</DataInicioEvento>
<DataFinalEvento>27/02/2016 00:00:00</DataFinalEvento>
<NomeListaPresente>Integracao</NomeListaPresente>
<NumeroValePresente>4567</NumeroValePresente>
<CodigoCliente>1003</CodigoCliente>
<NomeCliente>Mariana Roveri Giollo</NomeCliente>
<NomeNoivo>Integracao</NomeNoivo>
<NomeNoiva/>
<EmailNoivo>integracao@kpl.com.br</EmailNoivo>
<EmailNoiva/>
<DataEvento>05/03/2016 00:00:00</DataEvento>
<LocalEvento>Barueri</LocalEvento>
<CodigoListaPresente>2701</CodigoListaPresente>
<DataValidadeValePresente>05/03/2016
00:00:00</DataValidadeValePresente>
<EntregaAgrupada>N</EntregaAgrupada>
<Mensagem/>
</DadosListaPresenteWeb>
</Rows>
</ListaPresenteWeb>
<DadosCliFor>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200002</Codigo>
<Descricao>OK.</Descricao>
www.kpl.com.br Pgina 120 de 186
Verso: 2.0 KPL ENTERPRISE

<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosCliFor>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200002</Codigo>
<Descricao>OK.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<EMail>mariana.roveri@kpl.com.br</EMail>
<CPFouCNPJ>00037457738886</CPFouCNPJ>
<Codigo>1604</Codigo>
<TipoPessoa>tpeFisica</TipoPessoa>
<Documento>458618901</Documento>
<InscricaoEstadual/>
<InscricaoMunicipal/>
<Classificacao>CONSUMIDOR</Classificacao>
<Nome>Mariana Roveri Giollo</Nome>
<NomeReduzido>Mari</NomeReduzido>
<Sexo>tseFeminino</Sexo>
<DataNascimento>16041989 00:00:00.000</DataNascimento>
<Profissao>Analista de Negocios</Profissao>
<Site/>
<Telefone>(11)45268314</Telefone>
<Fax/>
<Celular>(11)974235423</Celular>
<DataCadastro>30122014 12:33:37.067</DataCadastro>
<Endereco>
<Logradouro>Rua Santo Antonio</Logradouro>
<NumeroLogradouro>455</NumeroLogradouro>
<ComplementoEndereco>Condom</ComplementoEndereco>
<Bairro>Jardim Primavera</Bairro>
<Municipio>ITUPEVA</Municipio>
<Estado>SP</Estado>
<Cep>13295000</Cep>
<TipoLocalEntrega>tleeResidencial</TipoLocalEntrega>
<ReferenciaEndereco>Rua da Igreja Santo
Antonio</ReferenciaEndereco>
<EndCodigoIBGE>3524006</EndCodigoIBGE>
</Endereco>
<SubRegiao>SUB-REGIO</SubRegiao>
<CategoriaFiscal>CONSUMIDOR</CategoriaFiscal>
<CodigoCliForAbacos>1003</CodigoCliForAbacos>
<CodigoClassificacaoCliFor>8</CodigoClassificacaoCliFor>
<CodigoRamoAtividade>1</CodigoRamoAtividade>
<CodigoSubRegiao>1</CodigoSubRegiao>
<CodigoRegiao>1</CodigoRegiao>
<RamoAtividade>RAMO DE ATIVIDADE -</RamoAtividade>
<Regiao>.REGIO</Regiao>
<TipoCliFor>tcfCliente</TipoCliFor>
<DataUltimaAlteracao/>
<DataInicialOperacao>30122014
00:00:00.000</DataInicialOperacao>
<DataDesativacao/>
<DataRevisaoCadastro/>
<NumeroSuframa/>
<NumeroIbama/>
<LocalizadoZonaFranca>false</LocalizadoZonaFranca>
<CodigoCategoriaFiscal>1</CodigoCategoriaFiscal>
<Cnae/>
<EnderecoCobranca>
<Logradouro>Rua Santo Antonio</Logradouro>
<NumeroLogradouro>455</NumeroLogradouro>
<ComplementoEndereco>Condom</ComplementoEndereco>
<Bairro>Jardim Primavera</Bairro>
<Municipio>ITUPEVA</Municipio>

www.kpl.com.br Pgina 121 de 186

Verso: 2.0 KPL ENTERPRISE

<Estado>SP</Estado>
<Cep>13295000</Cep>
<TipoLocalEntrega>tleeResidencial</TipoLocalEntrega>
<ReferenciaEndereco>Rua da Igreja</ReferenciaEndereco>
<EndCodigoIBGE>3524006</EndCodigoIBGE>
</EnderecoCobranca>
<EnderecoEntrega>
<Logradouro>Rua Santo Antonio</Logradouro>
<NumeroLogradouro>455</NumeroLogradouro>
<ComplementoEndereco>Condom</ComplementoEndereco>
<Bairro>Jardim Primavera</Bairro>
<Municipio>ITUPEVA</Municipio>
<Estado>SP</Estado>
<Cep>13295000</Cep>
<TipoLocalEntrega>tleeResidencial</TipoLocalEntrega>
<ReferenciaEndereco>Rua da Igreja</ReferenciaEndereco>
<EndCodigoIBGE>3524006</EndCodigoIBGE>
</EnderecoEntrega>
</DadosCliFor>
</Rows>
</DadosCliFor>
<ListaPresenteItensWeb>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operao "Itens da lista de presente On-line" efetuada
com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosListaPresenteItensWeb>
<CodigoItem>3</CodigoItem>
<CodigoProdutoAbacos>6082</CodigoProdutoAbacos>
<CodigoProduto>17228</CodigoProduto>
<QuantidadeSolicitada>10</QuantidadeSolicitada>
<QuantidadeComprada>0</QuantidadeComprada>
</DadosListaPresenteItensWeb>
</Rows>
</ListaPresenteItensWeb>
<CodigoCliFor>1003</CodigoCliFor>
</DadosListaPresenteDisponiveisWeb>
</Rows>
</ListaPresenteDisponiveisResult>
</ListaPresenteDisponiveisResponse>
</soap:Body>
</soap:Envelope>

2.34.6 Regras de negcio

2.34.7 Perguntas frequentes

2.34.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 122 de 186

Verso: 2.0 KPL ENTERPRISE

2.35 MarcasDisponiveis

2.35.1 Conceito

O mtodo MarcasDisponiveis foi desenvolvido para disponibilizar as marcas de produtos disponveis para
integrao.

2.35.2 Objetivo

Atravs desse mtodo possvel obter as informaes de marcas de produtos que esto disponveis para
integrao.

2.35.3 Pr-requisitos

A informao se torna disponvel para integrao quando ocorre uma incluso, alterao ou excluso de
alguma informao.

Ativar replicao de sada

Deve ser habilitada na interface a replicao de sada das marcas.

www.kpl.com.br Pgina 123 de 186

Verso: 2.0 KPL ENTERPRISE

2.35.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ChaveIdentificacao String 36 Identificao nica da interface

LAYOUT RESPONSE
Campo Tipo Max Descrio
MarcasDisponiveisResult
VersaoWebService String 10 Verso do Webservice
ResultadoOperacao
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro
Rows
DadosMarcasProdutos
ProtocoloMarca String 255 Protocolo marca
Acao String - Valores disponveis: 1.3 enumAcao
Nome Char 50 Nome
CodigoExternoMarca String 50 Cdigo externo marca
CodigoMarca Int - Cdigo marca
Ativo Bool - Ativo ou no ativo

2.35.5 XML de exemplo

5) Criao de uma nova marca.

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

www.kpl.com.br Pgina 124 de 186

Verso: 2.0 KPL ENTERPRISE

6) Retorno do mtodo com a classe alterada.

2.35.6 Regras de negcio

2.35.7 Perguntas frequentes

2.35.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 125 de 186

Verso: 2.0 KPL ENTERPRISE

2.36 MonitoriaIntegracao

2.36.1 Conceito

O mtodo MonitoriaIntegracao foi desenvolvido para disponibilizar a situao das integraes

configuradasno KPL.

2.36.2 Objetivo

Atravs desse mtodo possvel obter as informaes de registros pendentes de integrao, se a interface
esta ativa ou no.

2.36.3 Pr-requisitos

A interface deve estar configurada no KPL.

2.36.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ChaveIdentificacao String 36 Identificao nica da interface

2.36.5 XML de exemplo

1) Execuo do mtodo para monitorar as integraes.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:abac="http://www.kplsolucoes.com.br/ABACOSWebService">
<soapenv:Header/>
<soapenv:Body>
<abac:MonitoriaIntegracao>

<abac:ChaveIdentificacao>55E37A67-3B01-4BB0-AD42-
2C384A7C4D87</abac:ChaveIdentificacao>
</abac:MonitoriaIntegracao>
</soapenv:Body>
www.kpl.com.br Pgina 126 de 186
Verso: 2.0 KPL ENTERPRISE

</soapenv:Envelope>

2) \Retorno do mtodo com a situao das integraes.

<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>
<MonitoriaIntegracaoResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebService">
<MonitoriaIntegracaoResult>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operao "Listar processo de monitoria de integrao" efetuada
com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<VersaoWebService>5.99.0.8257</VersaoWebService>
<Rows>
<DadosMonitoriaIntegracao>
<Codigo>3</Codigo>
<TipoIntegracao>Produto</TipoIntegracao>
<CodigoInterface>10</CodigoInterface>
<Interface>ATG - Replicao de dados</Interface>
<TipoInterface>KPL - Web Services - Plataforma</TipoInterface>
<InterfaceAtiva>Sim</InterfaceAtiva>
<ReplicacaoAtiva>Sim</ReplicacaoAtiva>
<QtdeRegistrosPendentes>11871</QtdeRegistrosPendentes>
<UltimoRegistroReplicado>2017-02-
24T11:32:51.513</UltimoRegistroReplicado>
<DataUltimaConfirmacao xsi:nil="true"/>
</DadosMonitoriaIntegracao>
<DadosMonitoriaIntegracao>
<Codigo>5</Codigo>
<TipoIntegracao>Preco</TipoIntegracao>
<CodigoInterface>10</CodigoInterface>
<Interface>ATG - Replicao de dados</Interface>
<TipoInterface>KPL - Web Services - Plataforma</TipoInterface>
<InterfaceAtiva>Sim</InterfaceAtiva>
<ReplicacaoAtiva>Sim</ReplicacaoAtiva>
<QtdeRegistrosPendentes>10054</QtdeRegistrosPendentes>
<UltimoRegistroReplicado>2017-02-
24T11:32:44.137</UltimoRegistroReplicado>
<DataUltimaConfirmacao xsi:nil="true"/>
</DadosMonitoriaIntegracao>
<DadosMonitoriaIntegracao>
<Codigo>7</Codigo>
<TipoIntegracao>Estoque</TipoIntegracao>
<CodigoInterface>10</CodigoInterface>
<Interface>ATG - Replicao de dados</Interface>
<TipoInterface>KPL - Web Services - Plataforma</TipoInterface>
<InterfaceAtiva>Sim</InterfaceAtiva>
<ReplicacaoAtiva>Sim</ReplicacaoAtiva>
<QtdeRegistrosPendentes>10803</QtdeRegistrosPendentes>
<UltimoRegistroReplicado>2017-03-
09T14:33:32.423</UltimoRegistroReplicado>
<DataUltimaConfirmacao xsi:nil="true"/>
</DadosMonitoriaIntegracao>
<DadosMonitoriaIntegracao>
<Codigo>12</Codigo>
<TipoIntegracao>Status pedido</TipoIntegracao>
<CodigoInterface>10</CodigoInterface>
<Interface>ATG - Replicao de dados</Interface>
<TipoInterface>KPL - Web Services - Plataforma</TipoInterface>
<InterfaceAtiva>Sim</InterfaceAtiva>
<ReplicacaoAtiva>Sim</ReplicacaoAtiva>

www.kpl.com.br Pgina 127 de 186

Verso: 2.0 KPL ENTERPRISE

2.36.6 Regras de negcio

2.36.7 Perguntas frequentes

2.36.8 Histrico de alteraes

Verso Histrico
99R107 Criao do mtodo.

www.kpl.com.br Pgina 128 de 186

Verso: 2.0 KPL ENTERPRISE

2.37 PagamentoPedidoDisponivel

2.37.1 Conceito

O mtodo PagamentoPedidoDisponivel foi desenvolvido para permitir consultar o (s) pagamento (s)
relacionado (s) ao pedido de venda no KPL.

2.37.2 Objetivo

Este mtodo deve ser utilizado para obter o (s) pagamento (s) relacionados ao pedido, inclusive a
informao CodigoPagamentoque necessria ser informada no mtodo para confirmar o pagamento.
Esse mtodo s possvel ser utilizado para pedidos inseridos via API (WSPlataforma.InserirPedido).

2.37.3 Pr-requisitos

O pedido tem que existir na base de dados e estar no estgio de aguardando confirmao do pagamento.

2.37.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
PagamentoPedidoDisponivel
ChaveIdentificacao String 36 Identificao nica da interface
ListaDeCodigosPedido
DadosPagamentos
CodigoPedido String 50 Nmero do pedido

LAYOUT RESPONSE
Campo Tipo Max Descrio
PagamentoPedidoDisponivelResult
VersaoWebService String Verso do WebService
ResultadoOperacao
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
Rows
DadosPagamentosResultado
CodigoPedido String 50 Nmero do pedido
CodigoPagamento String 50 Cdigo do pagamento
FormaPagamento String 50 Forma de pagamento
ValorCobrado Double - Valor cobrado no pagamento

2.37.5 XML de exemplo

1) Incluso do pedido via WSPlataforma.InserirPedido.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:abac="http://www.kplsolucoes.com.br/ABACOSWebService">
<soapenv:Header/>
<soapenv:Body>
<abac:InserirPedido>
<abac:ChaveIdentificacao>55E37A67-3B01-4BB0-AD42-
2C384A7C4D87</abac:ChaveIdentificacao>
<abac:ListaDePedidos>

www.kpl.com.br Pgina 129 de 186

Verso: 2.0 KPL ENTERPRISE

<abac:DadosPedidos>
<abac:NumeroDoPedido>2017030806</abac:NumeroDoPedido>
<abac:EMail>integracao@kpl.com.br</abac:EMail>
<abac:CPFouCNPJ>05521031000101</abac:CPFouCNPJ>
<abac:CodigoCliente>KPL</abac:CodigoCliente>
<abac:ValorPedido>350</abac:ValorPedido>
<abac:ValorFrete>0</abac:ValorFrete>
<abac:ValorEncargos>0</abac:ValorEncargos>
<abac:ValorDesconto>0</abac:ValorDesconto>
<abac:ValorEmbalagemPresente>0</abac:ValorEmbalagemPresente>
<abac:DataVenda>14012016</abac:DataVenda>
<abac:Transportadora>CORREIOS-PAC</abac:Transportadora>
<abac:EmitirNotaSimbolica>false</abac:EmitirNotaSimbolica>
<abac:ValorCupomDesconto>0</abac:ValorCupomDesconto>
<abac:NumeroCupomDesconto>0</abac:NumeroCupomDesconto>
<abac:DestNome>KPL</abac:DestNome>
<abac:DestSexo>F</abac:DestSexo>
<abac:DestEmail>integracao@kpl.com.br</abac:DestEmail>
<abac:DestTelefone>21879090</abac:DestTelefone>
<abac:DestLogradouro>Alameda Cauaxi</abac:DestLogradouro>
<abac:DestNumeroLogradouro>350</abac:DestNumeroLogradouro>
<abac:DestComplementoEndereco>5 andar</abac:DestComplementoEndereco>
<abac:DestBairro>Alphaville</abac:DestBairro>
<abac:DestMunicipio>Barueri</abac:DestMunicipio>
<abac:DestEstado>SP</abac:DestEstado>
<abac:DestCep>06454020</abac:DestCep>
<abac:DestTipoLocalEntrega>tleeComercial</abac:DestTipoLocalEntrega>
<abac:DestEstrangeiro>N</abac:DestEstrangeiro>
<abac:DestPais>Brasil</abac:DestPais>
<abac:DestCPF>05521031000101</abac:DestCPF>
<abac:DestTipoPessoa>tpeJuridica</abac:DestTipoPessoa>
<abac:Anotacao1>Integracao</abac:Anotacao1>
<abac:PedidoJaPago>false</abac:PedidoJaPago>
<abac:DataDoPagamento>14012016</abac:DataDoPagamento>
<abac:FormasDePagamento>
<abac:DadosPedidosFormaPgto>
<abac:FormaPagamentoCodigo>VISA</abac:FormaPagamentoCodigo>
<abac:Valor>100</abac:Valor>
<abac:CartaoNumero>4012001037141112</abac:CartaoNumero>
<abac:CartaoCodigoSeguranca>123</abac:CartaoCodigoSeguranca>
<abac:CartaoValidade>122015</abac:CartaoValidade>
<abac:CartaoNomeImpresso>KPL Solucoes</abac:CartaoNomeImpresso>
<abac:CartaoQtdeParcelas>1</abac:CartaoQtdeParcelas>
<abac:CartaoCodigoAutorizacao>4444444444</abac:CartaoCodigoAutorizacao>
<abac:CartaoCPFouCNPJTitular>05521031000101</abac:CartaoCPFouCNPJTitular>
<abac:CartaoDataNascimentoTitular>16041989</abac:CartaoDataNascimentoTitular>
<abac:PreAutorizadaNaPlataforma>false</abac:PreAutorizadaNaPlataforma>
<abac:CartaoTID>1111111</abac:CartaoTID>
<abac:CartaoNSU>2222222</abac:CartaoNSU>
<abac:CartaoNumeroToken>3333333</abac:CartaoNumeroToken>
<abac:CodigoTransacaoGateway>001</abac:CodigoTransacaoGateway>
</abac:DadosPedidosFormaPgto>
<abac:DadosPedidosFormaPgto>
<abac:FormaPagamentoCodigo>MASTERCARD</abac:FormaPagamentoCodigo>
<abac:Valor>250</abac:Valor>
<abac:CartaoNumero>4012001037141112</abac:CartaoNumero>
<abac:CartaoCodigoSeguranca>123</abac:CartaoCodigoSeguranca>
www.kpl.com.br Pgina 130 de 186
Verso: 2.0 KPL ENTERPRISE

<abac:CartaoValidade>122015</abac:CartaoValidade>
<abac:CartaoNomeImpresso>KPL Solucoes</abac:CartaoNomeImpresso>
<abac:CartaoQtdeParcelas>1</abac:CartaoQtdeParcelas>
<abac:CartaoCodigoAutorizacao>4444444444</abac:CartaoCodigoAutorizacao>
<abac:CartaoCPFouCNPJTitular>05521031000101</abac:CartaoCPFouCNPJTitular>
<abac:CartaoDataNascimentoTitular>16041989</abac:CartaoDataNascimentoTitular>
<abac:PreAutorizadaNaPlataforma>false</abac:PreAutorizadaNaPlataforma>
<abac:CartaoTID>1111111</abac:CartaoTID>
<abac:CartaoNSU>2222222</abac:CartaoNSU>
<abac:CartaoNumeroToken>3333333</abac:CartaoNumeroToken>
<abac:CodigoTransacaoGateway>001</abac:CodigoTransacaoGateway>
</abac:DadosPedidosFormaPgto>
</abac:FormasDePagamento>
<abac:Itens>
<abac:DadosPedidosItem>
<abac:CodigoProduto>AK00002697</abac:CodigoProduto>
<abac:QuantidadeProduto>1</abac:QuantidadeProduto>
<abac:PrecoUnitario>350</abac:PrecoUnitario>
<abac:EmbalagemPresente>false</abac:EmbalagemPresente>
<abac:MensagemPresente/>
<abac:PrecoUnitarioBruto>28</abac:PrecoUnitarioBruto>
<abac:Brinde>false</abac:Brinde>
</abac:DadosPedidosItem>
</abac:Itens>
<abac:OptouNFPaulista>tbneNao</abac:OptouNFPaulista>
<abac:ValorTotalCartaoPresente>0</abac:ValorTotalCartaoPresente>
<abac:CartaoPresenteBrinde>false</abac:CartaoPresenteBrinde>
</abac:DadosPedidos>
</abac:ListaDePedidos>
</abac:InserirPedido>
</soapenv:Body>
</soapenv:Envelope>

2) Aps a inluso do pedido, foi executado o mtodo para obter a (s) forma (s) de pagamento disponvel (is).

RESPONSE
<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>
<PagamentoPedidoDisponivelResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebService">
<PagamentoPedidoDisponivelResult>
www.kpl.com.br Pgina 131 de 186
Verso: 2.0 KPL ENTERPRISE

<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<VersaoWebService>5.99.0.8257</VersaoWebService>
<Rows>
<DadosPagamentosResultado>
<CodigoPedido>2017030806</CodigoPedido>
<CodigoPagamento>85671</CodigoPagamento>
<FormaPagamento>MASTERCARD</FormaPagamento>
<ValorCobrado>250</ValorCobrado>
</DadosPagamentosResultado>
<DadosPagamentosResultado>
<CodigoPedido>2017030806</CodigoPedido>
<CodigoPagamento>85671</CodigoPagamento>
<FormaPagamento>VISA</FormaPagamento>
<ValorCobrado>100</ValorCobrado>
</DadosPagamentosResultado>
</Rows>
</PagamentoPedidoDisponivelResult>
</PagamentoPedidoDisponivelResponse>
</soap:Body>
</soap:Envelope>

2.37.6 Regras de negcio

2.37.7 Perguntas frequentes

2.37.3 Histrico de alteraes

Verso Histrico
99R107 Criao do mtodo.

www.kpl.com.br Pgina 132 de 186

Verso: 2.0 KPL ENTERPRISE

2.38 PedidoExiste

2.38.1 Conceito

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

2.38.2 Objetivo

Atravs desse mtodo possvel identificar se o pedido j foi cadastrado no KPL.

2.38.3 Pr-requisitos

No se aplica.

2.38.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ChaveIdentificacao String 36 Identificao nica da interface
ListaDeNumerosDePedidos
String String 50 Numero externo do pedido

LAYOUT RESPONSE
Campo Tipo Max Descrio
PedidoExisteResult
VersaoWebService String 10 Verso do webservice
ResultadoOperacao
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Tipo String - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro
Rows
DadosPedidosExistentes
NumeroDoPedido String 50 Nmero do pedido
Existente Bool - Pedido existe?
StatusAtual String - Valores disponveis: 1.12 enumStatusAtual
StatusPedido Char 50 Status do pedido
Resultado
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo

www.kpl.com.br Pgina 133 de 186

Verso: 2.0 KPL ENTERPRISE

2.38.5 XML de exemplo

1) Execuo do mtodo para verificar se o pedido 1401 existe.

www.kpl.com.br Pgina 134 de 186

Verso: 2.0 KPL ENTERPRISE

<Codigo>200002</Codigo>
<Descricao>OK.</Descricao>
<Tipo>tdreSucesso</Tipo>
</Resultado>
</DadosPedidosExistentes>
</Rows>
</PedidoExisteResult>
</PedidoExisteResponse>
</soap:Body>
</soap:Envelope>

2.38.6 Regras de negcio

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

2.38.7 Perguntas frequentes

2.38.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 135 de 186

Verso: 2.0 KPL ENTERPRISE

2.39 PedidosDisponiveis

2.39.1 Conceito

O mtodo PedidosDisponiveis foi desenvolvido para disponibilizar as informaes de pedidos para

integrao.

2.39.2 Objetivo

Atravs desse mtodo possvel obter as informaes de pedidos de venda que esto disponveis para
integrao.

2.39.3 Pr-requisitos

A informao se torna disponvel para integrao quando ocorre uma incluso, alterao ou excluso de
alguma informao.

Ativar replicao na interface

Ativar a replicao no cadastro da interface.

www.kpl.com.br Pgina 136 de 186

Verso: 2.0 KPL ENTERPRISE

Habilitar comercializao para integrao

Habilitar no cadastro de interface as comercializaes para integrao.

Habilitar grupo de comercializao para integrao

Habilitar no cadastro de interface os grupos de comercializao para integrao.

www.kpl.com.br Pgina 137 de 186

Verso: 2.0 KPL ENTERPRISE

Definir na interface pontos de replicao do pedido

Configurar no cadastro de interface os pontos de replicao do pedido.

Configurar lista de origens para integrao

Configurar no cadastro da interface as origens para integrao do pedido de venda.

www.kpl.com.br Pgina 138 de 186

Verso: 2.0 KPL ENTERPRISE

Habilitar unidades de negcio para integrao

Habilitar no cadastro da interface as unidades de negcio para integrao.

2.39.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ChaveIdentificacao String 36 Identificao nica da interface

LAYOUT RESPONSE
Campo Tipo Max Descrio
PedidosDisponiveisResult
VersaoWebService String 10 Verso do WebService
ResultadoOperacao
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
Rows
DadosPedidosDisponiveisWeb
CodigoPedidoAbacos Int - Nmero que identifica o pedido de venda no KPL
NumeroDoPedido String 50 Cdigo externo que identifica o pedido no KPL
SequencialNumeroPedido Int - Sequencial do nmero do pedido. Este campo compe a
chave do pedido, juntamente com a Unidade de Negcio
ProtocoloPedido String 255 Protocolo para confirmao do recebimento do pedido
Comercializacao Char 50 Nome da comercializao
GrupoComercializacao Char 50 Grupo da comercializao
StatusPedido Char 50 Status em que o Pedido foi replicado
Acao String - Valores disponveis: 1.3 enumAcao
PedidoWeb
DadosPedidoWeb

www.kpl.com.br Pgina 139 de 186

Verso: 2.0 KPL ENTERPRISE

CodigoPedido Int - Cdigo interno do pedido de venda

NumeroPedido String 50 Cdigo externo do pedido de venda

CodigoUnidadeNegocio Int - Nmero que identifica o pedido de venda no KPL
EMail String 100 E-mail do cliente
CodigoCliente Int - Cdigo interno do cliente
ClienteCPFouCNPJ Char 14 CPF ou CNPJ do cliente
RepresentanteVendas Int - Cdigo 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
CodigoTransportadora String 50 Cdigo da transportadora
Transportadora String 20 Nome fantasia da transportadora
ServicoEntrega Char 50 Descrio do servio de entrega
CodigoLocalRetirada String 50 Cdigo do local de retirada
SenhaRetirada String 100 Senha de retirada
TransportadoraCNPJ Char 14 CNPJ da transportadora
Canal Char 50 Canal
SubCanal Char 50 SubCanal
DestNome Char 100 Razo Social do Destinatrio
DestEndereco String 88 Logradouro + o nmero + complemento
DestEnderecoLogradouro String 80 Logradouro
DestEnderecoNumero Char 6 Numero do endereo
DestEnderecoComplemento String 30 Complemento do endereo
DestBairro String 60 Bairro do destinatrio
DestCep Char 9 CEP do destinatrio
DestMunicipio String 60 Municpio do destinatrio
DestEstado Char 2 UF do destinatrio
DestPais String 50 Nome do pas do destinatrio
DestSexo String - Valores disponveis: 1.5 enumSexo
DestEmail String 100 E-mail do destinatrio
DestTelefone String 15 Numero do telefone do destinatrio
DestTipoPessoa String - Valores disponveis: 1.9 enumTipoPessoa
DestCPFouCNPJ Char 14 CPF ou CNPJ do destinatrio
DestInscricaoEstadual Char 14 Inscrio Estadual do destinatrio
DestInscricaoMunicipal Char 14 Inscrio Municipal do destinatrio
DestCodigoIBGE Int - Cdigo IBGE
PreVenda Bool - Pr-Venda?
TipoFrete Char 50 Tipo de frete
PedidoItens
DadosPedidoItensWeb
CodigoItem Int - Nmero que identifica o item do pedido no KPL
CodigoProdutoAbacos Int - Cdigo interno do produto
CodigoProduto String 50 Cdigo externo do produto
Quantidade Float - Quantidade do item no pedido
PrecoUnitarioLiquido Float - Preo Unitrio Liquido
PrecoUnitarioBruto Float - Preo Unitrio Bruto
QuantidadeReservada Float - Quantidade reservada do item
PersonalizacaoNome String 100 Descrio da personalizao do item
PersonalizacaoTexto Text - Texto da personalizao do item
NomeProduto Char 50 Descrio do item (produto)
NomeComposto String 200 Nome composto do produto

www.kpl.com.br Pgina 140 de 186

Verso: 2.0 KPL ENTERPRISE

CodigoBarras String 50 Cdigo de barras do produto

Classe Char 50 Descrio da classe do item
CodigoRastreabilidade String 30 Cdigo da rastreabilidade do item
DataValidade Datetime - Data de validade do item no formato: AAAAMMDD
HH:NN:SS
DataVencimentoGarantia Datetime - Data de vencimento da garantia do item no formato:
AAAAMMDD HH:NN:SS
PreVenda Char 1 Pr-venda? Informar [S] Sim | [N] No
PedidoPagamento
DadosPedidoPagamentoWeb
CodigoPagamentoAbacos Int - Cdigo interno do pagamento no KPL.
FormaPagamentoCodigo Int - O cdigo passado na forma de pagamento pode ser
qualquer formato desejado. Basta configurar previamente
no KPL o "DE/PARA" para que os pedidos possam ser
includos normalmente
FormaPagamento Char 50 A descrio passada na forma de pagamento pode ser
qualquer formato desejado. Basta configurar previamente
no KPL o "DE/PARA" para que os pedidos possam ser
includos normalmente
TipoFormaPagamentoSigla Char 2 Sigla da forma de pagamento
Valor Float - Valor cobrado pelo pedido
ValorPago Float - Valor pago pelo pedido
DataPagamento Datetime - Data do pagamento

2.39.5 XML de exemplo

1) Habilitao da comercializao no cadastro da interface.

www.kpl.com.br Pgina 141 de 186

Verso: 2.0 KPL ENTERPRISE

2) Habilitao do grupo de comercializao no cadastro da interface.

3) Habilitao das unidade de negcio no cadastro da interface.

4) Execuo do mtodo para obter os pedidos disponveis para integrao.

www.kpl.com.br Pgina 142 de 186

Verso: 2.0 KPL ENTERPRISE

38028E20D5AA</abac:ChaveIdentificacao>
</abac:PedidosDisponiveis>
</soapenv:Body>
</soapenv:Envelope>

RESPONSE
<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.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>100001</Codigo>
<Descricao>Ocorreram erros durante a obteno das informaes pertinentes
a lista de itens. Verifique o retorno em cada item para maiores detalhes.</Descricao>
<Tipo>tdreAlerta</Tipo>
</ResultadoOperacao>
<Rows>
<DadosPedidosDisponiveisWeb>
<CodigoPedidoAbacos>71</CodigoPedidoAbacos>
<NumeroDoPedido>13837</NumeroDoPedido>
<SequencialNumeroPedido>0</SequencialNumeroPedido>
<ProtocoloPedido>B8E0FE10-7257-4C11-A4DB-8515ED883154</ProtocoloPedido>
<Comercializacao>VENDA DE PRODUTOS</Comercializacao>
<GrupoComercializacao>VENDA</GrupoComercializacao>
<StatusPedido>ENTREGUE</StatusPedido>
<Acao>aieManutencao</Acao>
<PedidoWeb>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operao "Pedidos On-line" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosPedidoWeb>
<CodigoPedido>71</CodigoPedido>
<NumeroPedido>13837</NumeroPedido>
<CodigoUnidadeNegocio>1</CodigoUnidadeNegocio>
<EMail>email@email.com</EMail>
<CodigoCliente>105</CodigoCliente>
<ClienteCPFouCNPJ>00034028088895</ClienteCPFouCNPJ>
<RepresentanteVendas>1</RepresentanteVendas>
<ValorPedido>214.2</ValorPedido>
<ValorFrete>18.76</ValorFrete>
<ValorEncargos>0</ValorEncargos>
<ValorDesconto>0</ValorDesconto>
<DataVenda>19072012 17:30:00.000</DataVenda>
<CodigoTransportadora>3</CodigoTransportadora>
<Transportadora>CORREIOS</Transportadora>
<ServicoEntrega>SEDEX</ServicoEntrega>
<CodigoLocalRetirada/>
<SenhaRetirada/>
<TransportadoraCNPJ>68945153000226</TransportadoraCNPJ>
<Canal/>
<SubCanal/>
<DestNome>Diego da Silva Brz</DestNome>
<DestEndereco>Rua Luiz Remdio, 69 Casa</DestEndereco>
<DestEnderecoLogradouro>Rua Luiz
Remdio</DestEnderecoLogradouro>
<DestEnderecoNumero>69</DestEnderecoNumero>
<DestEnderecoComplemento>Casa</DestEnderecoComplemento>
<DestBairro>Vila Rosina</DestBairro>
<DestCep>07700-000</DestCep>
www.kpl.com.br Pgina 143 de 186
Verso: 2.0 KPL ENTERPRISE

<DestMunicipio>CAIEIRAS</DestMunicipio>
<DestEstado>SP</DestEstado>
<DestPais>BRASIL</DestPais>
<DestSexo>M</DestSexo>
<DestEmail>email@email.com</DestEmail>
<DestTelefone>(11) 9125-7868</DestTelefone>
<DestTipoPessoa>F</DestTipoPessoa>
<DestCPFouCNPJ>00034028088895</DestCPFouCNPJ>
<DestInscricaoEstadual>ISENTO</DestInscricaoEstadual>
<DestInscricaoMunicipal/>
<DestCodigoIBGE>3509007</DestCodigoIBGE>
<PreVenda>No</PreVenda>
<TipoFrete/>
</DadosPedidoWeb>
</Rows>
</PedidoWeb>
<PedidoItens>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>300002</Codigo>
<Descricao>Erro na obteno dos dados para a integrao. Origem
"Itens do pedido On-line".</Descricao>
<Tipo>tdreErroDataBase</Tipo>
<ExceptionMessage>A coluna 'CodigoRastreabilidade' no pertence
tabela TCOM_PERITE.</ExceptionMessage>
</ResultadoOperacao>
<Rows>
<DadosPedidoItensWeb>
<CodigoItem>82</CodigoItem>
<CodigoProdutoAbacos>32</CodigoProdutoAbacos>
<CodigoProduto>769</CodigoProduto>
<Quantidade>6</Quantidade>
<PrecoUnitarioLiquido>23.9</PrecoUnitarioLiquido>
<PrecoUnitarioBruto>23.9</PrecoUnitarioBruto>
<QuantidadeReservada>0</QuantidadeReservada>
<PersonalizacaoNome/>
<PersonalizacaoTexto/>
<NomeProduto>Bola Futebol Wilson Club Sries
WTH8435</NomeProduto>
<NomeComposto>Bola Futebol Wilson Club Sries
WTH8435</NomeComposto>
<CodigoBarras>0883813059737</CodigoBarras>
<Classe>CLASSE</Classe>
</DadosPedidoItensWeb>
</Rows>
</PedidoItens>
<PedidoPagamento>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operao "Pagamentos do pedido On-line" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosPedidoPagamentoWeb>
<CodigoPagamentoAbacos>69</CodigoPagamentoAbacos>
<FormaPagamentoCodigo>2</FormaPagamentoCodigo>
<FormaPagamento>MASTERCARD</FormaPagamento>
<TipoFormaPagamentoSigla>CA</TipoFormaPagamentoSigla>
<Valor>231.96</Valor>
<ValorPago>231.96</ValorPago>
<DataPagamento>19072012 17:30:00.000</DataPagamento>
</DadosPedidoPagamentoWeb>
</Rows>
</PedidoPagamento>
</DadosPedidosDisponiveisWeb>

www.kpl.com.br Pgina 144 de 186

Verso: 2.0 KPL ENTERPRISE

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

2.39.6 Regras de negcio

2.39.7 Perguntas frequentes

2.39.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 145 de 186

Verso: 2.0 KPL ENTERPRISE

2.40 StatusPedidoDisponiveis

2.40.1 Conceito

O mtodo StatusPedidoDisponiveis foi desenvolvido para disponibilizar as alteraes nos status dos pedidos.

2.40.2 Objetivo

Atravs desse mtodo possvel obter os status dos pedidos que esto disponveis para a integrao.

2.40.3 Pr-requisitos

A informao se torna disponvel para integrao quando ocorre alguma alterao no status do pedido.

Ativar replicao na interface

Ativar a replicao no cadastro da interface.

www.kpl.com.br Pgina 146 de 186

Verso: 2.0 KPL ENTERPRISE

Configurar na interface os status que sero integrados

necessrio configurar no cadastro da interface os status que sero integrados. Caso o status no esteja
cadastrado, o mesmo no ser disponibilizado para integrao.

2.40.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ChaveIdentificacao String 36 Identificao nica da interface

LAYOUT RESPONSE
Campo Tipo Max Descrio
StatusPedidoDisponiveisResult
VersaoWebService String 10 Verso do webservice
ResultadoOperacao
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro
Rows
DadosStatusPedido
ProtocoloStatusPedido String 255 Protocolo status pedido
NumeroPedido String 50 Nmero do pedido
CodigoPedidoAbacos Int - Cdigo do pedido no KPL
CodigoStatus String 15 Cdigo status
StatusPedido String 100 Status do pedido
DataHora Datetime - Data e hora
SerieNota Char 3 Serie da nota
NumeroNota Int - Nmero da nota
DataEmissaoNota Datetime - Data de emisso da nota
NumeroObjeto String 20 Nmero do objeto
QuantidadeVolumes Int - Quantidade volumes

www.kpl.com.br Pgina 147 de 186

Verso: 2.0 KPL ENTERPRISE

CodigoMotivoCancelamento Int - Cdigo do motivo de cancelamento

MotivoCancelamento String 50 Motivo do cancelamento
ChaveNfe String 50 Chave da Nota fiscal eletrnica

2.40.5 XML de exemplo

1) Foi configurado na interface um novo status para ser integrado FATURADO.

2) No momento em que o pedido ficou com o status FATURADO, foi executado o mtodo para verificar
os status disponveis para integrao.

www.kpl.com.br Pgina 148 de 186

Verso: 2.0 KPL ENTERPRISE

3) XML executado com o retorno dos status disponveis para integrao.

RESPONSE
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<StatusPedidoDisponiveisResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebService">
<StatusPedidoDisponiveisResult>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operao "Fechar a incluso de pedidos" efetuada com
sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosStatusPedido>
<ProtocoloStatusPedido>197EA1CC-612A-4904-A822-
FC82AF602BF7</ProtocoloStatusPedido>
<NumeroPedido>1401</NumeroPedido>
<CodigoPedidoAbacos>5594</CodigoPedidoAbacos>
<CodigoStatus>HOMOLOGACAOSTATUS</CodigoStatus>
<StatusPedido>FATURADO</StatusPedido>
<DataHora>19012016 12:26:47.343</DataHora>
<SerieNota>798</SerieNota>
<NumeroNota>2006</NumeroNota>
<DataEmissaoNota>19012016 12:26:40.897</DataEmissaoNota>
<NumeroObjeto>AD000002845BR</NumeroObjeto>
<QuantidadeVolumes>1</QuantidadeVolumes>
<CodigoMotivoCancelamento/>
<MotivoCancelamento/>
<ChaveNfe>35160120121850000155557980000020061458647981</ChaveNfe>
</DadosStatusPedido>
</Rows>
</StatusPedidoDisponiveisResult>
</StatusPedidoDisponiveisResponse>
</soap:Body>
</soap:Envelope>

2.40.6 Regras de negcio

Podem ser retornados mais de um registro na mesma chamado do mtodo.

www.kpl.com.br Pgina 149 de 186

Verso: 2.0 KPL ENTERPRISE

2.40.7 Perguntas frequentes

2.40.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 150 de 186

Verso: 2.0 KPL ENTERPRISE

2.41 PrecosDisponiveis

2.41.1 Conceito

O mtodo PrecosDisponiveis foi desenvolvido para disponibilizar as informaes de preos de produtos,

disponveis para integrao.

2.41.2 Objetivo

Atravs desse mtodo possvel obter as informaes de preos de produtos que esto disponveis para
integrao.

2.41.3 Pr-requisitos

A informao se torna disponvel para integrao quando ocorre uma incluso, alterao ou excluso de
alguma informao.

Ativar replicao na interface

Ativar a replicao no cadastro da interface.

www.kpl.com.br Pgina 151 de 186

Verso: 2.0 KPL ENTERPRISE

Configurar lista de preo para exportao

Configurar na interface, os cdigos de lista de preo que sero exportadas.

2.41.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ChaveIdentificacao String 36 Identificao nica da interface

LAYOUT RESPONSE
Campo Tipo Max Descrio
PrecosDisponiveisResult
VersaoWebService String 10 Verso do webservice
ResultadoOperacao
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro
Rows
DadosPreco
ProtocoloPreco String 255 Protocolo do preo
CodigoProduto String 50 Cdigo produto
CodigoProdutoPai String 50 Cdigo produto pai
CodigoProdutoAbacos Int - Cdigo produto KPL
NomeLista Char 50 Nome lista
PrecoTabela Float - Preo tabela
PrecoPromocional Float - Preo promocional
DataInicioPromocao Datetime - Data incio da promoo
DataTerminoPromocao Datetime - Data termino da promoo
DescontoMaximoProduto Float - Desconto mximo do produto
CodigoProdutoParceiro String 50 Cdigo externo do produto

www.kpl.com.br Pgina 152 de 186

Verso: 2.0 KPL ENTERPRISE

2.41.5 XML de exemplo

1) Configurao da nova lista de preo para permitir integrao.

2) Criao de uma nova lista de preo no KPL.

www.kpl.com.br Pgina 153 de 186

Verso: 2.0 KPL ENTERPRISE

3) Alterao do preo do item 17228.

4) Execuo do mtodo para retornar os preos disponveis para integrao.

www.kpl.com.br Pgina 154 de 186

Verso: 2.0 KPL ENTERPRISE

2.41.6 Regras de negcio

2.41.8 Perguntas frequentes

2.41.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 155 de 186

Verso: 2.0 KPL ENTERPRISE

2.42 PrecoOnline

2.42.1 Conceito

O mtodo PrecoOnline foi desenvolvido para permitir consultar o preo de determinado produto ou uma
lista de produtos existentes na base de dados do KPL.

2.42.2 Objetivo

Atravs desse mtodo possvel obter o preo de qualquer produto com a posio do momento, ou seja,
obter o preo online.

2.42.3 Pr-requisitos

Pr-requitos descritos no capitulo: 2.38 PrecosDisponiveis

Configurar listas de preos disponveis para acesso online

Devem ser configuradas na interface as listas de preo que permitiro acesso online.

Caso a lista de preo para acesso online no esteja configurada, ser exibida a mensagem abaixo no
momento da integrao: Interface = 57 Produto = 17228 Msg = Lista de precos on-line nao configurada.

www.kpl.com.br Pgina 156 de 186

Verso: 2.0 KPL ENTERPRISE

2.42.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ChaveIdentificacao String 36 Identificao nica da interface
ListaDeCodigosProdutos
string String 50 Cdigo externo do produto

LAYOUT RESPONSE
Campo Tipo Max Descrio
PrecoOnLineResult
VersaoWebService String 10 Verso do webservice
ResultadoOperacao
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
Rows
DadosPrecoResultado
CodigoProduto String 50 Cdigo do produto
CodigoProdutoPai String 50 Cdigo produto pai
PrecoTabela Float - Preo tabela
PrecoPromocional Float - Preo promocional
DataInicioPromocao Datetime - Data incio promoo
DataTerminoPromocao Datetime - Data termino promoo
ProdutoTipoLigacao String - Valores disponveis: 1.7 enumProdutoTipoLigacao
DescontoMaximoProduto Float - Desconto Mximo do produto
Resultado
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro

2.42.5 XML de exemplo

1) Configurao da lista de preo para acesso online.

www.kpl.com.br Pgina 157 de 186

Verso: 2.0 KPL ENTERPRISE

1) Execuo do mtodo para obter o preo online do produto 17228.

www.kpl.com.br Pgina 158 de 186

Verso: 2.0 KPL ENTERPRISE

<Resultado>
<Codigo>200002</Codigo>
<Descricao>OK.</Descricao>
<Tipo>tdreSucesso</Tipo>
</Resultado>
</DadosPrecoResultado>
</Rows>
</PrecoOnLineResult>
</PrecoOnLineResponse>
</soap:Body>
</soap:Envelope>

2.42.6 Regras de negcio

possvel solicitar o preo de um nico produto ou de uma lista.

No retorno do mtodo, todos os produtos que estavam presentes na solicitao so apresentados com
os seus respectivos resultados (sucesso ou erro).

2.42.7 Perguntas frequentes

2.42.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 159 de 186

Verso: 2.0 KPL ENTERPRISE

2.43 ProdutoExiste

2.43.1 Conceito

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

2.43.2 Objetivo

Atravs desse mtodo possvel identificar se o produto j foi cadastrado no KPL.

2.43.3 Pr-requisitos

No se aplica.

2.43.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ChaveIdentificacao String 36 Identificao nica da interface
ListaDeNumerosDeProdutosRows
ListaDeNumerosDeProdutos
CodigoProduto String 50 Cdigo do produto
CodigoProdutoAbacos Int - Cdigo do produto KPL
CodigoBarras String 50 Cdigo de barras do produto

LAYOUT RESPONSE
Campo Tipo Max Descrio
ProdutoExisteResult
VersaoWebService String 10 Verso do webservice
ResultadoOperacao
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
Rows
DadosProdutosExistentes
CodigoProduto String 50 Cdigo do produto
CodigoProdutoAbacos Int - Cdigo do produto KPL
CodigoBarras String 50 Cdigo de barras do produto.
UnidadesNegocio String 100 Lista das siglas das unidades de negcio ativas configuradas
para o produto separadas por vrgula
CodigosInterfaces String 100 Cdigo das interfaces ativas configuradas para o produto
separadas por vrgula
Existente Bool - Indica se o produto existe no KPL
ProdutoAtivo Bool - Indica se o produto esta ativo no KPL
Resultado
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro

www.kpl.com.br Pgina 160 de 186

Verso: 2.0 KPL ENTERPRISE

2.43.5 XML de exemplo

1) Execuo do mtodo para verificar se o produto 17228 existe.

www.kpl.com.br Pgina 161 de 186

Verso: 2.0 KPL ENTERPRISE

<Existente>true</Existente>
<ProdutoAtivo>true</ProdutoAtivo>
<Resultado>
<Codigo>200002</Codigo>
<Descricao>OK.</Descricao>
<Tipo>tdreSucesso</Tipo>
</Resultado>
</DadosProdutosExistentes>
</Rows>
</ProdutoExisteResult>
</ProdutoExisteResponse>
</soap:Body>
</soap:Envelope>

2.43.6 Regras de negcio

Pode ser consultado um produto ou uma lista de produtos em uma nica vez.

2.43.7 Perguntas frequentes

2.43.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 162 de 186

Verso: 2.0 KPL ENTERPRISE

2.44 ProdutosDisponiveis

2.44.1 Conceito

O mtodo ProdutosDisponiveis foi desenvolvido para disponibilizar as alteraes nos produtos.

2.44.2 Objetivo

Atravs desse mtodo possvel obter as informaes dos produtos que esto disponveis para integrao.

2.44.3 Pr-requisitos

A informao se torna disponvel para integrao quando ocorre alguma alterao no cadastro do produto.

Ativar replicao na interface

Ativar a replicao no cadastro da interface.

www.kpl.com.br Pgina 163 de 186

Verso: 2.0 KPL ENTERPRISE

Habilitar o produto na interface

Para que o produto fique disponvel para integrao, necessrio habilita-lo na interface.

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

2.44.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ChaveIdentificacao String 36 Identificao nica da interface

LAYOUT RESPONSE
Campo Tipo Max Descrio
ProdutosDisponiveisResult
VersaoWebService String 10 Verso do webservice
ResultadoOperacao
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro
Rows
DadosProdutos
ProtocoloProduto String 36 Protocolo do produto
Acao String - Valores disponveis: 1.3 enumAcao
CodigoProdutoAbacos Int - Cdigo produto KPL
CodigoProduto String 50 Cdigo produto
CodigoProdutoPai String 50 Cdigo produto pai
CodigoBarras String 50 Cdigo barras
CodigoBarrasPai String 50 Cdigo barras pai
TipoProduto String - Valores disponveis: 1.4 enumTipoProduto
NomeProduto String 100 Nome do produto
NomeProdutoReduzido String 50 Nome do produto reduzido
Descricao Text - Descrio
www.kpl.com.br Pgina 164 de 186
Verso: 2.0 KPL ENTERPRISE

CodigoMarca Int - Cdigo da marca

CodigoFabricante String 40 Cdigo do fabricante
CodigoClasse Int - Cdigo damclasse
CodigoExternoClasse String 50 Cdigo externo da classe
CodigoFamilia Int - Cdigo da famlia
CodigoExternoFamilia String 50 Cdigo externo da famlia
CodigoGrupo Int - Cdigo do grupo
CodigoSubGrupo Int - Cdigo do 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 mnima estoque
QtdeMaximaEstoque Float - Quantidade mxima estoque
UnidadeMedidaNome String 50 Nome da unidade de medida
UnidadeMedidaAbrev String 3 Unida de medida abreviada
UnidadeMedidaQuilo String 1 Unidade de medida quilo
ProdutoTemFilhos Bool - Produto tem filhos?
PrazoEntregaDias Int - Prazo de entrega em dias
CampoCfg001 String 255 O campo se estende do 001 ao 020
CampoCfgInt001 String 255 O campo se estende do 001 ao 030
OrigemMercadoria Char 1 Origem mercadoria
CFOPNaoContribuinte Int - CFOP no contribuinte
CFOPContribuinte Int - CFOP contribuinte
UnidadeTributavel Float - Unidade tributvel
CustoDoProduto Float - Custo do produto
CodigoExternoFornecedor String 50 Cdigo externo fornecedor
DescontoMaxProduto Float - Desconto mximo do produto
PreVenda Char 1 Pr-venda
PreVenda_DataInicio Datetime - Data incio pr-venda
PreVenda_DataFinal Datetime - Data final pr-venda
CodigoProdutoParceiro String 50 Cdigo produto parceiro
CodigoProdutoPaiParceiro String 50 Cdigo do produto pai parceiro
DescritorSimples
DadosDescritorSimples
CodigoInterno Int - Cdigo interno no KPL
Numero Int - Nmero do descritor simples: 1, 2 ou 3
Descricao String 100 Descrio/Nome do descritor
DescritorPreDefinido
DadosDescritorPreDefinido
CodigoInterno Int - Cdigo interno no KPL
Numero Int - Nmero do descritor pr-definido:1, 2 ou 3
Descricao String 100 Descrio/Nome do descritor
GrupoCodigo Int - Grupo do descritor pr-definido
GrupoNome Char 50 Nome grupo do descritor pr-definido
AtributosEstendidos
DadosAtributosEstendidos
CodigoAtributo Int - Cdigo do atributo estendido
NomeAtributo String 100 Nome do atributo estendido

www.kpl.com.br Pgina 165 de 186

Verso: 2.0 KPL ENTERPRISE

NomeElemento String 255 Elemento do atributo estendido

TipoDado Char 1 Tipo do dado
CampoValor Float - Valor
Ordenacao Int - Ordenao atributo estendido
CaracteristicasComplementares
DadosCaracteristicasComplementares
CodigoInterno Int - Cdigo interno no KPL
TipoCodigo Int - Tipo cdigo cadastrado no KPL
TipoNome Char 50 Descrio da Caracterstica
TipoGrupoCodigo Int - Tipo grupo cdigo cadastrado no KPL
TipoGrupoNome Char 50 Tipo grupo nome cadastrado no KPL
Texto Text - Texto da Informativo
NrConfigInterface Int - Identifica a descries complementar de 1 a
ProdutosSubstitutos
DadosProdutosSubstitutos
CodigoSubstituto String 50 Cdigo Produto Substituto
CodigoBarrasProdutoSubstituto String 50 Cdigo Barras do Produto Substituto.
IdentificadorProdutoSubstituto String 36 Campo Guid que identifica o produto no sistema
KPL.
Esse node deve ser enviado somente para sistemas
que utilizam os mdulos CENTRAL-LOJA.
CategoriasDoSite
DadosCategoriasDoSite
CodigoCategoria Int - Cdigo da categoria cadastrada no KPL
CodigoCategoriaPai Int - Cdigo da categoria Pai cadastrada no KPL
CodigoExternoCategoria String 50 Cdigo externo categoria
ProdutosPersonalizacao
DadosProdutosPersonalizacao
ClassificacaoPersonalizacao Int - Classificao da personalizao
CodigoProdutoPersonalizacao String 50 Cdigo produto personalizado
CodigoProdutoPersonalizacaoPai String 50 Cdigo produto pai personalizado
ProdutoPersonalizacaoLigacao Char 1 Ligao produto personalizado
ComponentesKit
DadosComponentesKit
CodigoProdutoComponente String 50 Cdigo componente
Quantidade Float - Quantidade
DescritorPreDefinido1 String 100 Descritor pr-definido 1
DescritorPreDefinido2 String 100 Descritor pr-definido 2
DescritorPreDefinido3 String 100 Descritor pr-definido 3
CodigoDescritorPreDefinido1 Int - Cdigo descritor pr-definido 1
CodigoDescritorPreDefinido2 Int - Cdigo descritor pr-definido 2
CodigoDescritorPreDefinido3 Int - Cdigo descritor pr-definido 3
DescritorSimples1 String 50 Descritor simples 1
DescritorSimples2 String 50 Descritor simples2
DescritorSimples3 String 50 Descritor simples 3
Preco Float - Preo
PrecoPromocional Float - Preo promocional
DataInicioPromocao Datetime - Data inicio promoo
DataTerminoPromocao Datetime - Data trmino promoo
www.kpl.com.br Pgina 166 de 186
Verso: 2.0 KPL ENTERPRISE

ProdutosAssociados
DadosProdutosAssociados
CodigoProdutoAbacos Int - Cdigo interno produto
CodigoProduto String 50 Cdigo produto
CodigoBarras String 50 Cdigo de barras
OrdemAssociacao Int - Ordem associao
TipoAssociacao Int - Tipo associao
TipoAssociacaoNome Char 50 Nome tipo associao
TipoCategoria Char 1 Tipo categoria
TipoCategoriaNome String 50 Nome tipo categoria
DescricaoClasse Char 50 Descrio classe
DescricaoMarca Char 50 Descrio marca
DescricaoFamilia Char 50 Descrio famlia
DescricaoGrupo Char 50 Descrio grupo
DescricaoSubgrupo Char 50 Descrio subgrupo
CodigoCategoriaFiscal Int - Cdigo categoria fiscal
CodigoClassificacaoFiscal Int - Cdigo classificao fiscal
ClassificacaoFiscal Char 10 Classificao Fiscal
HarmonizedCode Char 10 Designao internacional da mercadoria
DiasGarantia Int - Dias de garantia
PodeSerBrinde Bool Pode ser brinde?
TipoRastreabilidade Int - Tipo rastreabilidade
TipoControleEstoque String - Valores disponveis: 1.21
enumTipoControleEstoque
ProdutoKit Bool - Produto kit?
EfetuarCheckOut Bool - Efetuar checkout?
DescricaoNotaFiscal Bool - Descrio nota fiscal.
ClassificacaoPersonalizacao String - Valores disponveis: 1.20
enumTPersonalizacaoClassificacao
NaoImprimirEtqEntrada Bool - Imprimir etiqueta de entrada?
DadosLivros
DadosLivros
NomeIdioma Char 50 Nome do idioma pr-cadastrado
NomePais Char 50 Nome do pas pr-cadastrado
DataPublicacao Datetime - Data da publicao
NumeroPaginas Int - Nmero de pginas
Anopublicacao Int - Ano de publicao
ISBN10 String 50 International Standard Book Number (Nmero
padro internacional do livro)
NumeroVolume Int - Nmero do volume
ImpressaoSobDemanda Char 1 Impresso sob demanda. Informar S ou N.
ComplementoEdicao Char 50 Complemento da edio
NomeEncadernacao Char 50 Nome da encadernao
NumeroEdicao Int - Nmero da edio
CodigoEdicaoAnterior Int - Cdigo edio anterior
EdicaoAnterior Int - Edio anterior
DadosColecao
NomeColecao Char 50 Nome da coleo
DadosContribuidor
NomeContribuidor Char 50 Nome do contribuidor
NomeFuncao String 50 Nome da funo
PrincipalFuncao String 50 Principal funo

www.kpl.com.br Pgina 167 de 186

Verso: 2.0 KPL ENTERPRISE

DadosAcompanhamento
NomeAcompanhamento Char 50 Nome do Acompanhamento
PrecoTabela1 Float - Preo tabela 1
PrecoPromocao1 Float - Preo promoo 1
PrecoTabela2 Float - Preo tabela 2
PrecoPromocao2 Float - Preo promoo 2
DadosImagemProduto
FinalidadeImagem Char 50 Finalidade de imagem
Repositorio String 500 Repositrio
ClassificacoesComplementares
DadosClassificacoesComplementares
CodigoGrupoExterno String 50 Cdigo externo do grupo
CodigoGrupoAbacos Int - Cdigo do grupo no KPL
CodigoGrupoPaiAbacos Int - Cdigo grupo do produto pai
DescricaoGrupo String 50 Descrio do grupo
TipoGrupo Char 1 Tipo do grupo
DescricaoOpcao String 50 Descrio da opo
OpcoesClassificacoesComplementares
DadosOpcoesClassificacoesComplementares
CodigoOpcaoExterno String 50 Cdigo externo da opo
CodigoOpcaoAbacos Int - Cdigo da opo no KPL
CodigoOpcaoPaiAbacos Int - Cdigo opo do produto pai
DescricaoOpcao String 50 Descrio da opo
TransportadorasHabilitadas
DadosTransportadorasProduto
CodigoTransportadora Int - Cdigo da transportadora
NomeTransportadora Char 50 Nome da transportadora
CNPJTransportadora Char 14 CNPJ da transportadora
CodigoProdutoPaiAbacos Int - Cdigo do produto pai
ReceitaRequerida Bool - necessrio receita mdica?

2.44.5 XML de exemplo

1) Alteraes realizadas no cadastro do produto.

Incluso da caracterstica complementar.

www.kpl.com.br Pgina 168 de 186

Verso: 2.0 KPL ENTERPRISE

Incluso de descritores pr-definidos e descritores simples.

2) Execuo do mtodo para obter as informaes que esto disponveis para integrao.

RESPONSE
<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>
<ProdutosDisponiveisResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebService">
<ProdutosDisponiveisResult>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>100001</Codigo>
<Descricao>Ocorreram erros durante a obteno das informaes pertinentes
a lista de itens. Verifique o retorno em cada item para maiores detalhes.</Descricao>
<Tipo>tdreAlerta</Tipo>
</ResultadoOperacao>
<Rows>
<DadosProdutos>
<ProtocoloProduto>9391BEF5-198E-481F-BA9C-
B55BB8533E95</ProtocoloProduto>
<Acao>aieManutencao</Acao>
<CodigoProdutoAbacos>6082</CodigoProdutoAbacos>
<CodigoProduto>17228</CodigoProduto>
<CodigoProdutoPai/>
<CodigoBarras>000000000006082</CodigoBarras>
<TipoProduto>tpreProduto</TipoProduto>
<NomeProduto>Egeo Espuma de Barbear</NomeProduto>
<NomeProdutoReduzido>Egeo Espuma de Barbear</NomeProdutoReduzido>
<Descricao>EGEO ESPUMA DE BARBEAR 200ml VS2</Descricao>
<CodigoMarca>40</CodigoMarca>
<CodigoFabricante/>
<CodigoClasse>6</CodigoClasse>
<CodigoExternoClasse/>
<CodigoFamilia>15</CodigoFamilia>
<CodigoExternoFamilia/>
<CodigoGrupo>25</CodigoGrupo>
<CodigoSubGrupo>33</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>
<OrigemMercadoria>0</OrigemMercadoria>
<CFOPNaoContribuinte>0</CFOPNaoContribuinte>
<CFOPContribuinte>0</CFOPContribuinte>
<UnidadeTributavel>0</UnidadeTributavel>
<CustoDoProduto>0</CustoDoProduto>
<CodigoExternoFornecedor/>
<DescontoMaxProduto>0</DescontoMaxProduto>
<PreVenda>No</PreVenda>
<PreVenda_DataInicio/>
<PreVenda_DataFinal/>
<CodigoProdutoParceiro/>
<CodigoProdutoPaiParceiro/>
<DescritorSimples>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operao "Descritores simples associados ao produto"

www.kpl.com.br Pgina 170 de 186

Verso: 2.0 KPL ENTERPRISE

efetuada com sucesso.</Descricao>

<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<rows>
<DadosDescritorSimples>
<CodigoInterno>495</CodigoInterno>
<Numero>1</Numero>
<Descricao>TesteIntegrao1</Descricao>
</DadosDescritorSimples>
<DadosDescritorSimples>
<CodigoInterno>188</CodigoInterno>
<Numero>2</Numero>
<Descricao>TesteIntegrao2</Descricao>
</DadosDescritorSimples>
<DadosDescritorSimples>
<CodigoInterno>159</CodigoInterno>
<Numero>3</Numero>
<Descricao>TesteIntegrao3</Descricao>
</DadosDescritorSimples>
</rows>
</DescritorSimples>
<DescritorPreDefinido>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operao "Descritores pr-definidos associados ao
produto" efetuada com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosDescritorPreDefinido>
<CodigoInterno>78</CodigoInterno>
<Numero>1</Numero>
<Descricao>INTEGRACAO</Descricao>
<GrupoCodigo>9</GrupoCodigo>
<GrupoNome>INTEGRACAOGRUPO</GrupoNome>
</DadosDescritorPreDefinido>
</Rows>
</DescritorPreDefinido>
<AtributosEstendidos>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porm no h dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
<Rows>
<DadosAtributosEstendidos>
<CodigoAtributo>0</CodigoAtributo>
<NomeAtributo/>
<NomeElemento/>
<TipoDado/>
<CampoValor/>
<Ordenacao>0</Ordenacao>
</DadosAtributosEstendidos>
</Rows>
</AtributosEstendidos>
<CaracteristicasComplementares>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operao "Caracteristicas complementares associadas ao
produto" efetuada com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosCaracteristicasComplementares>

www.kpl.com.br Pgina 171 de 186

Verso: 2.0 KPL ENTERPRISE

<CodigoInterno>2742</CodigoInterno>
<TipoCodigo>3</TipoCodigo>
<TipoNome>EXTRA1</TipoNome>
<TipoGrupoCodigo>2</TipoGrupoCodigo>
<TipoGrupoNome>DESCRICAO COMPLEMENTAR</TipoGrupoNome>
<Texto>Teste integrao.</Texto>
<NrConfigInterface>0</NrConfigInterface>
</DadosCaracteristicasComplementares>
</Rows>
</CaracteristicasComplementares>
<ProdutosSubstitutos>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porm no h dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
<Rows>
<DadosProdutosSubstitutos>
<CodigoSubstituto/>
</DadosProdutosSubstitutos>
</Rows>
</ProdutosSubstitutos>
<CategoriasDoSite>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porm no h dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
<Rows>
<DadosCategoriasDoSite>
<CodigoCategoria>0</CodigoCategoria>
<CodigoCategoriaPai>0</CodigoCategoriaPai>
<CodigoExternoCategoria/>
</DadosCategoriasDoSite>
</Rows>
</CategoriasDoSite>
<ProdutosPersonalizacao>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porm no h dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
<Rows>
<DadosProdutosPersonalizacao>
<ClassificacaoPersonalizacao>tpceNenhuma</ClassificacaoPersonalizacao>
<CodigoProdutoPersonalizacao/>
<CodigoProdutoPersonalizacaoPai/>
<ProdutoPersonalizacaoLigacao>tptleIndefinido</ProdutoPersonalizacaoLigacao>
</DadosProdutosPersonalizacao>
</Rows>
</ProdutosPersonalizacao>
<ComponentesKit>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porm no h dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
<Rows>
<DadosComponentesKit>
<CodigoProdutoComponente/>
<Quantidade>0</Quantidade>
<DescritorPreDefinido1/>
<DescritorPreDefinido2/>

www.kpl.com.br Pgina 172 de 186

Verso: 2.0 KPL ENTERPRISE

<DescritorPreDefinido3/>
<CodigoDescritorPreDefinido1/>
<CodigoDescritorPreDefinido2/>
<CodigoDescritorPreDefinido3/>
<DescritorSimples1/>
<DescritorSimples2/>
<DescritorSimples3/>
<Preco>0</Preco>
<PrecoPromocional>0</PrecoPromocional>
<DataInicioPromocao/>
<DataTerminoPromocao/>
</DadosComponentesKit>
</Rows>
</ComponentesKit>
<ProdutosAssociados>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porm no h dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
<Rows>
<DadosProdutosAssociados>
<CodigoProdutoAbacos/>
<CodigoProduto/>
<CodigoBarras/>
<OrdemAssociacao/>
<TipoAssociacao/>
<TipoAssociacaoNome/>
<TipoCategoria/>
<TipoCategoriaNome/>
</DadosProdutosAssociados>
</Rows>
</ProdutosAssociados>
<DescricaoClasse>Barba</DescricaoClasse>
<DescricaoMarca>Everlast</DescricaoMarca>
<DescricaoFamilia>BARBA</DescricaoFamilia>
<DescricaoGrupo>Barbear</DescricaoGrupo>
<DescricaoSubgrupo>Espuma</DescricaoSubgrupo>
<CodigoCategoriaFiscal>1</CodigoCategoriaFiscal>
<CodigoClassificacaoFiscal>0</CodigoClassificacaoFiscal>
<ClassificacaoFiscal/>
<HarmonizedCode/>
<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.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porm no h dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
<Rows>
<DadosLivros>
<NomeIdioma/>
<NomePais/>
<DataPublicacao/>
<NumeroPaginas>0</NumeroPaginas>
<Anopublicacao>0</Anopublicacao>
<ISBN10/>

www.kpl.com.br Pgina 173 de 186

Verso: 2.0 KPL ENTERPRISE

<NumeroVolume>0</NumeroVolume>
<ImpressaoSobDemanda/>
<ComplementoEdicao/>
<NomeEncadernacao/>
<NumeroEdicao>0</NumeroEdicao>
<CodigoEdicaoAnterior>0</CodigoEdicaoAnterior>
<EdicaoAnterior/>
<DadosColecao>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>0</Codigo>
<Tipo>tdreIndefinido</Tipo>
</ResultadoOperacao>
<Rows>
<DadosColecao>
<NomeColecao/>
</DadosColecao>
</Rows>
</DadosColecao>
<DadosContribuidor>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>0</Codigo>
<Tipo>tdreIndefinido</Tipo>
</ResultadoOperacao>
<Rows>
<DadosContribuidor>
<NomeContribuidor/>
<NomeFuncao/>
<PrincipalFuncao/>
</DadosContribuidor>
</Rows>
</DadosContribuidor>
<DadosAcompanhamento>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>0</Codigo>
<Tipo>tdreIndefinido</Tipo>
</ResultadoOperacao>
<Rows>
<DadosAcompanhamento>
<NomeAcompanhamento/>
</DadosAcompanhamento>
</Rows>
</DadosAcompanhamento>
</DadosLivros>
</Rows>
</DadosLivros>
<PrecoTabela1>0</PrecoTabela1>
<PrecoPromocao1>0</PrecoPromocao1>
<PrecoTabela2>0</PrecoTabela2>
<PrecoPromocao2>0</PrecoPromocao2>
<DadosImagemProduto>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>300002</Codigo>
<Descricao>Erro na obteno dos dados para a integrao. Origem
"Imagens de produtos".</Descricao>
<Tipo>tdreErroDataBase</Tipo>
<ExceptionMessage>Interface = 57 Msg = Operao no permitida,
servio no est configurado para trabalhar quando as imagens esto armazenadas em um
servidor Web e no possuem nome padronizado</ExceptionMessage>
</ResultadoOperacao>
</DadosImagemProduto>
<ClassificacoesComplementares>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>

www.kpl.com.br Pgina 174 de 186

Verso: 2.0 KPL ENTERPRISE

<Codigo>200001</Codigo>
<Descricao>Operao "Classificao complementar de produtos"
efetuada com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosClassificacoesComplementares>
<CodigoGrupoExterno>IMEI1</CodigoGrupoExterno>
<CodigoGrupoAbacos>16</CodigoGrupoAbacos>
<CodigoGrupoPaiAbacos/>
<DescricaoGrupo>IMEI1</DescricaoGrupo>
<TipoGrupo>T</TipoGrupo>
<DescricaoOpcao>imei1</DescricaoOpcao>
<OpcoesClassificacoesComplementares>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>0</Codigo>
<Tipo>tdreIndefinido</Tipo>
</ResultadoOperacao>
<Rows>
<DadosOpcoesClassificacoesComplementares>
<CodigoOpcaoExterno/>
<CodigoOpcaoAbacos/>
<CodigoOpcaoPaiAbacos/>
<DescricaoOpcao/>
<Resultado>
<Codigo>0</Codigo>
<Tipo>tdreIndefinido</Tipo>
</Resultado>
</DadosOpcoesClassificacoesComplementares>
</Rows>
</OpcoesClassificacoesComplementares>
<Resultado>
<Codigo>0</Codigo>
<Tipo>tdreIndefinido</Tipo>
</Resultado>
</DadosClassificacoesComplementares>
</Rows>
</ClassificacoesComplementares>
<TransportadorasHabilitadas>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200003</Codigo>
<Descricao>OK, porm no h dados.</Descricao>
<Tipo>tdreSucessoSemDados</Tipo>
</ResultadoOperacao>
<Rows>
<DadosTransportadorasProduto/>
</Rows>
</TransportadorasHabilitadas>
<CodigoProdutoPaiAbacos>0</CodigoProdutoPaiAbacos>
<ReceitaRequerida>false</ReceitaRequerida>
</DadosProdutos>
</Rows>
</ProdutosDisponiveisResult>
</ProdutosDisponiveisResponse>
</soap:Body>
</soap:Envelope>

2.44.6 Regras de negcio

www.kpl.com.br Pgina 175 de 186

Verso: 2.0 KPL ENTERPRISE

Podem ser retornados mais de um registro na mesma chamado do mtodo.

As alteraes do mesmo produto so agrupadas no retorno do mtodo.

2.44.7 Perguntas frequentes

2.44.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 176 de 186

Verso: 2.0 KPL ENTERPRISE

2.45 StatusPedidoTraking

2.45.1 Conceito

O mtodo StatusPedidoTraking foi desenvolvido para disponibilizar os status do pedido disponveis para
integrao, durante o Traking.

2.45.2 Objetivo

Atravs desse mtodo possvel obter os status do Traking enviados pela transportadora, que esto
disponveis para integrao.

2.45.3 Pr-requisitos

A informao se torna disponvel para integrao quando ocorre o envio o status do Traking pela
transportadora.

2.45.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig. Descrio
ChaveIdentificacao String 36 Identificao nica da interface
Pedidos
CodigoPedido String 50 Cdigo do pedido no KPL

LAYOUT RESPONSE
Campo Tipo Max Descrio
StatusPedidoTrakingResult
VersaoWebService String 10 Verso do webservice
ResultadoOperacao
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
ExceptionMessage String 255 Mensagem de erro
Rows
DadosStatusPedidoTraking
ProtocoloStatusTraking String 36 Protocolo status pedido
CodigoPedidoInterno Int - Cdigo do pedido no KPL
CodigoPedido String 50 Cdigo externo do pedido
CodigoStatusPedido Int - Cdigo statusPedido
StatusPedido String 50 Status do pedido
DataOcorrencia Datetime - Data da ocorrncia
CodigoStatusTraking String 50 Cdigo do status Traking
CodigoSubStatusTraking String 50 Cdigo sub status Traking
StatusTraking String 100 Status Traking

www.kpl.com.br Pgina 177 de 186

Verso: 2.0 KPL ENTERPRISE

2.45.5 XML de exemplo

1) Aps o recebimento do Traking, foi executado o mtodo para obter o Traking disponvel.

RESPONSE
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<StatusPedidoTrakingResponse
xmlns="http://www.kplsolucoes.com.br/ABACOSWebService">
<StatusPedidoTrakingResult>
<VersaoWebService>5.0.89.3</VersaoWebService>
<ResultadoOperacao>
<Codigo>200001</Codigo>
<Descricao>Operao "Lista status do pedido durante o Traking" efetuada
com sucesso.</Descricao>
<Tipo>tdreSucesso</Tipo>
</ResultadoOperacao>
<Rows>
<DadosStatusPedidoTraking>
<ProtocoloStatusTraking>6AA48A2F-9838-44DE-A197-
E9A9EE5C2E89</ProtocoloStatusTraking>
<CodigoPedidoInterno>74</CodigoPedidoInterno>
<CodigoPedido>13840</CodigoPedido>
<CodigoStatusPedido>28</CodigoStatusPedido>
<StatusPedido>ENTREGUE</StatusPedido>
<DataOcorrencia>14082013 09:08:00.000</DataOcorrencia>
<CodigoStatusTraking>09</CodigoStatusTraking>
<CodigoSubStatusTraking>PO</CodigoSubStatusTraking>
<StatusTraking>POSTADO - DH</StatusTraking>
</DadosStatusPedidoTraking>
</Rows>
</StatusPedidoTrakingResult>
</StatusPedidoTrakingResponse>
</soap:Body>
</soap:Envelope>

2.45.7 Regras de negcio

O KPL ativo no recebimento do Traking, ou seja, ele quem busca a informao de Traking no
operador logstico (Transportadora, Correios, etc.) e atualiza no KPL.

Uma vez que o registro fica disponvel para integrao, necessrio informar que o mesmo foi recebido
e integrado corretamente para que no fique mais disponvel na fila de integrao. A confirmao de
www.kpl.com.br Pgina 178 de 186
Verso: 2.0 KPL ENTERPRISE

recebimento e integrao, deve ser feita atravs do mtodo 2.23 ConfirmarRecebimentoStatusTraking

2.45.8 Perguntas frequentes

2.45.9 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 179 de 186

Verso: 2.0 KPL ENTERPRISE

2.46 SubGrupoProdutosDisponiveis

2.46.1 Conceito

O mtodo SubGrupoProdutosDisponiveis foi desenvolvido para disponibilizar os subgrupos de produtos

disponveis para integrao.

2.46.2 Objetivo

Atravs desse mtodo possvel obter as informaes de subgrupos de produtos que esto disponveis para
integrao.

2.46.3 Pr-requisitos

A informao se torna disponvel para integrao quando ocorre uma incluso, alterao ou excluso de
alguma informao.

Ativar replicao de sada

Deve ser habilitada na interface a replicao de sada dos subgrupos de produtos.

www.kpl.com.br Pgina 180 de 186

Verso: 2.0 KPL ENTERPRISE

2.46.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
ConfirmarRecebimentoSubGrupoProduto
ProtocoloSubGrupoProduto String 255 Identificao nica da interface

LAYOUT RESPONSE
Campo Tipo Max Descrio
SubGrupoProdutosDisponiveisResult
VersaoWebService String 10 Verso do webservice
ResultadoOperacao
Codigo Int - Cdigo do Webservice: 1.1 Operao realizada
Descricao String 255 Descrio do erro
Tipo String - Valores possveis: 1.2 enumTipo
Rows
DadosSubGruposProdutos
ProtocoloSubGrupo String 255 Protocolo sub grupo
Acao String - Valores disponveis: 1.3 enumAcao
Nome String 50 Nome
CodigoExternoSubGrupo String 50 Cdigo externo sub grupo
CodigoSubGrupo Int - Cdigo sub produto
CodigoExternoGrupo String 50 Cdigo externo grupo
CodigoGrupo Int - Cdigo grupo

2.46.5 XML de exemplo

1) Incluso de novos subgrupos de produtos.

www.kpl.com.br Pgina 181 de 186

Verso: 2.0 KPL ENTERPRISE

2) Execuo do mtodo para retorno dos subgrupos disponveis para integrao.

2.46.6 Regras de negcio

2.46.7 Perguntas frequentes

2.46.8 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 183 de 186

Verso: 2.0 KPL ENTERPRISE

2.47 GetVersion

2.47.1 Conceito

O mtodo GetVersion foi desenvolvido para obter a verso do webservice de do KPL Enterprise.

2.47.2 Objetivo

Atravs desse mtodo possvel ter conhecimento de forma prtica da verso do webservice e KPL.

2.47.3 Pr-requisitos

No se aplica.

2.47.4 Propriedades

LAYOUT REQUEST
Campo Tipo Max Obrig Descrio
GetVersion
ChaveIdentificacao String 255 Identificao nica da interface

LAYOUT RESPONSE
Campo Tipo Max Obrig Descrio
GetVersionResult
VersaoWebService String 255 Verso do webservice
VersaoAbacos String 255 Verso do KPL Enterprise
Info String 255 Informaes framework

2.44.5 XML de exemplo

4) Aps o recebimento do Traking, foi executado o mtodo para obter o Traking disponvel.

www.kpl.com.br Pgina 184 de 186

Verso: 2.0 KPL ENTERPRISE

2.47.6 Histrico de alteraes

Verso Histrico
89R8 Criao do documento.

www.kpl.com.br Pgina 185 de 186

Verso: 2.0 KPL ENTERPRISE

3. Alteraes verso Delpphi para C#

3.1 TipoContribuinteEnum

tipoContribuinte
Delphi C#
Valores disponveis: Valores disponveis:
tdfContribuinte tctrInvalido
tdfNaoContribuinte tctrContribuinte
tdfIndefinido tctrNaoContribuinte
tctrIsento