E-Commerce – Manual de integração de alteração dos produtos e saldo do estoque (versão 1.0)
Control P Informática S/C Ltda.
Manual de integração de alteração dos produtos e saldo do estoque – versão 1.0
Controlp Sistemas
01/04/2022
| Esse documento visa orientar sobre o consumo do serviço (webservice) para captura de produtos alterados e saldo de estoque atualizado do produto. |
Histórico de revisão
| Versão | Data | Autor | Ação |
| 1.0 | 02/12/2020 | Controlp Sistemas | Criação do documento. |
Sobre esse documento
Esse documento objetiva-se a explicar o sistema de troca de informações que o AtendeSmart disponibiliza para terceiros para captura de alterações no cadastro de produtos e saldo do estoque atualizado.
Sobre o webservice
O serviço utiliza o padrão wsdl para envio de dados e resposta em formato XML.
Serviços disponíveis
| Serviço | Descrição |
| listar_fila | Devolve os cadastros de produtos novos e modificados pelo cliente, o saldo do produto atualizado no sistema Atende Smart, passando como parâmetros um usuário, sua senha, e a quantidade limite de registros (produtos) contidos no XML de retorno. |
| limpar_fila | Elimina os registros (produtos) que não mais necessitam que sejam devolvidos no serviço listar_fila. |
Descrição do XML de retorno
Coluna “Id #”: Identificação do campo no leiaute do XML.
Coluna “Campo”: Nome literal da tag (elemento) ou do atributo da tag.
Coluna “Descrição”: Descreve o propósito do campo.
Coluna “Elemento”: Descreve o tipo de elemento da estrutura do XML que é o campo. As siglas usadas são descritas na tabela abaixo:
| Abreviatura | Descrição |
| G | O elemento é um grupo. |
| A | Atributo do elemento anterior. |
| RC | O campo é uma restrição de chave (key constraint), para garantir a unicidade de valor. |
| E | O campo é um elemento do XML. |
| EE | O campo é um elemento de escolha. Somente um dos elementos do grupo constará no resultado final do XML. |
Tabela 1 – Elementos
Coluna “Pai”: Identifica, pelo “Id #”, qual o elemento hierarquicamente superior ao elemento que está sendo descrito.
Coluna “Tipo”: Identifica o tipo dos dados na coluna:
| Sigla | Descrição |
| C | Campo alfanumérico |
| N | Campo numérico |
| D | Campo de data ou data e hora |
Tabela 2 – Tipos dos campos
Coluna “Ocor.”: Indica a ocorrência do elemento no arquivo XML, no formato “x-y”, onde “x” indica a ocorrência mínima e “y” indica a ocorrência máxima.
Coluna “Tamanho”: Indica o tamanho do campo, no formato “x-y(vw-z)”, onde “x” indica o camanho mínimo e “y” o tamanho máximo. “v”, quando presente, indica a possibilidade de valores decimais, seguido de “w”, que indica a quantidade mínima de decimais esperado e “z”, a quantidade máxima de decimais. Na ausência de dois grupos de dígitos, o valor informado é a quantidade absoluta esperada.
Campo “Observações”: Apresenta informações adicionais referente ao(s) campo(s), como regras, limites ou detalhamento.
Leiaute XML de retorno (listar_fila)
| ID # | Campo | Descrição | Elemento | Pai | Tipo | Ocor. | Tam. | Observação |
| 1 | resposta | TAG raíz do documento XML | G | – | 1-1 | |||
| 1.1 | produto | Informações do produto | G | 1 | – | 1-999 | ||
| 1.1a | Id | Id do produto no cadastro do sistema Atende Smart. | RC | 1.1 | N | 1-1 | 1-x | Este campo é um atributo da campo “produto” ( ID=1.1 ) |
| 1.1.1 | dados | Informações do produto | G | 1.1 | 0-1 | |||
| 1.1.1.1 | idFila | Id da fila. | E | 1.1.1 | N | 1-1 | 1-x | Valor para usar posteriormente no serviço “limpar_fila”. |
| 1.1.1.2 | codigoSKU | Código de barras principal do produto | E | 1.1.1 | C | 1-1 | 1-20 | |
| 1.1.1.3 | codigoECOMMERCE | Código de barras do E-Commerce | E | 1.1.1 | C | 1-1 | 0-50 | Este código é o mesmo cadastrado no e-commerce (site de vendas) do cliente. |
| 1.1.1.4 | nome | Nome do produto | E | 1.1.1 | C | 1-1 | 0-200 | |
| 1.1.1.5 | nomeReduzido | Nome reduzido do produto | E | 1.1.1 | C | 1-1 | 0-50 | |
| 1.1.1.6 | unidade | Sigla da unidade do produto | E | 1.1.1 | C | 1-1 | 0-6 | |
| 1.1.1.7 | descricao | Descrição adicional do produto | E | 1.1.1 | C | 1-1 | 0-x | |
| 1.1.1.8 | altura | Altura do produto | E | 1.1.1 | N | 1-1 | 14v0-5 | |
| 1.1.1.9 | largura | Largura do produto | E | 1.1.1 | N | 1-1 | 14v0-5 | |
| 1.1.1.10 | comprimento | Comprimento do produto | E | 1.1.1 | N | 1-1 | 14v0-5 | |
| 1.1.1.11 | pesoLiquido | Peso liquido do produto | E | 1.1.1 | N | 1-1 | 14v0-5 | |
| 1.1.1.12 | pesoBruto | Peso bruto do produto | E | 1.1.1 | N | 1-1 | 14v0-5 | |
| 1.1.1.13 | custo | Custo do produto | E | 1.1.1 | N | 1-1 | 20v0-10 | |
| 1.1.1.14 | preco | Preço do produto | E | 1.1.1 | N | 1-1 | 20v0-10 | |
| 1.1.1.15 | localizacao | Localização do produto | E | 1.1.1 | C | 1-1 | 0-50 | |
| 1.1.2 | estoque | Informações do saldo de estoque do produto. | G | 1.1 | 0-1 | |||
| 1.1.2.1 | idFila | Id da fila | E | 1.1.2 | N | 1-1 | 1-x | Valor para usar posteriormente no serviço “limpar_fila”. |
| 1.1.2.2 | saldo | Saldo de estoque atualizado do produto. | E | 1.1.2 | N | 1-1 | 12v0-3 | |
| 1.2 | tempoResposta | Tempo de resposta do serviço | E | 1 | N | 1-1 | 1-x | |
| 1.3 | qtdeFilaTotal | Quantidade total de registros pendentes na fila | E | 1 | N | 1-1 | 1-x | |
| 1.4 | codigoRetorno | Código de retorno | E | 1 | C | 1-1 | 1-x | Verificar tabela de retorno (pagina 3) |
| 1.5 | filaExclusao | Todos os id’s da fila listado no xml | E | 1 | C | 1-1 | 1-x | Este valor pode ser utilizado para o serviço “limpar_fila”. |
Leiaute XML de retorno (listar_fila)
<resposta>
<produto Id=”1988″>
<dados>
<idFila>292</idFila>
<codigoSKU>#0001</codigoSKU>
<codigoECOMMERCE>#0001</codigoECOMMERCE>
<nome>KIT & TESTE 5 CANO</nome>
<nomeReduzido>KIT TESTE ” ? ?>55</nomeReduzido>
<unidade>UNIDAD</unidade>
<descricao>Teste<descricao/>
<altura>0.63000</altura>
<largura>0.60000</largura>
<comprimento>0.60000</comprimento>
<pesoLiquido>1.00000</pesoLiquido>
<pesoBruto>1.00000</pesoBruto>
<custo>112.0000000000</custo>
<preco>248.1300000000</preco>
</dados>
</produto>
<produto Id=”5924″>
<dados>
<idFila>293</idFila>
<codigoSKU>1341</codigoSKU>
<codigoECOMMERCE/>
<nome>COMPOSICAO 1</nome>
<nomeReduzido>COMPOSICAO 1</nomeReduzido>
<unidade>UN</unidade>
<descricao/>
<altura>0.00000</altura>
<largura>0.00000</largura>
<comprimento>0.00000</comprimento>
<pesoLiquido>1.00000</pesoLiquido>
<pesoBruto>1.00000</pesoBruto>
<custo>11.0000000000</custo>
<preco>22.0000000000</preco>
</dados>
<estoque>
<idFila>294</idFila>
<saldo>300.000</saldo>
</estoque>
</produto>
<tempoResposta>0</tempoResposta>
<qtdeFilaTotal>10</qtdeFilaTotal>
<codigoRetorno>100</codigoRetorno>
<filaExclusao>292,293,294</filaExclusao>
</resposta>
Exemplo em php listar_fila
//Passando o endereço do servidor
$client = new SoapClient( null, array(
‘location’ => ‘https://www.atendesmart.com.br/sistema/comanda/webservice/alteracao_produto_wsdl.php’,
‘uri’ => ‘https://www.atendesmart.com.br/sistema/comanda/webservice/’,
‘trace’ => 1 ) );
//Consome web service para listar produto
$result = $client->listar_fila(
$usuario, //Nome do usuario web service fornecido pelo suporte
$senha, //Senha do usuario web service fornecido pelo suporte
$quantidade_registros //Quantidade de registros por XML, se for 0 ou menor que 0 trará 20 registros, sendo que o máximo é de 999.
);
//A variável $result contem o XML de retorno em string
return $result;
Leiaute XML de retorno (limpar_fila)
| ID # | Campo | Descrição | Elemento | Pai | Tipo | Ocor. | Tam. | Observação |
| 1 | resposta | TAG raíz do documento XML | G | – | 1-1 | |||
| 1.1 | retorno | Informações do retorno | G | 1 | – | 1-1 | ||
| 1.1.1 | codigoRetorno | Código de retorno | E | 1.1 | N | 1-1 | 1-x | Verificar tabela de retorno (pagina 3) |
| 1.1.2 | mensagem | Mensagem de retorno | E | 1.1 | N | 1-1 | 1-x | Verificar tabela de retorno (pagina 3) |
| 1.1.3 | tempoResposta | Tempo de resposta do serviço | E | 1.1 | C | 1-1 | 1-x |
Leiaute XML de retorno (limpar_fila)
<resposta>
<retorno>
<codigoRetorno>100</codigoRetorno>
<mensagem>Fila excluida com sucesso.</mensagem>
<tempoResposta>0</tempoResposta>
</retorno>
</resposta>
Exemplo em php limpar_fila
//Passando o endereço do servidor
$client = new SoapClient( null, array(
‘location’ => ‘https://www.atendesmart.com.br/sistema/comanda/webservice/alteracao_produto_wsdl.php’,
‘uri’ => ‘https://www.atendesmart.com.br/sistema/comanda/webservice/’,
‘trace’ => 1 ) );
//Consome web service para listar produto
$result = $client->limpar_fila(
$usuario, //Nome do usuario web service fornecido pelo suporte
$senha, //Senha do usuario web service fornecido pelo suporte
$ids //Ids que serão removidos da fila, cada id deve ser separado por virgula exemplo: ’292,293,294’.
);
//A variável $result contem o XML de retorno em string
return $result;
Tabela de retornos
Listagem códigos de retorno
| Id# | Mensagem |
| 100 | Fila excluida com sucesso ou listagem concluída com sucesso. |
| 0 | Id(s) invalido(s). |
| 876 | XML invalido. |
| 88 | Select invalido. |
| 76 | Conexao nao estabelecida. |
| 12 | Cadastro de conexao nao encontrado na base de dados. |
| 999 | Id(s) nao excluidos(s). |
| 45 | Nao foi possivel excluir a fila (string em branco). |
| 489 | Nao foi possivel carregar xml (conexao invalida). |
Envio dos serviços
Endereço do webservices: https://www.atendesmart.com.br/???????/?????????.php
Serviços disponíveis:
listar_fila
limpar_fila
Share this content: