Documento para integração com a loja virtual via webservice

Requisitos:

  • O Webservice deverá ter mecanismo de segurança de comunicação(SSL).
  • Conexão com internet 24×7.
  • Acesso via porta 443.

Funcionamento

A loja virtual deverá consumir o webservice através do método “solicitacao” passandos os parâmetros conforme a documentação abaixo.

As funções disponíveis no webservice são:

Função Descrição Quando Usar?
Consulta_codigos Retorna todos os códigos cadastrados no autocom3. Quando for fazer o cadastro inicial do banco de dados da loja virtual, ou quando a loja física inserir novos produtos.
Consulta_produto Retorna os dados básicos do produto, como nome, preço de venda, estoque total da loja física, reserva de estoque, estoque disponível e demais informações do cadastro do produto. Em dois momentos, para cadastrar novos produtos na loja virtual e importar os dados que já estão no autocom3.  E em um segundo momento, executar durante a visitação do usuário no site para consultar a disponibilidade de estoque e o preço atualizado.
Consulta_seo Retorna 10 tags contendo texto para SEO Deve ser usada junto com o cadastramento de produtos na loja virtual e dessa forma importar os dados de SEO que a loja já lançou para o produto.
Venda Realizar o pedido de venda no Autocom3, para que seja reservada a mercadoria e futuras emissões de notas fiscais. Deve ser usada no checkout da loja virtual, assim que o pagamento for aprovado essa função deverá ser chamada para efetivar a venda da mercadoria no software da Autocom3.

Funções disponíveis

Consulta_Codigos

A loja virtual deverá realizar o envio da solicitação passando os seguintes parâmetros:

Formato do XML de envio da solicitação, exemplo:

<consulta_codigos>

<escopo>TODOS</escopo>

</consulta_codigos>

Campo Descrição Tamanho Tipo
Escopo Indica qual a faixa de códigos será retornada.

Valores aceitos:

TODOS
ULTIMOS5DIAS

50 Alfanumerico
Bloco O sistema enviará sempre blocos de 100 códigos a cada solicitação.

 

Para controlar esse fluxo do bloco, o ADM da loja virtual deve enviar a primeira solicitação passando 0 (ZERO) neste campo.

 

O webservice devolverá o código do próximo bloco, que deverá ser utilizado na próxima consulta.

 

Quando o webservice devolver 999.999 significa que chegou no fim do cadastro de produtos.

 

 

6 Numérico

Retorno da Solicitação

O retorno da solicitação deverá ter o seguinte formato:

Campo Descrição Tamanho Tipo
Chave Chave de acesso fornecida pela Autocom3 para validar o acesso ao webservice 36 Alfanumérico
Função consulta_codigos  (em minúsculo) 50 Alfanumérico
XML Ver formato do XML (max) Padrão XML

<consulta_ codigos >

< sequencia>

<codchaveini>”0000000001”</codchaveini>

<codchavefim>”0000000007”</codchavefim>

<bloco>999999</bloco>

</ sequencia >

<produtos>

<produto codchave=”0000000001”></produto>

<produto codchave=”0000000002”></produto>

<produto codchave=”0000000003”></produto>

<produto codchave=”0000000004”></produto>

<produto codchave=”0000000005”></produto>

<produto codchave=”0000000006”></produto>

<produto codchave=”0000000007”></produto>

</ produtos>

</consulta_produto>

Campo Descrição Tamanho Tipo
primeirocodchave Primeiro código da query 10 Alfanumérico
Ultimocodchave Último código da query 10 Alfanumérico
Tagprodutospresente 1=Sim 0=Não

 

Se houver até 200 produtos no resultado da query, a TAG <produtos> é enviada, detalhando item a item e este campo recebe o valor de 1.

Se houver mais de 200 produtos, este campo recebe o valor de 0 e a tag <produtos> não é enviada.

 

Se o valor for 0, a aplicação web deve fazer um loop entre o primeirocodchave e Ultimocodchave e buscar item a item os dados dos produtos.

 

1 Numérico
codchave Código Interno do produto no Autocom3 10 Alfanumérico

Consulta_Produto

A loja virtual deverá realizar o envio da solicitação passando os seguintes parâmetros:

Campo Descrição Tamanho Tipo
Chave Chave de acesso fornecida pela Autocom3 para validar o acesso ao webservice 36 Alfanumérico
Função consulta_produto  (em minúsculo) 50 Alfanumérico
XML Ver formato do XML 1000 (max) Padrão XML

Formato do XML de envio da solicitação, exemplo:

<consulta_produto>

<produto codchave=”0000000001”>

<produto codchave=”0000000002”>

<produto codchave=”0000000003”>

</consulta_produto>

Observação:  A quantidade máxima de repetição da TAG produto é de 10.

Campo Descrição Tamanho Tipo
Codchave Código interno do cadastro de produto na loja virtual.  Precisa ser o MESMO que está no campo CODCHAVE do Autocom3 10 Numérico

Retorno da Solicitação

O retorno da solicitação deverá ter o seguinte formato:

Campo Descrição Tamanho Tipo
Chave Chave de acesso fornecida pela Autocom3 para validar o acesso ao webservice 36 Alfanumérico
Função consulta_produto  (em minúsculo) 50 Alfanumérico
XML Ver formato do XML 1000 (max) Padrão XML

Formato do XML de retorno da solicitação, exemplo:

<consulta_produto>

<produto codchave=”0000000001”>

<codigo_erro>00</codigo_erro>

<ativo>1</ativo>

<codigo>7896641803871</codigo>

<nomeprod>NEOSALDINA C/20</nomeprod>

<numeroloj>01</numeroloj>

<saldoestoque>400</saldoestoque>

<reserva>15</reserva>

<saldodisponivel>385</ saldodisponivel>

<dtatualizacao>2017-04-04 09:22:21.000</dtatualizacao>

<precomax>20.24</precomax>

<prevenda>14.50</prevenda>

<promocao>0.00</promocao>

<codencarte></codencarte>

<coddepar>001</coddepar>

<nomedepar>MEDICAMENTO</nomedepar>

<codfab>00001</codfab>

<nomefab>TAKEDA</nomefab>

<codgrupo>001</codgrupo>

<nomegrupo>MEDICAMENTO</nomegrupo>

<subgrupo1>001</subgrupo1>

<nomesubgrupo1>MEDICAMENTO ESPECIAL</nomesubgrupo1>

<subgrupo2>001</subgrupo2>

<nomesubgrupo2>VERIFICADO</nomesubgrupo2>

<subgrupo3>001</subgrupo3>

<nomesubgrupo3>EXPOSICAO</nomesubgrupo3>

<subgrupo4>001</subgrupo4>

<nomesubgrupo4>VERDE</nomesubgrupo4>

</produto>

</consulta_produto>

Observação:  A quantidade máxima de repetição da TAG produto é de 10.

Campo Descrição Tamanho Tipo
codigo_erro Código gerado durante o processamento caso o formato de envio esteja fora do padrão usado pelo serviço. 2 Numérico
Ativo Indica se o produto é ativo(1)  ou inativo (0) 1 Numérico
codigo Código de identificação do produto no estoque 14 Numérico
nomeprod Nome do produto. 100 Alfanumérico
numeroloj Número identificador da loja. 5 Numérico
saldoestoque Saldo do produto no estoque da loja. 17,3 Numérico
reserva Quantidade solicitada do produto para separação no estoque. 17,3 Numérico
Saldodisponivel Saldo disponível para venda na loja virtual 17,3 Numérico
dtatualizacao Data da ultima atualização das informações do estoque. 23 Data/Hora
precomax Preço máximo praticado para o produto. 9,2 Numérico
prevenda Preço de venda normal para o produto. 9,2 Numérico
promocao Preço promocional para o produto. 9,2 Numérico
codencarte Código do encarte promocional usado para divulgar o produto ou grupo de produtos. 3 Numérico
coddepar Código de agrupamento do produto. 3 Numérico
nomepar Nome do departamento de agrupamento do produto. 50 Alfanumérico
codfab Código de identificação do fabricante do produto. 5 Numérico
nomefab Nome do fabricante do produto. 50 Alfanumérico
codgrupo Código do grupo do produto. 3 Numérico
nomegrupo Nome do grupo do produto. 50 Alfanumérico
subgrupo1 Código do subgrupo1 do produto. 3 Numérico
nomesubgrupo1 Nome do subgrupo1 do produto. 50 Alfanumérico
subgrupo2 Código do subgrupo2 do produto. 3 Numérico
nomesubgrupo2 Nome do subgrupo2 do produto. 50 Alfanumérico
subgrupo3 Código do subgrupo3 do produto. 3 Numérico
nomesubgrupo3 Nome do subgrupo3 do produto. 50 Alfanumérico
subgrupo4 Código do subgrupo4 do produto. 3 Numérico
nomesubgrupo4 Nome do subgrupo4 do produto. 50 Alfanumérico

Consulta_Seo

A loja virtual deverá realizar o envio da solicitação passando os seguintes parâmetros:

Campo Descrição Tamanho Tipo
Chave Chave de acesso fornecida pela Autocom3 para validar o acesso ao webservice 36 Alfanumérico
Função consulta_seo  (em minúsculo) 50 Alfanumérico
XML Ver formato do XML 1000 (max) Padrão XML

Formato do XML de envio da solicitação, exemplo:

<consulta_seo>

<produto codchave=”0000000001”>

<produto codchave=”0000000002”>

<produto codchave=”0000000003”>

</ consulta_seo>

Observação:  A quantidade máxima de repetição da TAG produto é de 10.

Campo Descrição Tamanho Tipo
Codchave Código interno do cadastro de produto na loja virtual.  Precisa ser o MESMO que está no campo CODCHAVE do Autocom3 10 Numérico

Retorno da Solicitação

O retorno da solicitação deverá ter o seguinte formato:

Campo Descrição Tamanho Tipo
Chave Chave de acesso fornecida pela Autocom3 para validar o acesso ao webservice 36 Alfanumérico
Função consulta_seo  (em minúsculo) 50 Alfanumérico
XML Ver formato do XML 1000 (max) Padrão XML

Formato do XML de retorno da solicitação, exemplo:

<consulta_seo>

<produto codchave=”0000000001”>

<codigo_erro>00</codigo_erro>

<nomeprod>NEOSALDINA C/20</nomeprod>

<seo1>Dor de cabeça;Febre;Nausea;</seo1>

<seo2>Neosaldina é indicada para o tratamento de diversos tipos de dores de cabeça, como a dor de cabeça tensional ou enxaqueca e para o tratamento das cólicas, em adultos e crianças com mais de 12 anos de idade.</seo2>

<seo3>Neosaldina é um medicamento que em sua composição Cafeína, Dipirona e Mucato de Isometepteno, compostos com atividade analgésica e diminui os espasmos, aliviando assim diferentes tipos de dores de cabeça, enxaquecas e cólicas.

Após a sua administração oral o efeito de Neosaldina ocorre 15 a 30 após a sua toma e prolonga-se por 4 a 6 horas.</seo3>

<seo4>A dose recomendada de Neosaldina é de 1 a 2 comprimidos administrados de 6 em 6 horas, cerca de 4 vezes por dia.

Os comprimidos de Neosaldina devem ser engolidos inteiros, juntamente com um copo de água, sem partir ou mastigar.</seo4>

<seo5></seo5>

<seo6></seo6>

<seo7></seo7>

<seo8></seo8>

<seo9></seo9>

<seo10></seo10>

</produto>

</consulta_seo>

Observação:  A quantidade máxima de repetição da TAG produto é de 10.

Campo Descrição Tamanho Tipo
codchave Código chave de identificação do produto. 10 Numérico
nomeprod Nome do produto. 100 Alfanumérico
seo1 Texto descritivo para uso do seo do produto. Alfanumérico
seo2 Texto descritivo para uso do seo do produto. Alfanumérico
seo3 Texto descritivo para uso do seo do produto. Alfanumérico
seo4 Texto descritivo para uso do seo do produto. Alfanumérico
seo5 Texto descritivo para uso do seo do produto. Alfanumérico
seo6 Texto descritivo para uso do seo do produto. Alfanumérico
seo7 Texto descritivo para uso do seo do produto. Alfanumérico
seo8 Texto descritivo para uso do seo do produto. Alfanumérico
seo9 Texto descritivo para uso do seo do produto. Alfanumérico
seo10 Texto descritivo para uso do seo do produto. Alfanumérico

Venda

Formato do XML de envio da solicitação, exemplo:

<venda>

<cliente>

<ljvcodcli>1234</ljvcodcli>

<tppessoa>F</tppessoa>

<cpf>07856197714</cpf>

<cnpj></cnpj>

<iecli>NAOCONTRIBUINTE</iecli>

<nomecli>WHILDER S MENDONCA</nomecli>

<endcli>RUA BOUGAINVILE</endcli>

<numero>297</numero>

<compcli>VILAGE SUL</compcli>

<bairro>JARDIM BELVEDERE</bairro>

<pontoreferencia>CASA AO LADO DA QUADRA, DENTRO DO CONDOMINIO</pontoreferencia>

<cep>27258170</cep>

<telcli>24974023567</telcli>

<contato>WHILDER</contato>

<emailcli>whilder@me.com</emailcli>

</cliente>

<pedido>

<ljvsituacao>1</ljvsituacao>

<ljvcodpedido>1234564879</ljvcodpedido>

<data_pedido>20170307</data_pedido>

<hora_pedido>21:19:00</hora_pedido>

<frete>0</frete>

<valorfrete>0.00</valorfrete>

<itens>3</itens>

<valortotal>90.00</valortotal>

<desconto>0.00</desconto>

<liquido>90.00</liquido>

<codrastreio>DLKJDLJK121545</codrastreio>

<pgto_codigo>03</pgto_codigo>

<pgto_descricao>Pagamento em Cartão Crédito Visa</pgto_descricao>

<pgto_parcelas>3</pgto_parcelas>

<infoextra1>5001;JOAO DA SILVA;</infoextra1>

<infoextra2></infoextra2>

<infoextra3></infoextra3>

<infoextra4></infoextra4>

<infoextra5></infoextra5>

<infoextra6></infoextra6>

<infoextra7></infoextra7>

<infoextra8></infoextra8>

<infoextra9></infoextra9>

<infoextra10></infoextra10>

</pedido>

<itens>

<codchave>0000000001</codchave>

<codigo>7896641803871</codigo>

<nomeprod>NEOSALDINA C/20</nomeprod>

<quant>3</quant>

<unitario>14.50</unitario>

<total>43.50</total>

<desconto>0.00</desconto>

<liquido>43.50</liquido>

</itens>

</venda>

Campo Descrição Tamanho Tipo
ljvcodcli Codigo do cliente. 10 Numérico
tppessoa Indica o tipo de pessoa F física, J jurídica. 1 Texto
cpf Cpf do cliente. 11 Númérico
cnpj CNPJ do cliente. 18 Numérico
iecli Inscrição estadual do cliente. 20 Texto
nomecli Nome do cliente. 50 Texto
endcli Endereço do cliente. 50 Alfanumérico
numero Número do endereço do cliente. 5 Alfanumérico
compcli Complemento do endereço do cliente. 30 Alfanumérico
bairro Bairro onde reside o cliente. 30 Alfanumérico
pontoreferencia Complemento do endereço. Texto
cep Código postal do endereço do cliente. 9 Numérico
telcli Telefone de contato do cliente. 30 Numérico
contato Nome para contato com o cliente. 20 Alfanumérico
emailcli Email do cliente 50 Alfanumérico
ljvsituacao Indica o status da compra.

1=Efetuada

1 Numérico
ljvcodpedido Código do pedido. 10 Numérico
data_pedido Data em que o pedido foi feito.

Formato: AAA-MM-DD

8 Data
hora_pedido Hora em que o pedido foi feito.

Formato: HH:MM:SS

8 Alfanumérico
frete Indica se o produto possui ou não frete.

1 – Possui

0-    Não possui

1 Verdadeiro/Falso
valorfrete Valor do frete para o transporte do pedido. 17,2 Numérico
itens Quantidade total de produtos no pedido. 4 Numérico
valortotal Valor total de todo o pedido contendo a soma do liquido de cada item. 17,2 Numérico
desconto Valor do desconto aplicável ao pedido. 17,2 Numérico
liquido Valor liquido do pedido com o desconto aplicado ao valor total. 17,2 Numérico
codrastreio Código de rastreio do pedido. 30 Alfanumérico
Pgto_codigo Código da forma de pagamento que será usada no Autocom3

Códigos aceitos: 00 a 15

2 Numérico
Pgto_descricao Descrição da modalidade de pagamento que foi processada no site (Essa descrição é livre) 50 Alfanumérico
Pgto_parcelas Quantidade de parcelas da modalidade de pagamento 3 Numérico
InfoExtra1 Campo para informações extras e personalizações da integração 50 Alfanumérico
InfoExtra2 Campo para informações extras e personalizações da integração 50 Alfanumérico
InfoExtra3 Campo para informações extras e personalizações da integração 50 Alfanumérico
InfoExtra4 Campo para informações extras e personalizações da integração 50 Alfanumérico
InfoExtra5 Campo para informações extras e personalizações da integração 50 Alfanumérico
InfoExtra6 Campo para informações extras e personalizações da integração 50 Alfanumérico
InfoExtra7 Campo para informações extras e personalizações da integração 50 Alfanumérico
InfoExtra8 Campo para informações extras e personalizações da integração 50 Alfanumérico
InfoExtra9 Campo para informações extras e personalizações da integração 50 Alfanumérico
InfoExtra10 Campo para informações extras e personalizações da integração 50 Alfanumérico
codchave Código do produto. 10 Numérico
codigo Código de barras do produto. 13 Numérico
nomeprod Nome do produto. 100 Alfanumérico
quant Quantidade do produto no pedido. 17,2 Numérico
unitario Valor unitário do item. 17,2 Numérico
total Valor total do item. 17,2 Numérico
desconto Valor do desconto aplicado ao valor total do item. 17,2 Numérico
liquido Valor final do item já com desconto aplicado.

Retorno da Solicitação

O retorno da solicitação deverá ter o seguinte formato:

Campo Descrição Tamanho Tipo
Chave Chave de acesso fornecida pela Autocom3 para validar o acesso ao webservice 36 Alfanumérico
Função venda  (em minúsculo) 50 Alfanumérico
XML Ver formato do XML (max) Padrão XML

Formato do XML de retorno da solicitação, exemplo:

<venda>

<codigo_erro>00</codigo_erro>

</venda>

Campo Descrição Tamanho Tipo
CODIGO_ERRO Tabela de erros 2 Numérico

Erros nos XML

Caso a loja virtual envie um XML inválido, o retorno será um pouco diferente.

Campo Descrição Tamanho Tipo
Chave Chave de acesso fornecida pela Autocom3 para validar o acesso ao webservice 36 Alfanumérico
Função VENDA 50 Alfanumérico
XML Ver formato do XML 1000 (max) Padrão XML

Formato do XML de envio da solicitação, exemplo:

<solicitacao>

<nomedasolicitacao>

<codigo_erro>89</codigo_erro>

<erro_xml >descrição do erro no schema do xml</erro_xml>

</nomedasolicitacao>

</solicitacao>

Códigos de Retorno:

O webservice irá tratar cada solicitação e preencherá o campo CODIGO_ERRO com o resultado de cada consulta efetuada.  Segue a lista dos códigos disponíveis:

Código do Erro Descrição + Informações
00 Sucesso Retorno OK
66 Timeout Timeout na consulta ao webservice.
89 XML de consulta inválido. Erro na estrutura do XML de consulta ou se houver mais de 10 produtos.
90 Parâmetros inválidos. Não passar corretamente login, senha ou o XML.
91 Login Inválido. Não existe este login/senha em nossa base.
95 Função Inexistente Nenhuma função conhecida foi passada no parâmetro.
98 Consulta retornou sem resultados Não houve nenhum resultado na consulta realizada.
78 Total dos itens está errado Diferença entre o que foi informado na tag ITEM X tag PEDIDOS
79 Valor líquido dos itens está errado. Diferença entre o que foi informado na tag ITEM X tag PEDIDOS
80 CPF/CNPJ inválido O CPF ou CNPJ do cliente não é valido
82 Este pedido já existe Software não aceita duplicidade de pedido e retornará esse erro se for submetido mais de uma vez.
93 Produto não cadastrado Foi enviado um código que não existe em nossa base
 
 
 
94 Produto sem preço O produto existe, mas a drogaria não precificou o produto para esta filial/CNPJ.
96 Produto sem estoque Saldo disponível é menor ou igual a zero.
97 Produto sem SEO Produto não possui nenhuma informação de SEO.

Sugestões de uso das consultas

As consultas são individuais, o que significa que podem ser executadas sem dependência uma da outra, porém, seguem algumas dicas:

  • SINCRONIZAR O CADASTRO DE PRODUTOS DA LOJA VIRTUAL E LOJA FISICA;
  • ATUALIZAR CADASTRO COMPLETO;
  • ATUALIZAR PRODUTOS NOVOS E ALTERADOS NOS ULTIMOS 5 DIAS.

Sugestões de integração:

  • Criar uma função no ADMIN da loja virtual uma opção INTEGRAÇÃO AUTOCOM3;

Segue sugestão de interface:

  • Um local para gravação da chave de autorização (licenciamento) do e-commerce com a Autocom3.
  • Um botão IMPORTAR TODOS OS PRODUTOS e outro IMPORTAR ÚLTIMOS 5 DIAS
  • Um botão para ENVIAR OS PEDIDOS FATURADOS para o webservice da Autocom3, para posteriormente ser tratado pela loja.

 

 

Print Friendly, PDF & Email

Sobre o Autor