Manual de Integração Web Services

Transcrição

1 Pág: 1 de 51 Manual de Integração Web Services Anexo:

2 Pág: 2 de 51 Índice 1. Introdução Web Services Apresentação do documento Fluxo Geral de Informações Definições dos Web Services Integração Produto Integração dos atributos do produto Integração das informações do produto Atualização do SKU... Error! Bookmark not defined. 4.2 Atualização de Produto Preço Atualização Produto Estoque Cadastro de imagens de produtos Exclusão de imagens de produtos Atualização de estoque Pedidos realizados no site Confirmação de pedidos sincronizados Atualização de status do pedido Atualização de status do pedido DeleteRastreamento Usuário cadastrado no site Usuário cadastrado no site Confirmação de usuários sincronizados Endereço do usuário cadastrado no site Confirmação de endereço dos usuários sincronizados Inclui Produto Categoria Deletar Produto Categoria Listar Produto Categoria Anexo:

3 Pág: 3 de Incluir Categoria Excluir Categoria Listar todas as Categoria Seleciona Categoria Histórico de alterações do documento Anexo:

4 Pág: 4 de INTRODUÇÃO WEB SERVICES Web services é 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. 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, interoperabilidade entre a informação que circula numa organização nas diferentes aplicações como, por exemplo, o comércio eletrônico com os seus clientes e seus fornecedores e definir um workflow entre as aplicações e pode constituir uma alternativa aos ERP (Enterprise Resource Planning). Com um workflow é possível otimizar e controlar processos e tarefas de uma determinada organização. Anexo:

5 Pág: 5 de 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. Anexo:

6 Pág: 6 de FLUXO GERAL DE 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: SOAP Message Aplicação e-commerce Store WS HTTP Serviços Aplicação Cliente SOAP Message 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. Anexo:

7 Pág: 7 de 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. Anexo:

8 Pág: 8 de Integração Produto ( ) - Insert Através deste Web Service, devem ser enviados os produtos que serão exibidos no site (após esse envio, o produto estará disponível para configuração na área administrativa do site, e somente após essa configuração é que ele realmente será exibido ao cliente). A estrutura atual da F-Store suporta três tipos de cenários diferentes de manipulação de informações no banco de dados da plataforma. Cenário 1 Abaixo é demonstrado os cenários e suas respectivas informações. 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. Anexo:

9 Pág: 9 de 51 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 SKU Nome idpai idvinculo m null null Anel em Ouro Amarelo com Granada e Diamantes null null Anel de Ouro com Granada e Diamantes Anel Coração com Granada Verde e Diamantes null null Na visualização de cada produto são apresentados os seus atributos: Atributos do produto O exemplo acima representa um produto com um único sku e varios atributos, ou seja varios tamanhos de aros diferentes para o mesmo produto. Anexo:

10 Pág: 10 de 51 Abaixo demostramos como deverá ser retornado o conteudo das tabelas segundo o exemplo acima. idpai Mesmo SKU Anexo:

11 Pág: 11 de 51 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. 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: idretornado SKU Nome idpai idvinculo 1 Lentes de Contato EXPRESSIONS COLORS null null Lentes de Contato EXPRESSIONS COLORS - Azul Lentes de Contato EXPRESSIONS COLORS - Cinza Lentes de Contato EXPRESSIONS COLORS - Verde Lentes de Contato EXPRESSIONS COLORS - Pure hazel Anexo: 1 null 1 null 1 null 1 null

12 Pág: 12 de 51 Na visualização do produto são apresentadas as suas variações de cores. Produtos variantes 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 conteudo das tabelas segundo o exemplo acima. idpai Anexo:

13 Pág: 13 de 51 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. 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: Anexo:

14 Pág: 14 de 51 idretornado SKU Nome idpai idvinculo 1 Tênis Converse All Star Star Player Ev Ox Rosa Tênis Converse All Star Star Player Ev Ox Rosa Tamanho Tênis Converse All Star Star Player Ev Ox Rosa Cor Rosa null Na visualização do produto são apresentados os seus atributos de tamanho e outros produtos pertencentes ao mesmo grupo. Outros produtos do mesmo grupo. Produtos variantes 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. Anexo:

15 Pág: 15 de 51 idpai Anexo:

16 Pág: 16 de 51 Parâmetros: Token Chave de acesso aos web.services String - X SKU Código interno do produto String 50 X CodigoProdutoVinculoRedirect Código para realizar direcionamento de URL. Exemplo:redirecionamento URL site antigo para URL site novo String 100 OBS.:Caso o cliente já tenha loja virtual é obrigatório o preenchimento deste campo IdPai Id do produto que vincula os variantes, caso haja variantes. Se IdPai for informado os Long - dados do mesmo serão atualizados. IdVinculo Id do produto que vincula os diversos produtos variantes Exemplo: Produto A ; cor preta ; tamanho : 36 e 38 Long - 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 regra fixa, ele varia de acordo com a regra geral do site exemplo: valor mínimo do pedido). Int - X 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 DateTime - DataAtualizacao Data alteração produto DateTime - 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 Anexo:

17 Pág: 17 de 51 Colecao Caso o produto seja livro ou algo do gênero. String 100 IsTelevendas Venda somente por telefone Boolean - Anexo:

18 Pág: 18 de 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 Deve receber sempre zero, utilizado para vincular o valor do atributo com o produto do pedido. (não Int - utilizar - campo interno) Nome Nome do atributo, descrevendo a unidade (exemplo: Tamanho ml ) String 2000 X Valor O valor do atributo, sem unidade de medida (exemplo: 100, para 100 ml) String 2000 X Tipo 1 Selecao 2 Filtro Int 3 Comparacao ExibirAtributo Marca se o atributo é exibido no site Boolean - VariacaoPreco Caso haja variação no preço desse atributo, adicionar a diferença nesse campo. Decimal 15,4 Anexo:

19 Pág: 19 de 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 Int - X 7- Cuidados 8- Itens Inclusos 9- Dicas 10- Vídeo 11- Descrição 12- Valor Referente 13- PopUp Referente Titulo O título da informação. String 200 X Texto O conteúdo da informação, que pode ser formatado em HTML. String 8000 X Retorno: Boolean onde true = produto inserido com sucesso! Anexo:

20 Pág: 20 de 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: 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 Retorno: Boolean onde true = preço produto atualizado com sucesso! Anexo:

21 Pág: 21 de Atualização Produto Estoque ( ) - Update Neste Web Service devem ser enviadas as atualizações sobre o saldo disponível de cada produto no estoque. Parâmetros: SKU Código interno do produto String 50 X SaldoDisponivel Saldo disponível do produto em estoque Int - X Retorno: Boolean onde true = saldo disponível atualizado com sucesso! Anexo:

22 Pág: 22 de Cadastro de imagens de produtos ( ) - Insert 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 imagemformato Formato que a imagem estava antes de String - X convertida (exemplo: jpeg, bmp, gif, png) isprincipal Se é a imagem principal do produto Boolean - X Retorno: Boolean onde true = foto cadastrada com sucesso! Anexo:

23 Pág: 23 de 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 Retorno: Boolean onde true = foto excluída com sucesso! Anexo:

24 Pág: 24 de 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 Boolean - para venda) 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 Retorno: Boolean onde true = estoque sincronizado com sucesso! Anexo:

25 Pág: 25 de 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: Parâmetro: Campo Significado Tipo Tamanho Obrigatório Token Chave de acesso ao web.service String - X 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; 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 - NumeroCupomDesconto Número do cupom vale presente, caso tenha sido usado String 50 ValorCupomDesconto Valor do cupom vale presente, caso exista. Decimal 15,4 Status do Pedido, conforme código Status abaixo int - 1. Pago Anexo:

26 Pág: 26 de 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 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 Id da tabela de preço ao qual o preço TabelaPrecoId se refere. 1.1 Informações do cliente Int Campo Descrição Tipo Tamanho UsuarioId Id do usuário que realizou o pedido. Int - X EcommerceId TipoPessoaId OrigemContatoId Identifica em qual site o cliente esta cadastrado, se houver apenas um é Física 2 Jurídica 1 - Google 2 - Bing 3 - Jornal 4 - Patrocínio Esportivo 5 - Recomendação de alguém 6 - Revista 7 - Site na Internet 8 - Televisão 9 Outro Int - X Int - X Int - EnderecoResidencialId Id do endereço residencial Int - EnderecoEntregaId TipoSexoId FormaPagamentoId Id do endereço de entrega selecionado 1 - Masculino 2 Feminino 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 Int - Int - Int - Anexo:

27 Pág: 27 de 51 TipoPreferenciaUsuarioId 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 - 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 RazaoSocial CNPJ Data de nascimento obrigatório para pagamento de pedido com cartão de crédito. 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. DateTime - 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 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 - Anexo:

28 Pág: 28 de Informações de newsletter (não mapeado na classe) 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 maquina no usuário quando aceitou o envio de newsletter 1.2 Lista de produtos Datetime - String 100 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 Lista de atributos dos produtos Anexo:

29 Pág: 29 de 51 Nome Nome do atributo String 2000 X Valor Valor selecionado do atributo String 2000 X 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 Decimal 15,4 vinculado 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 Decimal 15,4 (quantidade * total) PedidoProdutoId Id do produto Int - PedidoProdutoAconteceS Id do serviço vinculado ao produto Int - ervicoid Quantidade Quantidade de serviços comprados Int - Tempo Tempo do serviço vinculado ao String - produto Validador Validador do serviço vinculado String - ContratoGarantia Aceito do contrato do serviço String Lista de informações de pagamento PedidoPagamentoId Id do pagamento Int - PedidoId Id do pedido Int - FormaPagamentoId Id da forma de pagamento Int - NumeroParcelas Número de parcelas (caso seja cartão Decimal 15,4 de crédito ou outra forma de pagamento que aceite parcelamento) ValorParcela Valor das parcelas (caso seja cartão Decimal 15,4 de crédito ou outra forma de pagamento que aceite parcelamento) ValorDesconto Valor do desconto Decimal 15,4 ValorJuros Valor do juros Decimal 15,4 ValorTotal Valor total do pedido Decimal 15,4 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) Anexo: String 25

30 Pág: 30 de 51 TempoPeriodo Tempo do período da assinatura Int - PercentualDesconto Percentual de desconto recebido pelo usuário Decimal 15,4 Anexo:

31 Pág: 31 de Confirmação de pedidos sincronizados ( ) - 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 web.services String - X PedidoId Id do pedido sincronizado Long - X Retorno: Boolean onde true = pedido sincronizado com sucesso! Anexo:

32 Pág: 32 de Atualização de status do 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 Int - X 7 -Boleto Expirado 8 -Cancelado 9 -Enviado 10 -Liberado 11 -Faturado - Nota fiscal emitida 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 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. Retorno: Boolean onde true = status alterado com sucesso! Anexo:

33 Pág: 33 de Atualização de status do pedido ( - 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 Retorno: Boolean onde true = excluído com sucesso! Anexo:

34 Pág: 34 de 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 Retorno: Lista com 20 Itens 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 2 Jurídica Int - X OrigemContatoId EnderecoResidencialId Código endereço residencial Long - EnderecoEntregaId Código endereço de entrega. Long - TipoSexoId 1 Masculino 2 Feminino Int - FormaPagamentoId 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 Int - X 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 TipoPreferenciaUsuarioId Corresponde à ordenação padrão utilizada no site como preferência do usuário: 0 - Indefinido Int - 1 Marcas 2 Preços 3 Mais Vendidos Nome Nome do usuário String 100 X Anexo:

35 Pág: 35 de 51 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 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 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 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 Datetime - IPAceitacaoOptIn Ip da maquina no usuário quando aceitou o envio de newsletter String 100 Anexo:

36 Pág: 36 de Usuário cadastrado no site ( ) Select id. Este Web Service busca e exibe as informações de um usuário específico, localizado por 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 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 2 Jurídica Int - X OrigemContatoId EnderecoResidencialId Código endereço residencial Long - EnderecoEntregaId Código endereço de entrega. Long - TipoSexoId 1 Masculino 2 Feminino Int - FormaPagamentoId Forma de pagamento preferencial do usuário: 1-Boleto 2-PayPal 3-Visa 4-MasterCard 5-American Express Int - X 6-Diners 7-Aura 8-Hipercard 9-Google Checkout 11-Deposito Bancário 13-ELO TipoPreferenciaUsuarioId Corresponde à ordenação padrão utilizada no site como preferência do usuário: 0 - Indefinido 1 Marcas Int - 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 Anexo: