v Modelo 007 Manual de Integração WEB SERVICES

Transcrição

1 v Modelo 007 Manual de Integração WEB SERVICES Curitiba (2015)

2 TERMO DE CONFIDENCIALIDADE As informações contidas neste documento são estritamente confidenciais e de propriedade da FBITS S/A, sua distribuição só poderá ser feita a seus Clientes Externos e Internos mediante autorização assinada. Estas informações não poderão ser utilizadas para outro propósito, não podendo ser reveladas fora de sua organização sem prévia autorização por escrito da FBITS S/A. É vedada a geração de fotocópias deste documento, bem como sua reprodução ou distribuição, no todo ou em parte, por qualquer meio, inclusive sob meio gráfico, magnético, ótico, fotográfico ou eletrônico e informações ao mercado e/ou a outras pessoas físicas e jurídicas, dará ensejo à indenizações por perdas e danos que porventura seus administradores venham a sofrer em decorrência de tal falta, recaindo essas responsabilidades, exclusivamente, sobre os signatários deste compromisso, os quais serão apurados em juízo. É de sua responsabilidade proteger as informações contra a divulgação a terceiros, da mesma forma e com o mesmo grau de cautela com que protege suas informações de importância similar.

3 Contatos do Suporte F-Store Telefone: +55 (41) Skype: fbits.fstore SOBRE O MANUAL Para que você compreenda como funciona as integrações Web Services, neste manual são incluídas as figuras e a descrição em quadros. Para encontrar alguma questão que você tenha dúvida, pode acessar os índices de Figuras, Quadros ou Sumário, pressionar a tecla Ctrl do teclado e pressionar o botão do mouse na linha que deseja, como no exemplo a seguir: O manual foi dividido em 5 partes. No capítulo 1, descrevemos a introdução aos Web Services, alguns conceitos e notações utilizados. No capítulo 2, são descritos a apresentação e funcionalidades do manual, no capítulo 3, é apresentado o fluxograma geral de integração. Dando sequência ao estudo, no capítulo 4, veremos os cenários possíveis e como é feita a integração com outros softwares.

4 FIGURAS FIGURA 1: FLUXOGRAMA DAS INFORMAÇÕES DO WEBSERVICES FIGURA 2: RESULTADO DE BUSCA- CENÁRIO FIGURA 3: UM RESULTADO E VÁRIOS ATRIBUTOS - CENÁRIO FIGURA 4: RETORNO DO CONTEÚDO CENÁRIO FIGURA 5: PRODUTO PRINCIPAL INDEPENDENTE DE VARIAÇÕES E ATRIBUTOS CENÁRIO FIGURA 6: EXEMPLO DE PRODUTO COM VARIAÇÃO DE CORES FIGURA 7: RETORNO DO CONTEÚDO CENÁRIO FIGURA 8: PRODUTO PRINCIPAL INDEPENDENTE DE SEUS ATRIBUTOS CENÁRIO FIGURA 9: VISUALIZAÇÃO DO PRODUTO CENÁRIO FIGURA 10: RETORNO DO CONTEÚDO DAS TABELAS - CENÁRIO

5 QUADROS QUADRO 1: EXEMPLO DE VARIAÇÃO DE PRODUTO, REFERENCIANDO O PRODUTO PRINCIPAL IDPAI QUADRO 2: IDPAI E O GRUPO VINCULADO (IDVINCULO) CENÁRIO QUADRO 3: PARÂMETROS DOS CENÁRIOS QUADRO 4: PARÂMETROS INTEGRAÇÃO DOS ATRIBUTOS QUADRO 5: PARÂMETROS DA INTEGRAÇÃO DAS INFORMAÇÕES DOS PRODUTOS QUADRO 6: PARÂMETROS ATUALIZAÇÃO DO PRODUTO PREÇO QUADRO 7: PARÂMETRO ATUALIZAÇÃO PRODUTO ESTOQUE QUADRO 8: PARÂMETROS CADASTRO DE IMAGENS DE PRODUTOS QUADRO 9: PARÂMETROS EXCLUSÃO DE IMAGENS DE PRODUTOS QUADRO 10: PARÂMETROS ATUALIZAÇÃO DE ESTOQUE QUADRO 11: PARÂMETROS DE PEDIDOS REALIZADOS NO SITE...28 QUADRO 12: PARÂMETROS INFORMAÇÕES DE PEDIDOS...29 QUADRO 13: PARÂMETROS DE INFORMAÇÕES DO CLIENTE QUADRO 14: PARÂMETROS INFORMAÇÕES DE NEWSLATTER...32 QUADRO 15: PARÂMETROS LISTA DE PRODUTOS QUADRO 16: PARÂMETROS LISTA DE ATRIBUTOS DOS PRODUTOS QUADRO 17: PARÂMETROS LISTA DE SERVIÇOS DO PRODUTO QUADRO 18: PARÂMETROS LISTA DE INFORMAÇÕES DE PAGAMENTO QUADRO 19: PARÂMETROS INFORMAÇÕES DE ASSINATURA QUADRO 20: PARÂMETROS CONFIRMAÇÃO DE PEDIDOS QUADRO 21: PARÂMETROS ATUALIZAÇÃO DE STATUS DE PEDIDOS QUADRO 22: PARÂMETROS ATUALIZAÇÃO DE STATUS DO PEDIDO DELETE RASTREAMENTO QUADRO 23: PARÂMETROS USUÁRIO CADASTRADO NO SITE QUADRO 24: PARÂMETROS USUÁRIO CADASTRADO NO SITE PARTE QUADRO 25: PARÂMETRO INFORMAÇÕES DE NEWSLATTER QUADRO 26: PARÂMETRO USUÁRIO ESPECÍFICO PARTE QUADRO 27: PARÂMETROS USUÁRIO ESPECÍFICO PARTE QUADRO 28: PARÂMETROS INFORMAÇÕES DE NEWSLATTER...43 QUADRO 29: PARÂMETROS CONFIRMAÇÃO USUÁRIOS SINCRONIZADOS QUADRO 30: PARÂMETROS ENDEREÇO DO USUÁRIO PARTE QUADRO 31: PARÂMETROS ENDEREÇO DO USUÁRIO PARTE QUADRO 32: PARÂMETROS CONFIRMAÇÃO DE ENDEREÇO DOS USUÁRIOS SINCRONIZADOS QUADRO 33: PARÂMETROS INCLUI PRODUTO CATEGORIA QUADRO 34: PARÂMETROS DELETAR PRODUTO CATEGORIA QUADRO 35: PARÂMETRO LISTA PRODUTO CATEGORIA PARTE QUADRO 36: PARÂMETRO LISTA PRODUTO CATEGORIA PARTE QUADRO 37: PARÂMETRO INCLUIR CATEGORIA QUADRO 38: PARÂMETRO EXCLUIR CATEGORIA QUADRO 39: PARÂMETROS LISTAR TODAS AS CATEGORIAS PARTE QUADRO 40: PARÂMETROS LISTAR TODAS AS CATEGORIAS PARTE QUADRO 41: PARÂMETRO LISTAR CATEGORIA PARTE QUADRO 42: PARÂMETRO LISTAR CATEGORIA PARTE QUADRO 43: PARÂMETRO BUSCAR PRODUTOID E PRODUTOVARIANTEID PARTE QUADRO 44: PARÂMETRO BUSCAR PRODUTOID E PRODUTOVARIANTEID PARTE QUADRO 45: PARÂMETRO BUSCAR PRODUTOID E PRODUTOVARIANTEID PARTE QUADRO 46: PARÂMETRO BUSCAR PRODUTOID E PRODUTOVARIANTEID PARTE QUADRO 47: PARÂMETRO BUSCAR CATEGORIAID PARTE QUADRO 48: PARÂMETRO BUSCAR CATEGORIAID E CATEGORIACLIENTEID PARTE QUADRO 49: PARÂMETRO BUSCAR PRODUTOID E PRODUTOVARIANTEID PARTE QUADRO 50: PARÂMETRO BUSCAR PRODUTOID E PRODUTOVARIANTEID PARTE QUADRO 51: PARÂMETRO REGISTAR DADO EM CONTA CORRENTE PARTE QUADRO 52: PARÂMETRO REGISTAR DADO EM CONTA CORRENTE PARTE QUADRO 53: HISTÓRICO DE ALTERAÇÕES NO DOCUMENTO....56

6

7 SUMÁRIO 1 INTRODUÇÃO AO WEB SERVICES APRESENTAÇÃO DO DOCUMENTO FLUXOGRAMA GERAL DAS INFORMAÇÕES DEFINIÇÕES DOS WEB SERVICES...11 INTEGRAÇÃO DO PRODUTO...11 Integração do Produto Cenário Integração do Produto Cenário Integração do Produto Cenário Integração dos Atributos do Produto...22 Integração das Informações do Produto...23 ATUALIZAÇÃO DE PRODUTO PREÇO...24 ATUALIZAÇÃO DE PRODUTO ESTOQUE...24 CADASTRO DE IMAGENS DE PRODUTOS...24 Exclusão de Imagens de Produtos...26 ATUALIZAÇÃO DE ESTOQUE...27 PEDIDOS REALIZADOS NO SITE...27 CONFIRMAÇÃO DE PEDIDOS...36 ATUALIZAÇÃO DE STATUS DE PEDIDO...37 Atualização de Status do Pedido Delete Rastreamento...38 USUÁRIO CADASTRADO NO SITE...38 Informações de Newsletter...40 Usuário Cadastrado no Site Informações de newsletter...43 Confirmação de Usuários Sincronizados...43 ENDEREÇO DO USUÁRIO CADASTRADO NO SITE...44 Confirmação de Endereço dos Usuários Sincronizados...45 INCLUI PRODUTO CATEGORIA...46 Deletar Produto Categoria...46 Listar Produto Categoria...47 INCLUIR CATEGORIA...48 Excluir Categoria...48 Listar Todas as Categorias...49 Seleciona Categoria...49 BUSCA LISTA DE PRODUTOID POR LISTA DE SKU...50 BUSCA PRODUTOID POR LISTA DE SKU...50 BUSCA LISTA DE CATEGORIAID POR LISTA DE CATEGORIACLIENTEID...51 BUSCA CATEGORIAID POR CATEGORIACLIENTEID...51 REGISTRO DE CONTA CORRENTE HISTÓRICO DE ALTERAÇÕES DO DOCUMENTO...53

8 1 INTRODUÇÃO AO WEB SERVICES Web Service é uma solução utilizada na integração de sistemas e na comunicação entre aplicações diferentes. Com esta tecnologia é possível que novas aplicações possam interagir com aquelas que já existem e que sistemas desenvolvidos em plataformas diferentes sejam compatíveis. Os Web Services são componentes que permitem às aplicações enviar e receber dados em formato XML (Extensible Markup Language). Cada aplicação pode ter a sua própria "linguagem", que é traduzida para uma linguagem universal, o formato XML. Para as empresas, os Web Services podem trazer agilidade para os processos e eficiência na comunicação entre cadeias de produção ou de logística. Toda e qualquer comunicação entre sistemas passa a ser dinâmica e principalmente segura, pois não há intervenção humana. Utilizando a tecnologia Web Service, uma aplicação pode invocar outra para efetuar tarefas simples ou complexas mesmo que as duas aplicações estejam em diferentes sistemas e escritas em linguagens diferentes. Por outras palavras, os Web Services fazem com que os seus recursos estejam disponíveis para que qualquer aplicação cliente possa operar e extrair os recursos fornecidos pelo Web Service. O objetivo dos Web Services é a comunicação de aplicações através da Internet. Esta comunicação é realizada com intuito de facilitar a integração entre as aplicações de uma empresa, ou seja, a interoperabilidade entre as informações que trafegam entre dois pontos nas diferentes aplicações como, por exemplo, o comércio eletrônico com clientes e fornecedores. Outro objetivo é definir um workflow entre as aplicações e constituir uma alternativa aos ERP (Enterprise Resource Planning). Com um workflow é possível otimizar, controlar processos e tarefas de uma determinada organização.

9 2 APRESENTAÇÃO DO DOCUMENTO Este documento apresenta um padrão para a troca de informações entre a plataforma de e-commerce da e-commerce Store e o ERP de seu cliente. Baseado nas informações necessárias para a implementação de cada tipo de serviço / produto, o padrão define um conjunto de registros/campos compõem os Web Services de integração.

10 3 FLUXOGRAMA GERAL DAS INFORMAÇÕES O fluxo de informações abaixo mostra uma visão geral de como será realizado a troca de informações entre as empresas: Figura 1: Fluxograma das informações do WebServices. Onde: 1. Aplicação e-commerce Store : sistema e-commerce 2. Soap message: comunicação entre os sistemas. SOAP (Simple Object Access Protocol) baseia-se numa chamada remota de um método e para tal necessita especificar o endereço do componente, o nome do método e os argumentos para esse método. 3. WS e-commerce Store: utilizado para a troca dos dados. 4. Serviços: serviço do cliente que vai receber ou retornar dados. 5. HTTP: utilizado para transportar de dados. 6. Aplicação Cliente: sistemas ERP ou serviço de integração.

11 4 DEFINIÇÕES DOS WEB SERVICES Para os layouts abaixo definidos, aplicam-se as seguintes convenções: 1. Para campos do tipo Decimal, o tamanho exibe a quantidade de caracteres que podem ser enviados como números inteiros, e a quantidade de caracteres que podem ser enviados como decimais: Por exemplo: 15,4 significa 15 inteiros e 4 decimais; 2. Os campos que possuem valores pré-definidos, apresentam esses valores na coluna Descrição ; 3. Os Web Services que recebem alguma informação normalmente retornam um valor Boolean, indicando se o registro foi recebido e processado com sucesso (retorna True ) ou não (retorna False ). Alguns deles podem retornar outros valores, como o Id do item cadastrado. INTEGRAÇÃO DO PRODUTO Para os layouts abaixo definidos, aplicam-se as seguintes convenções: 4. Para campos do tipo Decimal, o tamanho exibe a quantidade de caracteres que podem ser enviados como números inteiros, e a quantidade de caracteres que podem ser enviados como decimais: Por exemplo: 15,4 significa 15 inteiros e 4 decimais. 5. Os campos que possuem valores pré-definidos, apresentam esses valores na coluna Descrição. 6. Os Web Services que recebem alguma informação normalmente retornam um valor Boolean, indicando se o registro foi recebido e processado com sucesso (retorna True ) ou não (retorna False ). Alguns deles podem retornar outros valores, como o Id do item cadastrado.

12 Integração do Produto Cenário 1 Neste cenário temos os produtos e seus respectivos atributos. No exemplo abaixo, os três produtos são apresentados separadamente no resultado da busca. Figura 2: Resultado de busca- Cenário 1. Nesta situação não existe variações de produtos, ao informar o produto não deve ser informado o idpai e nem o idvinculo, conforme demostrado na tabela abaixo: Não possui idpai e nem idvinculo (grupo) idretornado KU Nome idpai idvinculo Anel em Ouro Amarelo com Granada e Diamantes null null Anel de Ouro com Granada e Diamantes null null Anel Coração com Granada Verde e Diamantes null null Na visualização de cada produto são apresentados os seus atributos:

13 Atributos do produto Figura 3: Um resultado e vários atributos - Cenário 1. O exemplo acima representa um produto com um único sku e varios atributos, ou seja varios tamanhos de aros diferentes para o mesmo produto.

14 Abaixo demostramos como deverá ser retornado o conteudo das tabelas segundo o exemplo acima. Figura 4: Retorno do conteúdo Cenário 1.

15 Integração do Produto Cenário 2 Neste cenário temos os produtos e suas variações. No resultado da busca é apresentado apenas o produto principal (idpai = null), independente das suas variações e atributos. Figura 5: Produto principal independente de variações e atributos Cenário 2. Nesta situação existem variações de produtos. Ao informar o produto principal, o idpai deve ser null, assim como o idvinculo. As variações dos produtos serão cadastradas referenciando o produto principal como sendo o idpai, conforme demostrado na tabela abaixo:

16 idretornado SKU Nome idpai idvinculo 1 Lentes de Contato EXPRESSIONS COLORS null null Lentes de Contato EXPRESSIONS COLORS - Azul 1 null Lentes de Contato EXPRESSIONS COLORS - Cinza 1 null 4 24 Lentes de Contato EXPRESSIONS COLORS - Verde 1 null 5 25 Lentes de Contato EXPRESSIONS COLORS - Pure hazel Quadro 1: Exemplo de variação de produto, referenciando o produto principal idpai. null Na visualização do produto são apresentadas as suas variações de cores. Figura 6: Exemplo de produto com variação de cores. O exemplo acima é representado por um produto principal (idpai) que contém 4 variações de cores, cada cor possui um sku diferente. Abaixo demostramos como deverá ser retornado o conteúdo das tabelas segundo o exemplo acima.

17 Figura 7: Retorno do conteúdo Cenário 2.

18 Integração do Produto Cenário 3 Neste cenário temos variações de produtos e grupo de produtos na visualização do produto. No resultado da busca é apresentado apenas o produto principal (idpai = null), independente dos seus atributos. Figura 8: Produto principal independente de seus atributos Cenário 3. Nesta situação existem variações de produtos. Ao informar o produto principal, o idpai deve ser null e o idvinculo deve ser informado. As variações dos produtos serão cadastradas referenciando o produto principal como sendo o idpai e o grupo vinculado (idvinculo), conforme demonstrado na tabela abaixo:

19 idretornado SKU Nome idpai idvinculo 1 Tênis Converse All Star Star Player Ev Ox Rosa null Tênis Converse All Star Star Player Ev Ox Rosa Tamanho Tênis Converse All Star Star Player Ev Ox Rosa Cor Rosa Quadro 2: idpai e o grupo vinculado (idvinculo) Cenário Na visualização do produto são apresentados os seus atributos de tamanho e outros produtos pertencentes ao mesmo grupo. Figura 9: Visualização do produto Cenário 3. O exemplo acima é representado por um produto principal (idpai) que contem inúmeras variações de tamanhos, cada tamanho possui um sku diferente. Abaixo demostramos como deverá ser retornado o conteudo das tabelas segundo o exemplo acima.

20 Figura 10: Retorno do conteúdo das tabelas - Cenário 3.

21 Parâmetros: Token Chave de acesso aos web.services String - X SKU Código interno do produto String 50 X CodigoProdutoVi nculoredirect IdPai Código para realizar direcionamento de URL. Exemplo:redirecionamento URL site antigo para URL site novo OBS.:Caso o cliente já tenha loja virtual é obrigatório o preenchimento deste campo Id do produto que vincula os variantes, caso haja variantes. String 100 Long - Se IdPai for informado os dados do mesmo serão atualizados. IdVinculo Id do produto que vincula os diversos produtos variantes Long - Exemplo: Produto A ; cor preta ; tamanho : 36 e 38 Produto B : cor branca ; tamanho 36 e 38 Nome Nome do produto String 100 X PrecoCusto Preço de custo Decimal 15,4 X PrecoDe Preço normal Decimal 15,4 X PrecoPor Preço promocional, caso haja. Se não houver, deve ser igual ao PrecoDe Decimal 15,4 X PrazoEntrega Prazo de entrega em dias Int - X FreteGratis 1 = Sempre 2 = Nunca 3 = Neutro (produto que não possui uma Int - X regra fixa, ele varia de acordo com a regra geral do site exemplo: valor mínimo do pedido). TrocaGratis Se o produto possui troca grátis ou não Boolean - X EstoqueFisico Quantidade de estoque físico Int - X Peso Peso produto Double - Altura Altura produto Double - Comprimento Comprimento do produto Double - Largura Largura produto Double - DataCriacao Data cadastro produto DateTim e - DataAtualizacao Data alteração produto DateTim e - Garantia Garantia em meses de um determinado produto. Int - FabricanteNome Nome do fabricante String 100 Autor Caso o produto seja livro ou algo do gênero. String 100 Editora Caso o produto seja livro ou algo do gênero. String 100 Colecao Caso o produto seja livro ou algo do gênero. String 100 IsTelevendas Venda somente por telefone Boolean - Quadro 3: Parâmetros dos cenários.

22 Integração dos Atributos do Produto Através deste mesmo Web Service, podem ser enviados cada um dos atributos dos produtos cadastrados. Parâmetros: PedidoProdutoId Nome Valor Tipo Deve receber sempre zero, utilizado para vincular o valor do atributo com o produto do pedido. (não utilizar - campo interno) Nome do atributo, descrevendo a unidade (exemplo: Tamanho ml ) O valor do atributo, sem unidade de medida (exemplo: 100, para 100 ml) 1 Selecao 2 Filtro 3 Comparacao Int - String 2000 X String 2000 X ExibirAtributo Marca se o atributo é exibido no site Boolean - Caso haja variação no preço desse atributo, VariacaoPreco adicionar a diferença nesse campo. Quadro 4: Parâmetros Integração dos Atributos. Int Decimal 15,4

23 Integração das Informações do Produto Através deste mesmo Web Service, podem ser enviadas as informações relevantes ao produto. Obs.: Sempre deve-se enviar todas as informações e não somente as que deseja atualizar / inserir. Parâmetros: O tipo da informação sendo cadastrada, identificada pelo código a seguir 1- Informações 2- Benefícios 3- Especificações 4- Dados Técnicos 5- Composição TipoInformacaoProdId 6- Modo de Usar 7- Cuidados 8- Itens Inclusos 9- Dicas 10- Vídeo 11- Descrição 12- Valor Referente 13- PopUp Referente Int - X Titulo O título da informação. String 200 X Texto O conteúdo da informação, que pode ser String 8000 X formatado em HTML. Quadro 5: Parâmetros da integração das informações dos produtos. Retorno: Boolean onde true = produto inserido com sucesso!

24 ATUALIZAÇÃO DE PRODUTO PREÇO ( ) Update Neste Web Service devem ser enviadas as atualizações sobre o preço de cada produto. Parâmetros: Token Chave de acesso aos web.services String - X SKU Código interno do produto String 50 X PrecoCusto Preço de custo Decimal 15,4 X PrecoDe Preço normal Decimal 15,4 X PrecoPor Preço promocional, caso haja. Se não houver, deve ser igual ao PrecoDe Decimal 15,4 X Quadro 6: Parâmetros atualização do produto preço. Retorno: Boolean onde true = preço produto atualizado com sucesso! ATUALIZAÇÃO DE PRODUTO ESTOQUE ( ) - Update Neste Web Service devem ser enviadas as atualizações sobre o saldo disponível de cada produto no estoque. Parâmetros: Token Chave de acesso aos web.services String - X SKU Código interno do produto String 50 X Saldo disponível do produto em SaldoDisponivel estoque Int - X Quadro 7: Parâmetro atualização produto estoque. Retorno: Boolean onde true = saldo disponível atualizado com sucesso! CADASTRO DE IMAGENS DE PRODUTOS ( ) - Insert

25 Neste Web Service são cadastradas as imagens dos produtos. Elas devem ser enviadas na maior resolução possível, para serem redimensionadas e exibidas no site. As imagens devem ser convertidas em uma string de base 64bits para serem enviadas ao serviço. Parâmetros: Token Chave de acesso aos web.services String - X SKU SKU do produto que a imagem se refere String 60 X imagembase64 Imagem convertida em texto 64 bits String - X Formato que a imagem estava antes imagemformato de convertida (exemplo: jpeg, bmp, gif, png) String - X isprincipal Se é a imagem principal do produto Boolean - X Quadro 8: Parâmetros cadastro de imagens de produtos. Retorno: Boolean onde true = foto cadastrada com sucesso!

26 Exclusão de Imagens de Produtos ( ) - SyncClear Apaga todas as fotos cadastradas para um produto. Parâmetros: Token Chave de acesso aos web.services String - X SKU SKU do produto variante cadastrado String 50 X Quadro 9: Parâmetros exclusão de imagens de produtos. Retorno: Boolean onde true = foto excluída com sucesso!

27 ATUALIZAÇÃO DE ESTOQUE ( ) - Update Neste Web Service devem ser enviadas as atualizações sobre o estoque de cada produto. Apenas as informações fornecidas são atualizadas, as demais são mantidas como estão no sistema. Parâmetros: Token Chave de acesso aos web.services String - X SKU SKU do produto variante cadastrado. Long - X Quantidade Quantidade do produto disponível em estoque Int - Disponivel Se o produto está disponível para venda Boolean - ValorCusto Preço de custo Decimal 15,4 Valido Se o produto é valido para exibição (apenas os válidos são apresentados para venda) Boolean - QuantidadeReservada Quantidade do produto reservado Int - PrecoDe O preço de custo do produto Decimal 15,4 PrecoPor O preço de venda do produto Decimal 15,4 Token Chave de acesso aos web.services String - X SKU SKU do produto variante cadastrado. Long - X Quantidade do produto disponível em Quantidade estoque Quadro 10: Parâmetros Atualização de estoque. Int - Retorno: Boolean onde true = estoque sincronizado com sucesso! PEDIDOS REALIZADOS NO SITE ( ) - GetItems Este Web Service disponibiliza uma lista com os pedidos realizados no site e que ainda não foram integrados ao ERP. Sendo a estrutura dividida em três partes:

28 Parâmetro: Campo Significado Tipo Tamanho Obrigatório Token Chave de acesso ao web.service String - X Quadro 11: Parâmetros de pedidos realizados no site. Retorno: lista com 20 itens, onde temos: 1. Informações do pedido; 1.1 Informações do cliente; Informações de newsletter; 1.2 Lista dos produtos; Lista de informações dos produtos; Lista de serviços dos produtos; 1.3 Lista de informações de pagamento; 1.4 Informações de assinatura;

29 1. - Informações do pedido PedidoId Número do pedido Long - X UsuarioId Id do usuário que realizou o pedido Long - X DataPedido Data que foi realizado o pedido DateTime - X NomeDestino Nome do destinatário String 100 X Endereco Endereço de entrega String 200 X Numero Número do endereço de entrega String 20 X Complemento Descrição do complemento de entrega String 50 X Bairro Descrição do Bairro String 50 X Cidade Descrição da Cidade String 50 X Estado Descrição da UF String 2 X Cep Cep de entrega pedido String 10 X RG Rg do comprador String 50 Parcelas Numero de parcelas Boleto ou Cartão Int ValorFrete Valor do frete total para o Cliente Decimal 15,4 X ValorFreteEmpresa Valor do frete total para a Empresa Decimal 15,4 TransportadoraFrete Id da Transportadora Int - X ValorPedido Valor total do pedido Decimal 15,4 X Ip Endereço IP do computador que efetuou o pedido. String - PrazoEnvio Prazo de envio do pedido Int - LinhaDigitalBoleto Linha digitavel do boleto String - NumeroCupomDesco Número do cupom vale presente, caso nto tenha sido usado String 50 ValorCupomDesconto Valor do cupom vale presente, caso exista. Decimal 15,4 Status do Pedido, conforme código abaixo 1. Pago 2. Aguardando Liberação 3. Cartão Temporariamente Negado 4. Cartão Negado Status 5. Fraude int - 6. Suspeito de Fraude 7. Boleto Expirado 8. Cancelado 9. Enviado 10. Liberado 11. Faturado - Nota fiscal emitida Subtotal Valor do pedido sem juros ou frete Decimal 15,4 ValorJuros Se a compra foi feita com juros, apresenta o valor dos juros Decimal 15,4 ValorParcelas Valor de cada parcela, se a compra foi parcelada Decimal 15,4 ValorServicos Valor dos serviços dos itens do pedido. Decimal 15,4 ParceiroId Id do parceiro pelo qual feito a compra. Int TabelaPrecoId Id da tabela de preço ao qual o preço se refere. Int Quadro 12: Parâmetros informações de pedidos.

30 1.1 Informações do cliente UsuarioId Id do usuário que realizou o pedido. Int - X EcommerceId Identifica em qual site o cliente esta cadastrado, se houver apenas um é 1 Int - X TipoPessoaId 1 - Física Int - X OrigemContatoI d 2 Jurídica 1 - Google Int Bing 3 - Jornal 4 - Patrocínio Esportivo 5 - Recomendação de alguém 6 - Revista 7 - Site na Internet 8 - Televisão 9 Outro EnderecoResid encialid Id do endereço residencial Int - EnderecoEntre gaid Id do endereço de entrega selecionado Int - TipoSexoId 1 - Masculino Int - FormaPagame ntoid 2 Feminino 1-Boleto Int - 2-PayPal 3-Visa 4-MasterCard 5-American Express 6-Diners 7-Aura 8-Hipercard 9-Google Checkout 10-ELO 11-Deposito Bancario 12-Moip 13-Créditos VP 14-Discover 15-Mercado Pago 16-Promocao 17-FastCash Deposito 18-FastCash Transferencia 19-FastCash Financiamento 99-Pagamento Marketplace Extra

31 TipoPreferenciaUsuarioId Corresponde à ordenação padrão utilizada no site como preferência do usuário: 0 Indefinido 1 - Marcas 2 - Preços 3 - Mais Vendidos Int - Nome Nome do usuário String 100 X CPF CPF do usuário String 20 usuário String 100 X RG RG usuário String 12 OrgaoEmissor Orgão emissor String - NomeMae Nome da mãe String - TelefoneResidencial Número do telefone residencial String 20 TelefoneCelular Número do telefone celular String 20 TelefoneComercial Número do telefone comercial String 20 DataNascimento Data de nascimento obrigatório para pagamento de pedido com cartão de DateTime - crédito. RazaoSocial Razão social do usuário, campo obrigatório para pedidos de pessoa String 100 Jurídica. CNPJ CNPJ do usuário, campo obrigatório para pedidos de pessoa Jurídica. String 20 InscricaoEstadual Inscrição Estadual usuário. String 20 Responsavel Nome da pessoa resposável pela pessoa jurídica String 100 DataCriacao Data de cadastro usuário DateTime - X DataAtualizacao Data de alteração usuário sistema DateTime - Endereco Endereço usuário String 200 Numero Número endereço usuário String 20 Complemento Complemento endereço usuário String 50 Bairro Bairro usuário String 50 Cidade Cidade usuário String 50 Estado Estado usuário String 2 CEP CEP usuário String 10 ParceiroID Id do parceiro pelo qual feito a compra. Int - Quadro 13: Parâmetros de informações do cliente.

32 1.1.1 Informações de newsletter Número de referência do cadastro IntegracaoNewsletterId Int - de newsletter UsuarioId Id do usuário que realizou o pedido Int - Nome Nome do usuário String usuário String 100 DataCadastro Data de cadastro do usuário na newsletter Datetime - Status Status do cadastro. Boolean - Sexo 1 - Masculino String 100 DoubleOptInValido 2 Feminino xxxxxxxxxxxxxxxxxxxxxxxxxxxx xxx DataAceitacaoOptIn Data que o usuário aceitou o envio de newsletter IPAceitacaoOptIn Ip da máquina no usuário quando aceitou o envio de newsletter Quadro 14: Parâmetros informações de newslatter. Boolean - Datetime - String Lista de produtos PedidoId Id do pedido Long - X ProdutoVarianteId Id do produto long - X Combo Se o produto fizer parte de um combo de produtos long - SKU SKU do Produto String 50 X Nome Nome do Produto String 100 X Descricao Descrição do produto String 100 PesoUnitario Peso de cada unidade do produto Double - PesoTotal Peso do produto Double - PrecoUnitario Preço de cada unidade do produto Decimal 15,4 Preco_Venda Preço do produto Decimal 15,4 PrecoRateado Rateio do frete com o desconto - ValorJuros Valor de juros do item, caso exista Decimal 15,4 DataCriacao Data de criação do pedido Datetime - DataAtualizacao Data da última atualização nesse item do pedido Datetime - ProdutoQuantidade Quantidade itens comprados Int - X UrlImagem Caminho da imagem do produto String - Tipo Se é um produto principal (Pai) ou um dos variantes ( Filho) String - PedidoProdutoId Id do Produto neste pedido Long - Brinde Informa se o produto é brinde Boolean - X Quadro 15: Parâmetros lista de produtos.

33 1.1.2 Lista de atributos dos produtos Nome Nome do atributo String 2000 X Valor Valor selecionado do atributo String 2000 X Quadro 16: Parâmetros lista de atributos dos produtos Lista de serviços do produto ServicoId Id do serviço Int - Descricao Decrição do serviço vinculado String 1000 DescricaoPreco Decrição do preço do serviço vinculado Decimal 15,4 IdPreco Id do preço Int - Nome Nome do serviço vinculado String 1000 PrecoServico Preço do serviço vinculado Decimal 15,4 PrecoServicoTotal Preço total do serviço vinculado (quantidade * total) Decimal 15,4 PedidoProdutoId Id do produto Int - PedidoProdutoAco nteceservicoid Id do serviço vinculado ao produto Int - Quantidade Quantidade de serviços comprados Int - Tempo Tempo do serviço vinculado ao produto String - Validador Validador do serviço vinculado String - ContratoGarantia Aceito do contrato do serviço String - Quadro 17: Parâmetros lista de serviços do produto. 1.3 Lista de informações de pagamento PedidoPagamentoId Id do pagamento Int - PedidoId Id do pedido Int - FormaPagamentoId Id da forma de pagamento Int - NumeroParcelas ValorParcela Número de parcelas (caso seja cartão de crédito ou outra forma de pagamento que aceite parcelamento) Valor das parcelas (caso seja cartão de crédito ou outra forma de pagamento que aceite parcelamento) Decimal 15,4 Decimal 15,4 ValorDesconto Valor do desconto Decimal 15,4 ValorJuros Valor do juros Decimal 15,4 ValorTotal Valor total do pedido Decimal 15,4 ValidadeCartaoCredito Uso interno String - Quadro 18: Parâmetros lista de informações de pagamento.

34

35 1.4 Informações de assinatura PedidoId Id do pedido Int - AssinaturaId Id da assinatura Int - GrupoAssinaturaId Id do grupo da assinatura Int - GrupoAssinaturaNome Nome do grupo da assiantura String 50 TipoPeriodo Tipo do período da assinatura (semanal, quinzenal ou mensal) String 25 TempoPeriodo Tempo do período da assinatura Int - Percentual de desconto recebido PercentualDesconto pelo usuário Quadro 19: Parâmetros informações de assinatura. Decimal 15,4

36 CONFIRMAÇÃO DE PEDIDOS ( ) - Complete Através deste Web Service, ocorre a confirmação da sincronização dos pedidos. Isso fará com que esse pedido não seja disponibilizado novamente no Web Service Pedidos realizados no site. Parâmetros: Token Chave de acesso aos webservices String - X PedidoId Id do pedido sincronizado Long - X Quadro 20: Parâmetros confirmação de pedidos. Retorno: Boolean onde true = pedido sincronizado com sucesso!

37 ATUALIZAÇÃO DE STATUS DE PEDIDO ( ) - UpdateStatus Através deste Web Service, devem ser enviados as alterações nos status dos pedidos. Esses status serão atualizados no site e exibidos aos clientes. Parâmetros: Token Chave de acesso aos web.services String - X PedidoId Número do pedido Long - X ProdutoVarianteId Número do produto variante Long - Quantidade Quantidade do item Int - SituacaoPedidoId Código da situação do pedido: 1 -Pago 2 -Aguardando Liberação 3 -Cartão Temporariamente Negado 4 -Cartão Negado 5 -Fraude 6 -Suspeito de Fraude 7 -Boleto Expirado 8 -Cancelado 9 -Enviado 10 -Liberado 11 -Faturado - Nota fiscal emitida Int - X Rastreamento Código de rastreamento do pedido String 50 X DataEvento Data baixa pedido financeiro DateTime - NumeroNotaFiscal Número nota fiscal String 60 ChaveAcessoNFE Chave de acesso a notal fiscal eletrônica String 50 UrlNFE Url da nota fiscal eletrônica String 100 SerieNFE Série da notal fiscal eletrônica String 100 UrlRastreamento Link de rastreamento do pedido String 300 Quadro 21: Parâmetros atualização de status de pedidos. Sendo que: 1. Se estes itens não forem enviados o rastreamento será marcado para todo o Pedido. 2. Se produtovarianteid for enviado, o rastreamento será marcado para um dos produtos do item. 3. Se produtovarianteid e Quantidade forem enviados, o rastreamento será marcado para a quantidade de produtos do item.

38 Retorno: Boolean onde true = status alterado com sucesso! Atualização de Status do Pedido Delete Rastreamento ( - DeleteRastreamento Através Deste Web Service, podem ser deletados os códigos de rastreamento do pedido para nova inserção ou correção. Esses status serão atualizados no site e exibidos aos clientes. Parâmetros: Token Chave de acesso aos web.services String - X PedidoId Número do pedido Long X Quadro 22: Parâmetros atualização de status do pedido delete rastreamento. Retorno: Boolean onde true = excluído com sucesso! USUÁRIO CADASTRADO NO SITE ( ) GetItems Este Web Service disponibiliza uma lista com os usuários cadastrados no site que ainda não foram integrados ao ERP. Parâmetro: Campo Significado Tipo Tamanho Obrigatório Token Chave de acesso aos web.services String - X Quadro 23: Parâmetros usuário cadastrado no site. Retorno: Lista com 20 Itens Campo Significado Tipo Tamanho Obrigatório UsuarioId Id do usuário no sistema Long - X EcommerceId TipoPessoaId OrigemContatoId Identifica em qual site o cliente esta cadastrado, se houver apenas um é 1 1 Física 2 Jurídica Int - Int - X

39 EnderecoResidencialId Código endereço residencial Long - EnderecoEntregaId Código endereço de entrega. Long - TipoSexoId FormaPagamentoId TipoPreferenciaUsuario Id 1 Masculino 2 Feminino Forma de pagamento preferencial do usuário: 1-Boleto 2-PayPal 3-Visa 4-MasterCard 5-American Express 6-Diners 7-Aura 8-Hipercard 9-Google Checkout 10-ELO 11-Deposito Bancario 12-Moip 13-Créditos VP 14-Discover 15-Mercado Pago 16-Promocao 17-FastCash Deposito 18-FastCash Transferencia 19-FastCash Financiamento 99-Pagamento Marketplace Extra Corresponde à ordenação padrão utilizada no site como preferência do usuário: 0 - Indefinido 1 Marcas 2 Preços 3 Mais Vendidos Int - Int - X Int - Nome Nome do usuário String 100 X CPF CPF do usuário String 50 usuário String 100 X RG RG usuário String 12 OrgaoEmissor Orgão emissor String - NomeMae Nome da mãe String 100 TelefoneResidencial Número do telefone residencial String 20 TelefoneCelular Número do telefone celular String 20 TelefoneComercial Número do telefone comercial String 20 DataNascimento Data de nascimento DateTime -

40 RazaoSocial CNPJ Razão social do usuário, campo obrigatório para pedidos de pessoa Jurídica. CNPJ do usuário, campo obrigatório para pedidos de pessoa Jurídica. String 100 String 20 InscricaoEstadual Inscrição Estadual usuário. String 20 Responsavel Nome da pessoa resposável pela pessoa jurídica String 100 DataCriacao Data de cadastro usuário DateTime - X DataAtualizacao Data de alteração usuário sistema DateTime - Endereco Endereço usuário String 200 Numero Número endereço usuário String 20 X Complemento Complemento endereço usuário String 50 X Bairro Bairro usuário String 50 X Cidade Cidade usuário String 50 X Estado Estado usuário String 2 X CEP CEP usuário String 10 X ParceiroID Id do parceiro por onde o cliente fez a compra Int Quadro 24: Parâmetros usuário cadastrado no site Parte 2. Informações de Newsletter Informações de newsletter IntegracaoNewsletterId Número de referência do cadastro de newsletter Int - UsuarioId Id do usuário que realizou o pedido Int - Nome Nome do usuário String usuário String 100 DataCadastro Data de cadastro do usuário na newsletter Datetime - Status Status do cadastro. Boolean - Sexo 1 - Masculino String Feminino DoubleOptInValido xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx Boolean - DataAceitacaoOptIn Data que o usuário aceitou o envio de newsletter Ip da maquina no usuário quando aceitou IPAceitacaoOptIn o envio de newsletter Quadro 25: Parâmetro informações de newslatter. Datetime - String 100

41 Usuário Cadastrado no Site ( ) Select Este Web Service busca e exibe as informações de um usuário específico, localizado por id. Parâmetro: Campo Significado Tipo Tamanho Obrigatório Token Chave de acesso aos web.services String - X UsuarioId Id do usuário no sistema Long - X Quadro 26: Parâmetro usuário específico Parte 1. Retorno: Uma lista com os dados deste usuário. Campo Significado Tipo Tamanho Obrigatório UsuarioId Id do usuário no sistema Long - X EcommerceId Identifica em qual site o cliente esta cadastrado, se houver apenas um é 1 Int - TipoPessoaId 1 Física Int - X OrigemContatoId 2 Jurídica EnderecoResidencialId Código endereço residencial Long - EnderecoEntregaId Código endereço de entrega. Long - TipoSexoId 1 Masculino Int - FormaPagamentoId 2 Feminino Forma de pagamento preferencial do usuário: 1-Boleto 2-PayPal 3-Visa 4-MasterCard 5-American Express 6-Diners 7-Aura 8-Hipercard 9-Google Checkout 11-Deposito Bancário 13-ELO Corresponde à ordenação padrão TipoPreferenciaUsuarioId utilizada no site como preferência do usuário: 0 - Indefinido Int - X Int -

42 1 Marcas 2 Preços 3 Mais Vendidos Nome Nome do usuário String 100 X CPF CPF do usuário String 50 usuário String 100 X RG RG usuário String 12 OrgaoEmissor Orgão emissor String - NomeMae Nome da mãe String 100 TelefoneResidencial Número do telefone residencial String 20 TelefoneCelular Número do telefone celular String 20 TelefoneComercial Número do telefone comercial String 20 DataNascimento Data de nascimento DateTime - RazaoSocial CNPJ Razão social do usuário, campo obrigatório para pedidos de pessoa Jurídica. CNPJ do usuário, campo obrigatório para pedidos de pessoa Jurídica. String 100 String 20 InscricaoEstadual Inscrição Estadual usuário. String 20 Responsavel Nome da pessoa resposável pela pessoa jurídica String 100 DataCriacao Data de cadastro usuário DateTime - X DataAtualizacao Data de alteração usuário sistema DateTime - Endereco Endereço usuário String 200 Numero Número endereço usuário String 20 X Complemento Complemento endereço usuário String 50 X Bairro Bairro usuário String 50 X Cidade Cidade usuário String 50 X Estado Estado usuário String 2 X CEP CEP usuário String 10 X Id do parceiro por onde o cliente fez a ParceiroID compra Quadro 27: Parâmetros usuário específico Parte 2. Int

43 Informações de newsletter Informações de newsletter IntegracaoNewsletterId Número de referência do cadastro de newsletter Int - UsuarioId Id do usuário que realizou o pedido Int - Nome Nome do usuário String usuário String 100 DataCadastro Data de cadastro do usuário na newsletter Datetime - Status Status do cadastro. Boolean - Sexo 1 - Masculino 2 Feminino String 100 DoubleOptInValido xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx Boolean - DataAceitacaoOptIn Data que o usuário aceitou o envio de newsletter IPAceitacaoOptIn Ip da máquina no usuário quando aceitou o envio de newsletter Quadro 28: Parâmetros informações de newslatter. Datetime - String 100 Confirmação de Usuários Sincronizados ( ) - Complete Através deste Web Service, a confirmação da sincronização dos usuários. Isso fará com que esse usuário não seja disponibilizado novamente no Web Service Usuários cadastrados no site, até que ele faça uma alteração no seu cadastro. Parâmetros: Token Chave de acesso aos web.services String - X UsuarioId Id do usuário no sistema Long - X Quadro 29: Parâmetros confirmação usuários sincronizados. Retorno: Boolean onde true = sincronizado com sucesso!

44 ENDEREÇO DO USUÁRIO CADASTRADO NO SITE ( ) - GetItems Este Web Service disponibiliza uma lista de endereços dos usuários cadastrados no site e que ainda não foram integrados ao ERP. Parâmetro: Token Chave de acesso aos web.services String - X Quadro 30: Parâmetros endereço do usuário Parte 1. Retorno: Lista com 20 itens Campo Significado Tipo Tamanho Obrigatório UsuarioId Código usuário sistema Long - X CPF CPF do usuário, caso pessoa fisica String - CNPJ CNPJ da empresa, caso pessoa juridica String - EnderecoId Código endereço Long - X Endereco Endereço usuário String 500 X Numero Número endereço usuário String 50 X Complemento Complemento endereço usuário String 100 Bairro Bairro di endereço String 100 X Cidade Cidade do endereço String 100 X Estado Estado do endereço String 100 X CEP CEP do endereço String 50 X TelefoneResidencial Número do telefone residencial String 20 TelefoneCelular Número do telefone celular String 20 TelefoneComercial Número do telefone comercial String 20 Quadro 31: Parâmetros endereço do usuário Parte 2.

45 Confirmação de Endereço dos Usuários Sincronizados ( ) - Complete Através deste Web Service, ocorre a confirmação da sincronização dos endereços dos usuários. Esse processo fará com que esse endereço não seja disponibilizado novamente no Web Service Endereço do usuário cadastrado no site, até que ele faça uma alteração no seu cadastro. Parâmetro: Token Chave de acesso aos web.services String - X EnderecoId Código do endereço sincronizado Long - X Quadro 32: Parâmetros confirmação de endereço dos usuários sincronizados. Retorno: Boolean onde true = sincronizado com sucesso!

46 INCLUI PRODUTO CATEGORIA ( ) Insert Através deste Web Service inclui-se um produto em uma categoria. Parâmetro: Token Chave de acesso aos web.services string - X SKU Código do produto int - X CategoriaClienteId Código da categoria do cliente int - X Quadro 33: Parâmetros inclui produto categoria. Categoria. Retorno: ProdutoCategoriaId = Código de relacionamento entre Produto e Deletar Produto Categoria ( ) Delete Através deste Web Service deleta-se um produto de uma categoria, todos os produtos de uma categoria ou todas as categorias de um produto, dependendo dos parâmetros informados. Token Chave de acesso aos web.services string - X CategoriaClienteId Código da categoria do cliente int - X SKU Código do produto int - X Quadro 34: Parâmetros deletar produto categoria. Retorno: Bolean true = excluído com sucesso!

47 Listar Produto Categoria ( ) GetItems Web Service que retorna os produtos relacionados a uma categoria, as categorias relacionados a um produto ou verifica se um produto pertence a uma categoria, dependendo dos parâmetros informados. Caso nenhum parâmetro seja informado retorna todos os relacionamentos categoria x produto. Parâmetros: Token Chave de acesso aos web.services string - X CategoriaClienteId Código da categoria do cliente, caso não seja informado retorna todas as categorias int - do produto SKU Código do produto, caso não seja informado retorna todos os itens da categoria int - Quadro 35: Parâmetro lista produto categoria Parte 1. do cliente. Retorno: Uma lista com os dados de relacionamento entre produto e categoria CategoriaClienteId Código da categoria do cliente int - SKU Código do produto int - Quadro 36: Parâmetro lista produto categoria Parte 2.

48 INCLUIR CATEGORIA ( ) Insert Através deste Web Service cria-se uma nova categoria. Parâmetro: Token Chave de acesso aos web.services String - X Nome Nome da categoria String 100 X Código da categoria do cliente a qual CategoriaClientePaiId está subordinada Se CategoriaClienteId for informado CategoriaClienteId os dados do mesmo serão atualizados. Quadro 37: Parâmetro incluir categoria. int - Int - Retorno: Boolean: true caso a categoria seja adicionada com sucesso. Excluir Categoria ( ) Delete Através deste Web Service apaga-se uma categoria. Parâmetro: Token Chave de acesso aos web.services string - X CategoriaClienteId Código da Categoria do cliente int - X Quadro 38: Parâmetro excluir categoria. Retorno: Boolean onde true = excluído com sucesso!

49 Listar Todas as Categorias ( ) GetItems Web Server que retorna uma lista com todas as categorias cadastradas. Parâmetro: Token Chave de acesso aos web.services String - Quadro 39: Parâmetros listar todas as categorias Parte 1. Retorno: Lista de Categorias Nome Nome da categoria String 100 X CategoriaClientePaiId Código da categoria do cliente a qual está subordinada int - CategoriaClienteId Código da categoria do cliente Int - X Quadro 40: Parâmetros listar todas as categorias Parte 2. Seleciona Categoria ( ) Select Web Server utilizado somente para retorno. Parâmetro: Token string - CategoriaClienteId Código da categoria do cliente int - X Quadro 41: Parâmetro listar categoria Parte 1. Retorno: Dados da categoria com Id fornecido Nome Nome da categoria String 100 X CategoriaClientePaiId Código da categoria do cliente a qual está subordinada int - CategoriaClienteId Código da categoria do cliente int - X Quadro 42: Parâmetro listar categoria Parte 2.

50 BUSCA LISTA DE PRODUTOID POR LISTA DE SKU ( ) GetListaProdutoIdBySKU Web Server utilizado somente para retorno (Lista de ProdutoId e ProdutoVarianteId) Token string - X SKU Sku do produo string - X SKU Sku do produo string - X Quadro 43: Parâmetro buscar produtoid e produtovarianteid Parte 1. Retorno: Lista de dados de produto conforme sku s fornecidos SKU Nome da categoria String 100 X ProdutoId Código da categoria do cliente a qual está subordinada int - ProdutoVarianteId Código da categoria do cliente int - X Quadro 44: Parâmetro buscar produtoid e produtovarianteid Parte 2. BUSCA PRODUTOID POR SKU ( ) GetProdutoIdBySKU Web Server utilizado somente para retorno (ProdutoId e ProdutoVarianteId) Token string - X SKU Sku do produo string - X Quadro 45: Parâmetro buscar produtoid e produtovarianteid Parte 1. Retorno: Dados de produto conforme sku fornecido SKU Nome da categoria String 100 X ProdutoId Código da categoria do cliente a qual está subordinada int - ProdutoVarianteId Código da categoria do cliente int - X Quadro 46: Parâmetro buscar produtoid e produtovarianteid Parte 2.

51 BUSCA LISTA DE CATEGORIAID POR LISTA DE CATEGORIACLIENTEID ( SyncCategoria.asmx ) GetListaCategoriaIdByCodigoCategoriaInterno Web Server utilizado somente para retorno (Lista de CategoriaId) Token string - X CategoriaInternoId Código categoria do cliente string - X CategoriaInternoId Código categoria do cliente string - X Quadro 47: Parâmetro buscar categoriaid Parte 1. Retorno: Lista de dados de produto conforme sku s fornecidos CategoriaId Código categoria da plataforma Fbits int X CategoriaClienteId Código categoria do cliente string 100- X Quadro 48: Parâmetro buscar CategoriaId e CategoriaClienteId Parte 2. BUSCA CATEGORIAID POR CATEGORIACLIENTEID ( SyncCategoria.asmx ) GetCategoriaIdByCodigoCategoriaInterno Web Server utilizado somente para retorno (CategoriaId) Token string - X CategoriaInternoId Código categoria do cliente string - X Quadro 49: Parâmetro buscar produtoid e produtovarianteid Parte 1. Retorno: Dados de produto conforme sku fornecido CategoriaId Nome da categoria int X Código da categoria do cliente a CategoriaClienteId string 100- X qual está subordinada Quadro 50: Parâmetro buscar produtoid e produtovarianteid Parte 2.

52 REGISTRO DE CONTA CORRENTE ( SyncContaCorrente.asmx ) RegistrarCredito Web Server utilizado somente para inserir lançamentos em conta corrente Token string 100 X usuarioid Código categoria do cliente string -100 X valor Valor do lançamento string 100 X tipolancamentoid 1 - Crédito 2 - Débito int X pedidoid Pedido a ser lançado int X historico Descrição do lançamento string 100 X Quadro 51: Parâmetro registar dado em conta corrente Parte 1. Retorno: Dados de produto conforme sku fornecido RegistrarCreditoResult Resultado da operação string 100 X Quadro 52: Parâmetro registar dado em conta corrente Parte 2.

53 5 HISTÓRICO DE ALTERAÇÕES DO DOCUMENTO Registro de Alterações Modificado por: Versão Data Descrição da Mudança [novo registro novo novo registro aqui] registro aqui] novo registro aqui] aqui] Marcos.Marins /03/2015 Adicionados os métodos: GetListaProdutoIdBySKU GetProdutoIdBySKU GetListaCategoriaIdByCodigoCategoriaInterno GetCategoriaIdByCodigoCategoriaInterno RegistrarCredito Jean Richard /02/2015 Modelo padrão dos manuais, alteração em textos. Marcos.Marins /01/2015 Ajustado as chamadas e retornos de todos os métodos. Cristiane.Santos /05/2013 Tópico tipos de cenários.

54 Cristiane.Santos /05/2013 ALTERAÇÕES VERSÃO 1.8 Integração dos atributos do produto Adicionado o campo: PedidoProdutoId Adicionado o ws de Atualização de Produto Preço Adicionado o ws de Atualização Produto Estoque Pedidos realizados no site 1. Informações do pedido Retirados os campos: TitularCartao NumeroCartao Seguranca Digitos ValidadeCartao Adicionado os campos: LinhaDigitalBoleto Numero 2. Informações dos produtos Adicionado os campos: Combo PrecoRateado Alterado o campo: PrecoVenda 3. Informações usuário Adicionado os campos: OrgaoEmissor NomeMae Endereço do usuário cadastrado no site Adicionado os campos: CPF CNPJ Inclui Produto Categoria Alterado para incluir com os seguintes campos: SKU CategoriaClienteId Deletar Produto Categoria Alterado para deletar pelos seguintes campos: SKU CategoriaClienteId

55 Listar Produto Categoria Alterado o campo: CategoriaClienteId Incluir Categoria Alterado para incluir com os seguintes campos: CategoriaClienteId CategoriaClientePaiId Excluir Categoria Alterado para deletar pelo seguinte campo: CategoriaClienteId Listar todas as Categoria Alterado para retornar os seguintes campos: CategoriaClienteId CategoriaClientePaiId Seleciona Categoria Alterado para retornar os seguintes campos: CategoriaClienteId CategoriaClientePaiId Cristiane.Santos /04/2013 Item 4.1: Foi retirado o campo AliasCP. Adicionado o campo IsTelevendas. Item Adicionado o campo IsFiltro. Seguintes itens não existem no Web Service padrão: Integração dos filtros do produto Integração da personalização do produto Item 4.10 Adicionado o campo IdCategoria. O Item registra crédito não existe no Web Service padrão. Luiz.Junior /09/2012 Luciane.Wasko /08/2012 Alzirene.Souza /05/2012 Adicionado item Registra Crédito (Devolução de produtos). Adicionado item Integração dos filtros do produto. Adicionado item Integração da personalização do produto. Alterado o item 4.4.Pedidos realizados no site para enviar os dados: Instituição, Série, Sexo, Personalização, Valor da Perzonalização, Prazo Entrega Personalização Removido do item 4.2. Cadastro de imagens de produtos: o campo path. Removido retorno do item Integração dos atributos do produto.