Layer de Integração EZ Commerce Versão 1.21

Transcrição

1 Layer de Integração EZ Commerce Versão

2 Sumário Layer de Integração... 3 Arquitetura da Solução... 3 Famílias de Dados Disponíveis... 4 Objetos Compartilhados... 5 Tabela de Erros... 6 Fluxo da Família de Produto... 7 Família de Produtos... 8 Fluxo de Marcas... 9 Fluxo de Categorias do Site Fluxo de Fornecedores Fluxo de Produtos Fluxo de Variações de Produtos Fluxo de Sub Variações de Produtos Fluxo de Preços Fluxo de Estoque Fluxo de Menus Personalizados Fluxo de Clientes Fluxo de Pedidos Tabelas de Códigos de Referência para Integração Histórico de Alterações Exemplo de integração no Visual Studio Exemplo de fluxo em.net (3.5) Linguagem c#

3 Layer de Integração A Layer de Integração EZ Commerce (LIEZ) tem como objetivo disponibilizar aos nossos clientes uma maneira segura e padronizada para integração de dados entre sistemas legados e a plataforma de e-commerce. A LIEZ foi desenvolvida sobre plataforma Microsoft (WCF Windows Communication Foundation) e segue normas para integração entre diversas tecnologias, como Java, PHP, etc. Arquitetura da Solução Tecnologia Autenticação Microsoft WCF HTTP / Basic Autentication (Credenciais na mensagem) Servidor IIS 6.0 Segurança Tempo de defasagem da informação Nível do transporte (SSL) Criptografia e assinatura das mensagens Informação disponível em tempo real 3

4 Famílias de Dados Disponíveis Produtos Os serviços da família de produtos têm como objetivo possibilitar ao sistema integrado criar/alterar/excluir informações dos catálogos de produtos. Dessa maneira, o cliente poderá integrar seu ERP e fazer a gestão de produtos pelo mesmo. O catálogo de produto envolve Marcas, Categorias do Site, Fornecedores, Produtos, Preços, Estoque. Nessa família, a LIEZ recebe as chamadas do sistema externo e faz as modificações necessárias no banco de dados do e-commerce. As informações são realizadas em tempo real. Clientes Os serviços da família de clientes têm como objetivo possibilitar ao sistema integrado receber informações de clientes cadastrados ou modificados. Não é possível criar novos clientes pela LIEZ. Quando um cliente novo se cadastra, ou um cliente existente altera o cadastro, o mesmo é colocado em uma fila de integração, ficando disponível na LIEZ para ser integrado. Pedidos Os serviços da família de pedidos têm como objetivo possibilitar ao sistema integrado receber informações de pedidos novos. Não é possível criar novos pedidos pela LIEZ. Quando um pedido novo é criado, o mesmo é colocado em uma fila de integração, ficando disponível na LIEZ para ser integrado. O pedido só é colocado na fila quando o mesmo possui forma de pagamento selecionada. Pedidos abandonados no carrinho, sem forma de pagamento selecionada, não serão disponibilizados na LIEZ. 4

5 Objetos Compartilhados Objetos compartilhados são utilizados como envelopes (wrappers) para a chamada e retorno dos métodos. Propriedades Resposta de Processamento Objeto: Nome Tipo de dado Obrigatório Chave Tamanho Status Resultado Erros Indica o status do processamento StatusProcessamento Sim Não - Exemplo: Sucesso Objeto de retorno da chamada do método Object Não Não - Cada método poderá retornar um objeto no teu retorno. Isso será útil para capturar alguma informação que possa ser gerada pela layer, como um ID. Exemplo: (Marca)Resultado Coleção de erros ocorridos [] Erro Não Não - Uma coleção de objetos do tipo Erro indicando os erros ocorridos. Exemplo: Erro de Processamento Objeto: ErroProcessamento Nome Tipo de dado Obrigatório Chave Tamanho Codigo Mensagem Indica o código do erro Int Sim Não 8 Exemplo: 101 Mensagem explicativa do erro String Sim Não 500 Exemplo: Marca inexistente Status de Processamento Enum: StatusProcessamento Nome Código Sucesso 0 Processamento do método ocorreu com sucesso Erro 1 Houve um ou mais erros no processamento do método. Olhar a coleção de erros no objeto ErroProcessamento.Erros 5

6 Tabela de Erros Tabela de Erros Nome Fluxo 01 Todos Os dados enviados para o processo de integração estão inválidos. 10 Todos Erro durante o processo de integração dos dados. 11 Todos Erro desconhecido de banco de dados. 12 Preço Erro ao atualizar a descrição das condições de pagamentos no site. 101 Marca A marca não existe no banco de dados. 102 Categoria A categoria do site não existe no banco de dados. 103 Fornecedor O fornecedor não existe no banco de dados. 104 Produto O produto não existe no banco de dados. 105 Produto A variação do produto não existe no banco de dados. 106 Produto A subvariação do produto não existe no banco de dados. 107 Pedido O pedido não existe no banco de dados. 108 Pedido O pedido não foi encontrado na fila de integração. 109 Cliente O cliente não foi encontrado na file da integração Produto Produto Produto Produto Pedido Pedido Pedido Pedido Pedido Pedido Pedido Produto Cliente Pedido A extensão informada para o produto não existe no mapeamento de meta dados. Extensão: {Alias} A extensão informada para o produto possui tamanho incompatível com o configurado no mapeamento de meta dados. Extensão: { Alias } A extensão informada para o produto possui tipo de dados incompatível com o configurado no mapeamento de meta dados. Extensão: { Alias } A coleção de extensões informada não contém um elemento obrigatório. Elemento obrigatório: {Alias} Pacote não encontrado Status de andamento de pacote informado não encontrado Código de barras não informado Código do pacote e código de barras não informados O produto {Alias} não foi encontrado no pedido. Verificar se não foi removido. O pedido não possui produtos ativos para a montagem do pacote O produto {Alias} possui uma quantidade indevida para a montagem do pacote. Verificar a quantidade contratada no pedido de acordo com oque ja foi despachado O código de associação informado {0} nao foi encontrado. O cliente da fila {0} não foi excluído pois ainda existem sistemas do cliente que precisam ler o registro ou o sistema corrente não possui permissão de mofificação na fila. O pedido da fila {0} não foi excluído pois ainda existem sistemas do cliente que precisam ler o registro ou o sistema corrente não possui permissão de mofificação na fila. 6

7 Fluxo da Família de Produto Arquitetura Endereço do Serviço: 7

8 Família de Produtos O produto pode ser estruturado sozinho ou em famílias. Um produto sozinho representa uma unidade em estoque que não possui nenhum tipo de variação (ex: Câmera Digital Sony XYZ). Famílias de produtos representam todas as variações de um mesmo produto. Na plataforma da EZ Commerce só é possível ter no máximo dois níveis de variações, o que chamamos de Variação e Sub Variação. Tanto a variação como a sub variação funcionam com meta-dados, então é possível criar um produto, por exemplo, que varie por Cor/Tamanho, ou Tamanho/Cor. Cada variação ou sub variação deverá ter seu preço e estoque, pois representam uma unidade física de um produto. Variação Sub Variação Produto Pai Sub Variação Variação Sub Variação Exemplo: P Azul Camisa Polo M Vermelho M 8

9 Fluxo de Marcas s SalvarMarca Insere a marca se não existir. Atualiza todos os campos da marca se existir. Parâmetros de Entrada Tipo Tamanho Marca Marca Retorno Tipo Tamanho 01 Os dados enviados para o processo de integração estão inválidos. 10 Erro durante o processo de integração dos dados. 11 Erro desconhecido de banco de dados. SalvarMarcaLst Baseado em uma coleção de marcas, insere a marca se não existir. Atualiza todos os campos da marca se existir. Sugere-se o número de 200 itens dentro da coleção a ser operada; Parâmetros de Entrada Tipo Tamanho List<Marca> Marca[] Retorno Tipo Tamanho 01 Os dados enviados para o processo de integração estão inválidos. 10 Erro durante o processo de integração dos dados. 11 Erro desconhecido de banco de dados. ExcluirMarca Exclui uma marca se existir. Parâmetros de Entrada Tipo Tamanho MarcaId Int 8 ID da marca a ser excluída Retorno Tipo Tamanho 10 Erro durante o processo de integração dos dados. 11 Erro desconhecido de banco de dados. 101 A marca não existe no banco de dados. 9

10 Propriedades Marca de Produto Objeto: Marca Nome Tipo de dado Obrigatório Chave Tamanho MarcaID Nome Url Logotipo Ordem Ativo Id de identificação da marca Int (positivo) Sim Sim 8 Exemplo: 10 Nome da marca String Sim Não 50 Exemplo: Sony Url do site da marca String Não Não 500 O link para o site da marca será feito de acordo com a string informada. Por esse motivo, é necessário passar o se for o caso. Exemplo: Nome da imagem que representa o logotipo String Não Não 50 O nome da imagem que estará no diretório pré-determinado. O diretório será acessado por FTP ou pelo gerenciador de arquivos do sistema. Exemplo: logosony.jpg Ordem de listagem da marca Int Não Não 8 Campo utilizado para ordenação das marcas. Ordenará do menor ao maior. Exemplo: 10 Status da marca Bool Sim Não 1 Indica se a marca está ativa. Exemplo: True Fluxo de Categorias do Site s SalvarSiteCategoria Insere a categoria do site se não existir. Atualiza todos os campos da categoria do site se existir. Parâmetros de Entrada Tipo Tamanho SiteCategoria SiteCategoria Retorno Tipo Tamanho 01 Os dados enviados para o processo de integração estão inválidos. 10 Erro durante o processo de integração dos dados. 11 Erro desconhecido de banco de dados. 102 A categoria pai não existe no banco de dados. ExcluirSiteCategoria Excluir uma categoria do site se existir. Parâmetros de Entrada Tipo Tamanho SiteCategoriaID Int 8 ID da categoria 10

11 Retorno Tipo Tamanho 10 Erro durante o processo de integração dos dados. 11 Erro desconhecido de banco de dados. 102 A categoria do site não existe no banco de dados. Propriedades Categoria do Site Objeto: SiteCategoria Nome Tipo de dado Obrigatório Chave Tamanho SiteCategoriaID SiteCategoriaPaiID Nome Descricao PalavrasChave Ordem Url Redirecionar Ativo VisualizaLogado Id de identificação da categoria Int (positivo) Sim Sim 8 Exemplo: 7 Id da categoria pai Int (positivo) Sim Não 8 Se for uma categoria de primeiro nível (root), informar 0 (zero) nessa propriedade Exemplo: 0 Nome da categoria do site String Sim Não 50 O nome que irá aparecer no site para a categoria Exemplo: Informática da categoria do site String Não Não 50 da categoria do site para ser utilizado nas meta descriptions da página. Informação importante para otimização (SEO) Exemplo: Palavras-chave da categoria String Não Não 50 Palavras-chave para auxiliar na busca. Não será exibido no site. Exemplo: Computadores, Notebook, Sony, MP3 Ordem da categoria no site Int (positivo) Não Não 8 Campo pelo qual o site irá ordenar ar categorias irmãs. O segundo critério de ordenação será o nome da categoria. Exemplo: Computadores, Notebook, Sony, MP3 Url para o link da categoria String Não Não 50 Uma url opcional para fazer um link na categoria. Nesse caso, a categoria não apontará para a página de lista de produtos dessa categoria. Esse comportamento só acontecerá se a propriedade Redirecionar estiver marcada com True. Exemplo: Flag que indica se deve redirecionar Bool Sim Não 1 Indica se a categoria deve redirecionar para o campo Url Exemplo: True Status da categoria Bool Sim Não 1 Indica se a categoria está ativa. Exemplo: True Padrão ZERO. Se valor é igual a UM, mostra categoria apenas se logado. Int Não Não 1 11

12 Fluxo de Fornecedores s SalvarFornecedor Insere o fornecedor se não existir. Atualiza todos os campos do fornecedor se existir. Parâmetros de Entrada Tipo Tamanho Fornecedor Fornecedor Retorno Tipo Tamanho 01 Os dados enviados para o processo de integração estão inválidos. 10 Erro durante o processo de integração dos dados. 11 Erro desconhecido de banco de dados. SalvarFornecedorLst Baseado em uma coleção de fornecedores, insere o fornecedor se não existir. Atualiza todos os campos do fornecedor se existir. Sugere-se o número de 200 itens dentro da coleção a ser operada; Parâmetros de Entrada Tipo Tamanho List<Fornecedor> Fornecedor[] Retorno Tipo Tamanho 01 Os dados enviados para o processo de integração estão inválidos. 10 Erro durante o processo de integração dos dados. 11 Erro desconhecido de banco de dados. ExcluirFornecedor Exclui um fornecedor se existir. Parâmetros de Entrada Tipo Tamanho FornecedorID Int 8 Pode ser preenchido somente o campo ID Retorno Tipo Tamanho 10 Erro durante o processo de integração dos dados. 11 Erro desconhecido de banco de dados. 103 O fornecedor não existe no banco de dados. Propriedades Fornecedor Objeto: Fornecedor Nome Tipo de dado Obrigatório Chave Tamanho 12

13 FornecedorID Nome Telefone Contato Url Observacoes Id de identificação do fornecedor Int (positivo) Sim Sim 8 Exemplo: 10 Nome do fornecedor String Sim Não 50 Exemplo: Fornecedor ZYX Telefone do fornecedor String Não Não 50 Exemplo: Nome do contato no fornecedor String Não Não 50 Exemplo: João da Silva Url do site do fornecedor String Não Não 50 Importante cadastrar junto o O site irá fazer o link diretamente para essa string. Exemplo: do fornecedor String Não Não 50 Exemplo: xyz@fornecedor.com.br Observações cadastradas para o fornecedor String Não Não 50 13

14 Fluxo de Produtos s SalvarProduto Insere o produto se não existir. Atualiza todos os campos do produto, se existir. Parâmetros de Entrada Tipo Tamanho Produto Produto Retorno Tipo Tamanho SalvarProdutoLst Baseado em uma coleçao de produtos, insere o produto se não existir. Atualiza todos os campos do produto, se existir. Sugere-se o número de 200 itens dentro da coleção a ser operada; Parâmetros de Entrada Tipo Tamanho List<Produto> Produto[] Retorno Tipo Tamanho ExcluirProduto Excluir um produto, se existir. Parâmetros de Entrada Tipo Tamanho CodigoIntegracao int 8 Código de integração do produto Retorno Tipo Tamanho 401 Produto inexistente 14

15 SalvarListaProdutos Cria uma lista de produtos. Parâmetros de Entrada Tipo Tamanho ListaProdutos ListaProdutos Retorno Tipo Tamanho 401 Produto inexistente Propriedades Produto Objeto: Produto Nome Tipo de dado Obrigatório Chave Tamanho CodigoIntegracao Tipo FornecedorID MarcaID Referencia Classificacao Modelo Conteudo Nome DescricaoCurta DescricaoLonga TermoDeAceitacao Id de identificação do produto. String Sim Sim 50 O sistema que integrador deverá gerar um código para cada produto e informar nessa propriedade. Tipo do produto TipoProdutoEnum Sim Não 8 O tipo de produto será utilizado para determinar o seu comportamento em relação as variações e sua apresentação no detalhe do produto. Exemplo: ComVariacaoEmCombo Id do fornecedor Int Não Não 8 Fluxo de Fornecedor Exemplo: 15 Id da Marca Int Não Não 8 Fluxo de Marca Exemplo: 10 Referência utilizada para o produto String Não Não 50 Um código pelo qual o sistema integrador identifica produtos. Pode ser um código de barra, um código de fornecedor, etc. Exemplo: PTR3434 Id da Classificação ClassificacaoProdutoEnum Sim Não 8 Código da classificação do produto que indica seu estado (novo, usado, etc) Exemplo: Novo Modelo do produto String Não Não 100 Texto do modelo do produto Exemplo: XYZ Unidade de medida e quantidade String Não Não 50 Indica em que unidade de medida está se comercializando o produto (unidade, caixa, etc) e a quantidade que aquele produto representa. Exemplo: 1 UM Nome do produto String Sim Não 200 Campo destinado para o nome do produto Exemplo: iphone 3GS curta do produto String Não Não 200 curta que será apresentada na listagem, pesquisa e detalhe do produto, abaixo do nome. Longa String Não Não - mais detalhada do produto que será apresentada somente no detalhe do produto Termo de aceitação para a compra String Não Não - Contrato apresentado ao adicionar o produto no carrinho. O produto só será adicionado se o termo for aceito 15

16 Custo Preco Promocao PrecoPromocao PromocaoInicio PromocaoFim PrevalecerPreco Taxa NumeroMaximoParcelas EstoqueMinimo EstoqueAtual TipoDisponibilidade PreVenda PreVendaData Custo do produto para o lojista Money Não Não 8,2 O custo não será apresentado para o cliente, apenas será utilizado pelo sistema para gerar relatórios. Exemplo: 22,56 Preço de venda do produto Money Sim Não 8,2 Preço que será apresentado para o cliente se o produto não possuir promoção. Exemplo: 30,00 Indica se existe promoção no produto Boolean Sim Não 1 Se existir promoção, a data de inicio e fim da promoção deverão ser válidas para que a mesma seja aplicada. Exemplo; True Preço da promoção Money Não Não 8,2 O preço que será aplicado se o produto tiver promoção e estiver em vigência. Será apresentado como De: 30,00 Por: 28,50 Exemplo: 28,50 Data de início da promoção Datetime Não Não 16 Quando possuir valor é aceito somente dia, mês e ano. Datas com hora ou minutos serão truncadas. Exemplo de data válida: 23/03/2010. Data de fim da promoção Datetime Não Não 16 Quando possuir valor é aceito somente dia, mês e ano. Datas com hora ou minutos serão truncadas. Exemplo de data válida: 23/03/2010. Regra para preço para produtos com variação PrevalecerPrecoEnum Sim Não 1 Indica se deve prevalecer o preço do pai, mesmo que as variações possuam preços mais baratos ou caros. O default é PrevalecerPrecoVariacao Exemplo: PrevalecerPrecoPai Valor da taxa cobrada no produto Money Não Não 8,2 Informa o valor em reais da taxa do produto. Pode ser uma taxa de conveniência cobrada em um ingresso, por exemplo. Exemplo: 15,00 Número máximo de parcelas Int Não Não 8 Indica o número máximo de parcelas para o produto. Mesmo que a forma de pagamento permita mais, o produto irá permitir somente até esse número de parcelas. Exemplo: 6 Estoque mínimo do produto Int Sim Não 8 Indica a que ponto do estoque o administrador deverá ser avisa da reposição de estoque. Exemplo: 2 Estoque atual do produto Int Sim Não 8 Saldo atual em estoque do produto Exemplo: 10 Tipo de disponibilidade do produto TipoDisponibilidadeEnum Sim Não 8 Indica como será o comportamento da disponibilidade do produto. Poderá ser normal, sob encomenda, sob consulta ou até mesmo indisponível, sobrepondo a regra de estoque. Exemplo: Normal Pré venda do produto Boolean Sim Não 1 Indica se o produto poderá ser vendido em pré-venda, respeitando as regras de data e limite. Exemplo: True Data limite para a pré-venda Datetime Não Não 16 A pré-venda só será realizada até essa data. Posteriormente, o produto assume sua disponibilidade configurada. Se não for informada, a pré venda não terá data limite. Limite de vendas em pré-venda Int Não Não 8 PreVendaLimite VendaSemEstoque Indica a quantidade máxima de produto a serem vendidos em pré-venda. Se não for informado, a venda acontecerá sem limite. Exemplo: 10 Venda do produto sem estoque (backorder) Boolean Sim Não 1 Indica que o produto pode ser vendido sem estoque respeitando as regras de data e limite. Exemplo: true VendaSemEstoqueData Data limite da venda sem estoque Datetime Não Não 16 16

17 A venda sem estoque só será realizada até essa data. Posteriormente, o produto assume sua disponibilidade configurada. Se não for informada, a venda sem estoque não terá data limite. Limite de vendas sem estoque Int Não Não 8 VendaSemEstoqueLimite ExibirDisponibilidade DisponibilidadeEmEstoque DisponibilidadeSemEstoque TipoReposicao Peso PesoCubico Largura Altura Profundidade QuantidadeMaximaPorCliente FreteGratis Indica a quantidade máxima de produto a serem vendidos sem estoque. Se não for informado, a venda acontecerá sem limite. Exemplo: 10 Exibir disponibilidade no site Boolean Sim Não 1 Indica se o site deve apresentar o campo disponibilidade para o cliente Exemplo: True Disponibilidade do produto em estoque Int Não Não 8 Disponibilidade a ser apresentada (em dias) quando o produto possuir estoque. Exemplo: 5 Disponibilidade do produto sem estoque Int Não Não 8 Disponibilidade a ser apresentada (em dias) quando o produto não possuir estoque. Caso utilizado apenas para Venda Sem Estoque. Exemplo: 10 Tipo de reposição do produto TipoReposicaoEnum Sim Não 1 Indica o comportamento da reposição do produto. Se ele for descontinuado, ao acabar o estoque, o produto ficará escotado. Exemplo: Normal Peso do produto (em Kg) Double(Positivo) Sim Não 8,2 Importante para cálculo do frete nos correios Exemplo: 2,4 Peso cúbico do produto Double Não Não 8,2 Se não for informado, será calculado através das dimensões e peso Exemplo: 1,2 formula para calculo em: Largura do Produto(em cm) Double Sim Não 8,2 Exemplo: 105 Altura do produto (em cm) Double Sim Não 8,2 Exemplo: 40 Profundidade do produto (em cm) Double Sim Não 8,2 Exemplo: 20 Quantidade máxima por cliente Int Sim Não 8 Limita a quantidade máxima que um mesmo cliente poderá colocar no carrinho de uma única vez. Se for zero não terá limite. Exemplo: 10 Frete Grátis Boolean Sim Não 1 Flag para indicar que o produto sempre será vendido com frete grátis. Se existir mais de um produto no carrinho e um dele não for frete grátis, o frete será calculado para o produto sem frete grátis Exemplo: true Sem entrega Boolean Sim Não 1 SemEntrega Ativo TituloVariacao TituloSubVariacao Indica se o produto tem o comportamento de não ser entregue na casa do cliente, como um Dinheiro Virtual, Serial Number de jogo, etc. Exemplo: true Status ativo Boolean Sim Não 1 Indica se o produto está ativo para ser exibido no site. Exemplo: true Título da Variação String Não Não 50 Exemplo: Cores Título da Sub Variação String Não Não 50 Exemplo: Tamanhos DataEntrada Data de entrada do produto Datetime Não Não 16 17

18 Data que o produto estará visível na loja, quando possuir valor é aceito somente dia, mês e ano. Datas com hora ou minutos serão truncadas. Exemplo de data válida: 23/03/2010. Data de saído do produto Datetime Não Não 16 DataSaida MercadoLivreCodigos ArremateCodigos TodoOfertaCodigos MetaTitle MetaDescription MetaKeyWords PalavrasParaPesquisa Ordem CamposExtendidos SiteCategoriaPrincipal SiteCategoriasAlternativas AssociacaoID Data em que o produto sairá da loja automaticamente, quando possuir valor é aceito somente dia, mês e ano. Datas com hora ou minutos serão truncadas. Exemplo de data válida: 23/03/2010. Códigos de integração com Mercado Livre String Não Não 50 Códigos (separados por ;) de referência com o produto do Mercado Livre Exemplo: 45645; Códigos de integração com Arremate String Não Não 50 Códigos de referência com o produto do Arremate Exemplo: Códigos de integração com TodaOferta String Não Não 50 Códigos (separados por ;) de referência com o produto do TodaOferta Exemplo: 45645; Meta Title para o produto String Não Não 300 Meta Title utilizado no HTML do detalhe do produto Meta Description para o produto String Não Não 200 Meta Description utilizado no HTML do detalhe do produto Meta Key Words para o produto String Não Não 130 Meta Key Words utilizado no HTML do detalhe do produto Palavras utilizadas na busca String Não Não 200 Palavras que auxiliam na busca dos produtos. Essas palavras não serão apresentadas no site. Exemplo:Note notebook hp34 pavillon Ordem do produto em uma listagem Int Não Não 8 Campo auxiliar para a ordenação dos produtos em uma listagem Coleção de campos extendidos [] CampoExtendido Não Não Os campos extendidos precisam ser criados primeiramente no catálogo da EZ Commerce. Id da categoria principal do produto Int(positivo) Sim Não 8 A categoria que será utilizada quando o produto vier de um busca ou exportado para algum XML (Buscapé, Cota Cota, etc). Coleção de ids de categorias alternativas [] int Não Não 8 Demais categorias que o produto se encontra. Código da associação segundo tabela de parâmetros int Não Não 8 ProdutosAssociados Coleção de códigos de integração de produtos a serem associados [] Associacao Não Não VisualizarBusca Se valor igual a UM, não mostra o produto na busca da loja int Não Não 1 VisualizaLogado VisualizaPreco VisualizaUrlDireta Presente PresenteValor Video Padrão ZERO. Se valor é igual a UM, somente usuários logados podem visualizar. Padrão ZERO. Se valor é igual a UM, somente usuários logados podem visualizar o preço. Padrão ZERO. Se valor é igual a UM, produto é apenas visualizado pela URL direta. Padão NULO. Se valor igual a UM, opção de presente é apresentada no produto. Valor do pacote de presente. Apenas utilizado se Presente = 1. Link embed ou incorporar da página do vídeo exemplo: <iframe width="560" height="315" src=" Int Não Não 1 int Não Não 1 int Não Não 1 Int Não Não 1 Double Não Não 8,2 String Não Não

19 " frameborder="0" allowfullscreen></iframe> Campo Extendido Objeto: CampoExtendido Nome Tipo de dado Obrigatório Chave Tamanho Alias Valor Alias do campo extendido string Sim Sim 50 Um nome dado ao campo extendido no catálogo da EZ Commerce. Esses campos deverão ser criados na instalação da loja. Valor do campo extendido string Sim Não - Importante: Os campos extendidos precisam ser criados anteriormente na plataforma da EZ Commerce. A Layer só aceitará campos extendidos criados e ativos. Entrar em contato com a área técnida para solicitar os campos extendidos necessários. Os campos extendidos podem ser do tipo: Flag (verdadeiro/falso) Texto Simples (sem formatação e uma única linha) Texto Multilinha (sem formatação e multiplas linhas) Número Data Dinheiro Pré-Definido Decimal Texto HTML Associação Objeto: Associacao Nome Tipo de dado Obrigatório Chave Tamanho CodigoIntegracao Código de integração do produto a associar string Sim Sim 50 Lista de Produtos Objeto: ListaProdutos Nome Tipo de dado Obrigatório Chave Tamanho ProdutosListaID Código da lista int Não Sim 8 Titulo Título da lista string Sim Não 100 Alias Apelido da lista string Sim Não 100 Produtos Produto associados a lista []ListaProdutosLista Sim Não 19

20 Lista de Produtos Associados Objeto: ListaProdutosLista Nome Tipo de dado Obrigatório Chave Tamanho ListaID Código da lista a associar int Sim Sim 50 CodigoIntegracao Código de integração do produto a associar []string Sim Sim 50 Tipo de Produto Valores Objeto: TipoProdutoEnum SemVariacaoNormal ComVariacoesEmComboELista ComVariacaoEmLista Produto normal, sem variações ou subvariações As variações em combo e as subvariações em lista Somente variações com lista ComVariacaoCoresTamanhos ComVariacaoCoresEmGrade KitDeProdutos Somente variações com quantidade a escolher Obs: Deve ser implementado ValePresente ComVariacoesOpcoesEmCombo ComVariacaoOpcoesEmGradeComPreco Variações e subvariações em combo Somente variação com quantidade a escolher e mais o preço Classificação de Produto Valores Objeto: ClassificacaoProdutoEnum Novo SemiNovo Usado Refurbished Tipo de Disponibilidade Valores Objeto: TipoDisponibilidadeEnum Disponivel SobEncomenda SobConsulta Indisponivel VendaEncerrada 20

21 Tipo de Reposição Valores Normal Objeto: TipoReposicaoEnum Descontinuado Prevalecer Preço Valores PrevalecerPrecoPai Objeto: PrevalecerPrecoEnum PrevalecerPreceVariacao 21

22 Fluxo de Variações de Produtos s SalvarVariacao Insere a variação se não existir. Atualiza todos os campos da variação, se existir. Parâmetros de Entrada Tipo Tamanho Variacao Variacao Retorno Tipo Tamanho ExcluirVariacao Excluir uma variação, se existir. Parâmetros de Entrada Tipo Tamanho CodigoIntegracaoVariacao String 50 Pode ser preenchido somente o campo ID Retorno Tipo Tamanho 401 Produto inexistente Propriedades Variação Objeto: Variacao Nome Tipo de dado Obrigatório Chave Tamanho CodigoIntegracao CodigoIntegracaoVariacao Nome Referencia PrecoVariacao Promocao Id de identificação da integração do produto pai String Sim Sim 50 Exemplo: 4 Id de identificação da integração da variação String Sim Sim 50 Exemplo: 40 Nome da variação String Sim Não 100 O nome que irá aparecer no site para a variação. Exemplo: Cor Referência utilizada para o produto String Não Não 50 Exemplo: XZ3433 Preço da variação Money Não Não 8,2 Exemplo: 30,00 Indica se existe promoção na variação Boolean Sim Não 1 Se existir promoção, as data de inicio e fim da promoção deverão ser válidas para que a mesma seja aplicada. Exemplo: True 22

23 PrecoPromocaoVariacao EstoqueMinimo EstoqueAtual Disponivel Ordem Cor Peso CodigosMercadoLivre CodigosTodaOferta Foto Preço promocional do produto Money Não Não 8,2 Estoque mínimo da variação Int (Positivo) Sim Não 8 Indica a que ponto do estoque o administrador deverá ser avisado da reposição de estoque. Exemplo: 2 Estoque atual da variação Int (Positivo) Sim Não 8 Saldo atual em estoque da variação Exemplo: 10 Indica se a variação está disponível Boolean Sim Nao 1 Exemplo: True Ordem da variação em uma listagem Int Não Não 8 Campo auxiliar para a ordenação dos produtos em uma listagem Hexa decimal da cor do produto Stringcodigoin Não Sim 50 Exemplo: #fe34e3 Peso da variação (em Kg) Decimal Sim Não 8,2 Importante para cálculo do frete nos correios Exemplo: 2,4 Códigos mapeados do Mercado Livre String Não Sim 100 Códigos separados por ; Exemplo: 3434; 3421; 4545 Códigos mapeados do TodaOferta String Não Sim 100 Códigos separados por ; Exemplo: 3434; 3421; 4545 Foto da variação String Não Sim 50 23

24 Fluxo de Sub Variações de Produtos s SalvarSubVariacao Insere a sub variação se não existir. Atualiza todos os campos da sub variação, se existir. Parâmetros de Entrada Tipo Tamanho SubVariacao SubVariacao Retorno Tipo Tamanho ExcluirSubVariacao Excluir uma sub variação, se existir. Parâmetros de Entrada Tipo Tamanho CodigoIntegracaoSubVariacao String 50 Pode ser preenchido somente o campo ID Retorno Tipo Tamanho 401 Produto inexistente Propriedades Sub Variação Objeto: Subvariacao Nome Tipo de dado Obrigatório Chave Tamanho CodigoIntegracao CodigoIntegracaoVariacao CodigoIntegracaoSubVariacao Nome Referencia PrecoSubVariacao Promocao Id de identificação da integração do produto pai String Sim Sim 50 Exemplo: 4 Id de identificação da integração da variação String Sim Sim 50 Exemplo: 40 Id de identificação da integração da subvariação String Sim Sim 50 Exemplo: 456 Nome da subvariação String Sim Não 100 O texto que irá ser apresentado no site Exemplo: GG Referência da subvariação String Não Não 50 Exemplo: GT3433 Preço da subvariação Money Não Não 8,2 Exemplo: 23,67 Indica se a subvariação possui promoção Boolean Sim Não 1 Exemplo: True 24

25 PrecoPromocaoSubVariacao EstoqueMinimo EstoqueAtual Disponivel Ordem Peso Foto Preço promocional da subvariação Money Não Não 8,2 Exemplo: 45,33 Estoque mínimo da subvariação Int (Positivo) Sim Não 8 Indica a que ponto do estoque o administrador deverá ser avisado da reposição de estoque. Exemplo: 2 Estoque atual da subvariação Int (Positivo) Sim Não 8 Saldo atual em estoque da subvariação Exemplo: 10 Indica se a subvariação está disponível Boolean Sim Nao 1 Exemplo: True Ordem da subvariação em uma listagem Int (Positivo) Sim Não 8 Campo auxiliar para a ordenação dos produtos em uma listagem Peso (em Kg) da subvariação Decimal Sim Não 8,2 Exemplo: 3,2 Foto da subvariação String Não Sim 50 25

26 Fluxo de Preços s SalvarPreco Atualiza os campos de preço do produto. Importante: O método SalvarPreco será utilizado para atualizar Produtos, Variações e SubVariações, seguindo a seguinte regra: Para atualizar o preço do produto, informar somente o CodigoIntegracao Para atualizar o preço da variação informar somente CodigoIntegracao e CodigoIntegracaoVariacao Para atualizar o preço da subvariacao informar CodigoIntegracao, CodigoIntegracaoVariacao e CodigoIntegracaoSubVariacao Parâmetros de Entrada Tipo Tamanho Preco Preco Retorno Tipo Tamanho SalvarPrecoLst Baseado em uma lista de Produtos, atualiza os campos de preço do produto. Importante: O método SalvarPreco será utilizado para atualizar Produtos, Variações e SubVariações, seguindo a seguinte regra: Para atualizar o preço do produto, informar somente o CodigoIntegracao Para atualizar o preço da variação informar somente CodigoIntegracao e CodigoIntegracaoVariacao Para atualizar o preço da subvariacao informar CodigoIntegracao, CodigoIntegracaoVariacao e CodigoIntegracaoSubVariacao Sugere-se o número de 200 itens dentro da coleção a ser operada; Parâmetros de Entrada Tipo Tamanho List<Preco> Preco[] Retorno Tipo Tamanho Propriedades Preco do Produto Objeto: Preco Nome Tipo de dado Obrigatório Chave Tamanho CodigoIntegracao Id de identificação da integração do produto pai String Sim Sim 50 Exemplo: 4 CodigoIntegracaoVariacao Id de identificação da integração da variação String Não Sim 50 Exemplo: 40 CodigoIntegracaoSubVariacao Id de identificação da integração da subvariação String Não Sim 50 Exemplo: 456 PrecoProduto Preço a ser atualizado Money Sim Não 8,2 Exemplo: 44,32 Promocao Atualiza o flag promoção Boolean Sim Não 1 Exemplo: true PrecoPromocao Preço promocional a ser atualizado Money Não Não 8,2 26

27 PromocaoInicio PromocaoFim Exemplo: 34,56 Data início da promoção Datetime Não Não 16 Quando possuir valor é aceito somente dia, mês e ano. Datas com hora ou minutos serão truncadas. Exemplo de data válida: 23/03/2010. Data fim da promoção Datetime Não Não 16 Quando possuir valor é aceito somente dia, mês e ano. Datas com hora ou minutos serão truncadas. Exemplo de data válida: 23/03/

28 Fluxo de Estoque s SalvarEstoque Atualiza os campos de estoque do produto. Importante: O método SalvarEstoque será utilizado para atualizar Produtos, Variações e SubVariações, seguindo a seguinte regra: Para atualizar o estoque do produto, informar somente o CodigoIntegracao Para atualizar o estoque da variação informar somente CodigoIntegracao e CodigoIntegracaoVariacao Para atualizar o estoque da subvariacao informar CodigoIntegracao, CodigoIntegracaoVariacao e CodigoIntegracaoSubVariacao Parâmetros de Entrada Tipo Tamanho Estoque Estoque Retorno Tipo Tamanho SalvarEstoqueLst Baseado em uma coleçao de estoque, atualiza os campos de estoque do produto. Importante: O método SalvarEstoque será utilizado para atualizar Produtos, Variações e SubVariações, seguindo a seguinte regra: Para atualizar o estoque do produto, informar somente o CodigoIntegracao Para atualizar o estoque da variação informar somente CodigoIntegracao e CodigoIntegracaoVariacao Para atualizar o estoque da subvariacao informar CodigoIntegracao, CodigoIntegracaoVariacao e CodigoIntegracaoSubVariacao Sugere-se o número de 200 itens dentro da coleção a ser operada; Parâmetros de Entrada Tipo Tamanho List<Estoque> Estoque[] Retorno Tipo Tamanho Propriedades Estoque do Produto Objeto: Estoque Nome Tipo de dado Obrigatório Chave Tamanho CodigoIntegracao CodigoIntegracaoVariacao CodigoIntegracaoSubVariacao EstoqueMinimo Id de identificação da integração do produto pai String Sim Sim 50 Exemplo: 4 Id de identificação da integração da variação String Não Sim 50 Exemplo: 40 Id de identificação da integração da subvariação String Não Sim 50 Exemplo: 456 Estoque mínimo Int Sim Não 8 EstoqueAtual Saldo do Estoque Atual do produto Int Sim Não 8 O Salvar estoque irá atualizar (sobrescrever) o estoque atual no produto. Não será feito acréscimo ou desconto do estoque. Exemplo: 23 28

29 Fluxo de Menus Personalizados s BuscaMenusPersonalizados Retorna todos os menus personalizados do sistema Parâmetros de Entrada Tipo Tamanho Retorno Tipo Tamanho Resposta IEnumerable<Menu> BuscaRelacaoMenuCategoria Retorna a relação entre um menu e uma categoria, se houver. Retorna null se não houve relação. Parâmetros de Entrada Tipo Tamanho menuid Int 8 Identificador do menu personalizado categoriaid Int 8 Identificador da categoria Retorno Tipo Tamanho Resposta MenuRelation Efetua o relacionamento entre um menu personalizado que seja vinculável, e uma categoria do sistema que seja pai. SetaRelacaoMenuSecao Validações: - A categoria deve ser pai. Quando vinculamos uma categoria pai, automaticamento suas categorias filhas serão vinculadas. Não pode ser vinculado uma categoria filha por este método. - O menu personalizado deve ser vinculável, ou seja, quando ela estará disponível para que uma categoria seja associada a ele. Acesso pela propriedade Vinculavel na classe Menu. Parâmetros de Entrada Tipo Tamanho Relation MenuRelation Retorno Tipo Tamanho Categoria Inexistente Categoria deve ser uma categoria pai Propriedades Menu Objeto: Menu Nome Tipo de dado Obrigatório Chave Tamanho MenuID MenuTitulo Identificador do menu personalizado Int Sim Sim 8 Exemplo: 4 Título do menu String Sim Não 50 Exemplo: Menu Horizontal 29

30 MenuAlias Ativo Vinculavel Alias de identificação do menu String Sim Não 50 Exemplo: menu-horizontal Indica se o menu está ativo Bool Sim Não - Indica se o menu é vinculável, ou seja, pode ser associável Bool Sim Não - MenuRelation Objeto: MenuRelation Nome Tipo de dado Obrigatório Chave Tamanho MenuID Identificador do menu personalizado Int Sim Sim 8 Exemplo: 4 CategoriaID Identificador da categoria Int Sim Sim 8 Exemplo: 3 OrdemSecao Ordem que a categoria ocupará no menu Int Sim Não 8 Exemplo: 1 30

31 Fluxo de Clientes Arquitetura Endereço do Serviço: s ClientesDisponiveis Retorna uma coleção de clientes disponíveis para integração. A quantidade de clientes retornados está ligada ao parâmetro layer_nummaxclientefila configurado na tabela ezcommerce_configuracoes. Parâmetros de Entrada Tipo Tamanho - - Retorno Tipo Tamanho 31

32 ConfirmaRecebimentoCliente Confirma o recebimento de um cliente, removendo o mesmo da fila de integração. Parâmetros de Entrada Tipo Tamanho Protocolo String 36 Retorno Tipo Tamanho 701 Protocolo inexistente ou cliente já removido da fila de integração. ConfirmaRecebimentoClienteLst Confirma o recebimento de uma lista de clientes, removendo os mesmos da fila de integração. Parâmetros de Entrada Tipo Tamanho Protocolo String[] Retorno Tipo Tamanho 701 Protocolo inexistente ou cliente já removido da fila de integração. Propriedades Cliente Objeto: Cliente Nome Tipo de dado Obrigatório Chave Tamanho Protocolo ClienteID TipoCliente Apelido Nome DataNascimento Sexo CNPJ Uma hash de identificação da integração do cliente String Sim Não 36 Comentário: Essa hash será utilizada para remover da fila de integração o cliente integrado com sucesso. Exemplo: 724f8c63-b2fb c-3b5b03cb1c8c Id de identificação do cliente Int (Positivo) Sim Sim 8 Exemplo: 15 Tipo de cadastro do cliente TipoClienteEnum Sim Não 1 Cliente poderá ser do tipo Pessoa Física ou Pessoa Jurídica. Dependendo do Tipo de Cliente, as validações serão aplicadas somente nos campos utilizados por esse tipo. Exemplo: PessoaFisica String Não Não 100 Nome do cliente String Não Não 150 Somente para TipoCliente = PessoaFisica Exemplo: João da Silva Data de nascimento Datetime Não Não 16 Somente para TipoCliente = PessoaFisica Sexo do cliente ClienteSexoEnum Não Não 1 Somente para TipoCliente = PessoaFisica Exemplo: Masculino CNPJ da empresa String Não Não 16 Somente para TipoCliente = PessoaJuridica Somente números. Exemplo:

33 Inscrição Estadual da empresa String Não Não 16 IE RazaoSocial NomeFantasia CPF RG Logradouro Numero Complemento CEP Bairro Cidade Estado Pais Telefone Telefone2 Celular Fax DataCadastro Receber Somente para TipoCliente = PessoaJuridica Somente números. Exemplo: Razão social da empresa String Não Não 150 Somente para TipoCliente = PessoaJuridica Nome fantasia da empresa String Não Não 150 Somente para TipoCliente = PessoaJuridica CPF da pessoa física String Não Não 11 Somente para TipoCliente = PessoaFisica Somente números. Exemplo: Registro Geral da pessoa físcia String Não Não 10 Somente para TipoCliente = PessoaFisica Somente números e letras.sem. Ou traços. Exemplo: Logradouro do endereço do cliente String Não Não 250 Exemplo: Av. Assis Brasil Número do endereço do cliente String Não Não 50 Exemplo: 154 Complemento do endereço do cliente String Não Não 150 Exemplo: Sala 504 CEP do endereço do cliente String Não Não 8 Somente números. Exemplo: Bairro do endereço do cliente String Não Não 150 Exemplo: Lindóia Cidade do endereço do cliente String Não Não 50 Exemplo: Porto Alegre Estado do endereço do cliente String Não Não 2 Versão abreviada do Estado Exemplo: RS, SP, RJ Pais do endereço do cliente String Não Não 2 Versão abreviada do país Exemplo: BR Telefone principal do cliente String Não Não 50 Exemplo: Telefone secundário do cliente String Não Não 50 Exemplo: Telefone celular do cliente String Não Não 50 Exemplo: Fax do cliente String Não Não 50 Exemplo: do cliente String Sim Não 100 Também utilizado como login para a área do cliente e processo de compra. O não poderá repetir. Exemplo: nome@cliente.com.br Data do registro do cliente no site Datetime Sim Não 16 Indica se o cliente deseja receber s (newsletters) Boolean Não Não 1 True = Sim, deseja 33

34 ComoDescobriu Exemplo: True Texto livre para indicar como o cliente descobriu o site String Não Não 50 Observacoes Observações do cadastro do cliente String Não Não 1000 Exemplo: IP IP no momento do cadastro do cliente String Não Não 20 Exemplo: Tipo de Cliente Valores Objeto: TipoClienteEnum PessoaFisica PessoaJuridica Cadastro para tipo de pessoa física (possui campos CPF, RG, Nome, Data Nascimento, Sexo) Cadastro para tipo de pessoa jurídia (possui campos CNPJ, IE, Razão Social, Nome Fantasia) Cliente Sexo Valores Masculino Objeto: ClienteSexoEnum Feminino 34

35 Fluxo de Pedidos Arquitetura Endereço do Serviço: 35

36 s PedidosDisponiveis Retorna uma coleção de pedidos disponíveis para integração. A quantidade de pedidos retornados está ligada ao parâmetro layer_nummaxpedidofila configurado na tabela ezcommerce_configuracoes. Parâmetros de Entrada Tipo Tamanho - - Retorno Tipo Tamanho PedidosDisponiveisComFiltro Retorna uma coleção de pedidos disponíveis para integração. A quantidade de pedidos retornados está ligada ao parâmetro layer_nummaxpedidofila configurado na tabela ezcommerce_configuracoes. Leva em consideração um filtro pré-definido. Parâmetros de Entrada Tipo Tamanho Filter PedidoFiltro Retorno Tipo Tamanho PedidosAtualizados Retorna uma coleção de pedidos disponíveis para integração. Os pedidos retornados através desse método são pedidos que sofreram qualquer tipo de alteração. A quantidade de pedidos retornados está ligada ao parâmetro layer_nummaxpedidofila configurado na tabela ezcommerce_configuracoes. Parâmetros de Entrada Tipo Tamanho - - Retorno Tipo Tamanho ConfirmaRecebimentoPedido Confirma o recebimento de um pedido, removendo o mesmo da fila de integração. Parâmetros de Entrada Tipo Tamanho Protocolo String 36 Retorno Tipo Tamanho 801 Protocolo inexistente ou pedido já removido da fila de integração. 36

37 ConfirmaRecebimentoPedidoLst Confirma o recebimento de uma lista de pedidos, removendo os mesmos da fila de integração. Parâmetros de Entrada Tipo Tamanho Protocolo String[] Retorno Tipo Tamanho 801 Protocolo inexistente ou pedido já removido da fila de integração. ConfirmaRecebimentoPedidoAtualizado Confirma o recebimento de um pedido, removendo o mesmo da fila de integração de pedidos atualizados. Parâmetros de Entrada Tipo Tamanho Protocolo String 36 Retorno Tipo Tamanho 801 Protocolo inexistente ou pedido já removido da fila de integração. ConfirmaRecebimentoPedidoAtualizadoLst Confirma o recebimento de uma lista de pedidos, removendo os mesmos da fila de integração de pedidos atualizados. Parâmetros de Entrada Tipo Tamanho Protocolo String[] Retorno Tipo Tamanho 801 Protocolo inexistente ou pedido já removido da fila de integração. AtualizarStatusPedido Atualiza status de determinado pedido informado pelo cliente. Parâmetros de Entrada Tipo Tamanho StatusPedido StatusPedido Retorno Tipo Tamanho 4001 Pedido não encontrado. 37

38 CriarPacote Cria um pacote de entrega de produtos para o pedido. Parâmetros de Entrada Tipo Tamanho Pacote Pacote Retorno Tipo Tamanho 320 Status de andamento de pacote informado não encontrado 335 O produto {Alias} não foi encontrado no pedido. Verificar se não foi removido. 337 O produto {0} possui uma quantidade indevida para a montagem do pacote. Verificar a quantidade contratada no pedido de acordo com oque ja foi despachado Pedido não encontrado RemoverPacotePorPacoteID Exclui um pacote de entrega de produtos para um pedido. Parâmetros de Entrada Tipo Tamanho PacoteID int Identificador do pacote Retorno Tipo Tamanho 315 Pacote não encontrado. RemoverPacotePorCodigoBarras Exclui um pacote de entrega de produtos para um pedido. Parâmetros de Entrada Tipo Tamanho CodigoBarras string 20 Código de barras do pacote Retorno Tipo Tamanho 315 Pacote não encontrado. 326 Código de barras não informado AtualizarStatusPacotePorPacoteID Atualiza o status de um pacote de entrega de produtos para um pedido. Parâmetros de Entrada Tipo Tamanho PacoteID Int Identificador do pacote TrackingStatusID Int Status do pacote Observacoes string Observações a respeito da troca de status Retorno Tipo Tamanho 38

39 315 Pacote não encontrado. 320 Status de andamento de pacote informado não encontrado AtualizarStatusPacotePorCodigoBarras Atualiza o status de um pacote de entrega de produtos para um pedido. Parâmetros de Entrada Tipo Tamanho CodigoBarras string Código de barras do pacote TrackingStatusID Int Status do pacote Observacoes string Observações a respeito da troca de status Retorno Tipo Tamanho 315 Pacote não encontrado. 326 Código de barras não informado 320 Status de andamento de pacote informado não encontrado AdicionarProdutoPacote Adiciona um produto a um pacote existente. Parâmetros de Entrada Tipo Tamanho List<PacoteProduto> PacoteProduto[] Retorno Tipo Tamanho 315 Pacote não encontrado. 104 Identifica que um produto não foi localizado no banco de dados 337 Lista de produtos a serem adicionados ao pacote O produto {0} possui uma quantidade indevida para a montagem do pacote. Verificar a quantidade contratada no pedido de acordo com oque ja foi despachado RemoverProdutoPacote Remove um produto de um pacote. Parâmetros de Entrada Tipo Tamanho List<PacoteProduto> PacoteProduto[] Lista de produtos a serem removidos do pacote Retorno Tipo Tamanho 315 Pacote não encontrado. 104 Identifica que um produto não foi localizado no banco de dados SalvarCupomDesconto Insere o cupom de desconto. Atualiza todos os campos do cupom, se existir. 39

40 Parâmetros de Entrada Tipo Tamanho CupomDesconto CupomDesconto Retorno Tipo Tamanho 104 Produto informado não encontrado Propriedades Pedido Objeto: Pedido Nome Tipo de dado Obrigatório Chave Tamanho Protocolo PedidoID ClienteID FormaEntregaID ValorTotal ValorFrete ValorEncargos ValorDesconto ValorEmbalagemPresente Protocolo de integração String Sim Sim 36 Um hash gerado para cada item na integração que será utilizado posteriormente para chamar o método ConfirmaRecebimentoPedido Exemplo: 25446B38-A1F2-441A-8A9D-E7551E Código do pedido Int (positivo) Sim Sim 8 Exemplo: ID de identificação do cliente Int (positivo) Sim Não 8 Exemplo: 451 ID de identificação da forma de entrega Int (positivo) Sim Não 8 Ver tabela de referência Formas de Entrega Exemplo: 15 Valor total do pedido Money Sim Não 8,2 Valor total informado ao cliente. Exemplo: 155,24 Valor do frete do pedido. Money Sim Não 8,2 Exemplo: 10,00 Valor de todos os encargos do pedido. Money Sim Não 8,2 Encargos podem ser acréscimos, taxas, etc. Exemplo: 154,66 Valor do desconto praticado no pedido. Money Sim Não 8,2 Exemplo: 44,55 Valor da embalagem para presente. Money Sim Não 8,2 Exemplo: 45,22 DataVenda Data da venda do pedido Datetime Sim Não 16 EntregaNome Entrega EntregaTelefone EntregaLogradouro EntregaNumero EntregaComplementoEndereco Nome cadastrado no endereço de entrega String Sim Não 200 Exemplo: João da Silva cadastrado no endereço de entrega String Sim Não 200 Exemplo: joao@dominio.com.br Telefone cadastrado no endereço de entrega String Não Não 200 Exemplo: Logradouro cadastrado no endereço de entrega String Sim Não 200 Exemplo: Avenida Assis Brasil Numero cadastrado no endereço de entrega String Sim Não 200 Exemplo: 25 Complemento cadastrado no endereço de entrega Exemplo: Casa String Não Não 200 EntregaBairro Bairro cadastrado no endereço de entrega String Sim Não

41 EntregaCidade EntregaEstado EntregaPais EntregaCEP CupomCodigo CupomValorDesconto FormasDePagamento ConfirmacaoPagamento Itens Observacoes ObservacoesLoja AfiliadoID StatusID StatusDesc FormaEntregaAlias PrevisaoEntregaEmDias Exemplo: Auxiliadora Cidade cadastrada no endereço de entrega String Sim Não 200 Exemplo: Porto Alegre Estado cadastrado no endereço de entrega String Sim Não 2 Exemplo: RS País cadastrado no endereço de entrega String Sim Não 2 Exemplo: BR Cep cadastrado no endereço de entrega String Sim Não 8 Somente números. Exemplo: Código do cupom de desconto utilizado no pedido String Sim Não 20 Exemplo: XSFDSG34 Valor do cupom de desconto utilizado Money Sim Não 8,2 Exemplo: 154,22 Forma de pagamento utilizada no pedido FormaDePagamento Sim Não - Ver objeto FormDePagamento. Confirmacao do Pagamento ConfirmacaoPagamento Não Não - Objeto que representa a confirmação do pagamento para formas de pagamento que necessitam de análise e aprovação, como cartões de crédito Braspag. Ver objeto ConfirmacaoPagamento. Coleção de itens do pedido [] PedidoItem Sim Não - Ver objeto PedidoItem Observações do cliente no pedido String Não Não 1000 Exemplo: Entregar após meio dia Observações da loja no pedido String Não Não 1000 Id de identificação do afiliado Int (Positivo) Não Não 8 Exemplo: 14 Status do pedido no momento da integração Int (Positivo) Não Não 8 Ver tabela de referencia de Status Nome do status do pedido String Não Não 200 Exemplo: Aguardando Pagamento Alias da forma de entrega String Não Não 50 Previsão de entrega para o pedido int Não Não 8 MaiorDisponibilidadeItem Valor da maior disponibilidade de entrega dentro dos itens que compoem o pedido int Não Não 8 PedidoFiltro Objeto: PedidoFiltro Nome Tipo de dado Obrigatório Chave Tamanho DataInicial DataInicial StatusID PedidoID Data Inicial do pedido DateTime Não Não - Data final do pedido DateTime Não Não - Status do pedido no momento da integração Int (Positivo) Não Não 8 Ver tabela de referencia de Status Identificador do pedido Int(Positivo) Não Não 9 Exemplo: 1 41

42 PedidoAcompanhamento Objeto: PedidoAcompanhamento Nome Tipo de dado Obrigatório Chave Tamanho Protocolo de integração String Sim Sim 36 Protocolo PedidoID StatusID StatusDesc DataAtualizacao Um hash gerado para cada item na integração que será utilizado posteriormente para chamar o método ConfirmaRecebimentoPedido Exemplo: 25446B38-A1F2-441A-8A9D-E7551E Código do pedido Int (positivo) Sim Sim 8 Exemplo: Status do pedido no momento da integração Int (Positivo) Não Não 8 Ver tabela de referencia de Status Nome do status do pedido String Não Não 200 Exemplo: Aguardando Pagamento Data em que o pedido foi atualizado DateTime Não Não 8 Forma de Pagamento Objeto: FormaDePagamento Nome Tipo de dado Obrigatório Chave Tamanho FormaPagamentoID Valor CartaoNumero CartaoCodigoSeguranca CartaoValidade CartaoNomeImpresso CartaoQuantidadeParcelas CartaoCodigoAutorizacao BoletoVencimento ID de identificação da forma de pagamento Int (positivo) Sim Não 8 Exemplo: 15 Valor a ser pago com essa forma de pagamento Money Sim Não 8,2 Exemplo: 140,55 Número do cartão de crédito String Não Não 16 Somente informado se for forma de pagamento Cartão de Crédito e estiver configurado para enviar dados do cartão. Código de segurança do cartão de crédito String Não Não 3 Somente informado se for forma de pagamento Cartão de Crédito e estiver configurado para enviar dados do cartão. Validade do cartão de crédito String Não Não 6 Somente informado se for forma de pagamento Cartão de Crédito e estiver configurado para enviar dados do cartão. Formato: AAAAMM Exemplo: Nome impresso no cartão de crédito String Não Não 50 Somente informado se for forma de pagamento Cartão de Crédito e estiver configurado para enviar dados do cartão. Número de parcelas do cartão Int Não Não 8 Somente informado se for forma de pagamento Cartão de Crédito e estiver configurado para enviar dados do cartão. Código de autorização da transação por cartão de String Não Não 50 crédito Somente informado se for forma de pagamento Cartão de Crédito e estiver configurado para enviar dados do cartão. Somente informado se o cartão for autorizado no momento do fechamento do pedido Data de vencimento do boleto Datetime Não Não 16 BoletoNumeroBancario FormaDePagamentoAlias Número do boleto bancário String Não Não 50 Somente informado se o pagamento for com boleto bancário Alias da forma de pagamento String Não Não 50 42

43 Item do Pedido Objeto: PedidoItem Nome Tipo de dado Obrigatório Chave Tamanho CodigoIntegracao CodigoIntegracaoVariacao CodigoIntegracaoSubVariacao PrecoUnitario Quantidade EmbalagemPresente AtributosEspeciais PrecoCusto Id de identificação do produto String Sim Sim 50 Se for uma venda de variação ou subvariação, esse campo será o id do produto pai. Exemplo: 2 Id de identificação da variação String Não Não 50 Se for uma venda de subvariação, esse campo será o id do produto pai da subvariacao Exemplo: 5 Id de identificação da subvariação String Não Não 50 Exemplo: 10 Preço unitário do item Money Sim Não 8,2 Exemplo: 15,55 Quantidade desse item no pedido Int (positivo) Sim Não 8 Exemplo: 2 Flag indicando se esse item deve ser embalado para presente Exemplo: true Boolean Sim Não 1 Atributos do produto String Não Não 500 Texto descritivo dos atributos escolhidos pelo cliente Exemplo: Modelo: Corsa Preço de custo do item do pedido Money Sim Não 8,2 PrevisaoEntregaEmDias DisponibilidadeItem NomeDoProduto Previsão de entrega para o pedido int Não Não 8 Valor da disponibilidade de entrega do item int Não Não 8 Nome do produto String Não Não 500 Confirmação de Pagamento Objeto: ConfirmacaoPagamento Nome Tipo de dado Obrigatório Chave Tamanho Status CodigoErro MensagemErro CodigoAutorizacao IdTransacaoBraspag Status da confirmação de pagamento String Sim Sim 50 Status da confirmação de pagamento da forma de pagamento selecionada. Cada forma de pagamento poderá ter seu grupo de status e deverá ser consultado com a EZ Commerce no momento do desenvolvimento. Exemplo: 00 Código de Erro String Não Não 50 Código de erro retornado pela forma de pagamento Exemplo: 5 Mensagem de erro String Não Não 50 Mensagem de erro retornada pela forma de pagamento Exemplo: 10 Código de Autorização String Sim Não 50 Código de autorização retornado pela forma de pagamento Exemplo: 15,55 Id da transação String Sim Não 50 Id da transação quando a forma de pagamento for Braspag Exemplo: 2 DataCaptura Data de Captura String Não Não 50 43

44 Data de captura da transação recebida da operadora Exemplo: :00:00 Status do Pedido Objeto: StatusPedido Nome Tipo de dado Obrigatório Chave Tamanho PedidoID Código do pedido Int (positivo) Sim Não 8 Exemplo: Id do status a ser atualizado no pedido Int (positivo) Sim Não 8 StatusID Ver tabela de referência Status do Pedido NotificarCliente Template ID NumeroObjeto Flag indicando se a integração deve enviar para o cliente informando o novo status Exemplo: true Id do template de a ser enviado notificando o cliente Ver tabela de referência Templates de Boolean Sim Não 1 Int (positivo) Sim Não 1 Código de envio da transportadora String Não Não 50 Exmeplo: BR342353CX Pacote Objeto: Pacote Nome Tipo de dado Obrigatório Chave Tamanho PacoteID Código do pacote. Ao criar pacote, valor NULO. Int(positivo) Não Sim 8 Exemplo: 1 PedidoCodigo Código do pedido. Int(positivo) Sim Não 8 Exemplo: 1 TrackingStatus Código do status do acompanhamento do pacote. Int(positivo) Sim Não 8 Exemplo: 1 DataCriacao Data da criação do pacote. Datetime Sim Não 16 Exemplo: 05/04/2010 FormaDeEnvio Código da forma de envio do pacote. Int(positivo) Sim Não 8 Exemplo: 1 CodigoObjeto Código de envio dos correios. String Não Não 50 Exemplo: BR XX Entregue Indica se o pacote foi entregue. Boolean Sim Não 1 Exemplo: false DataEntrega Data de entrega do pacote. Datetime Não Não 16 Exemplo: 05/04/2010 CodigoBarra Código de barras do pacote. String Não Não 30 Exemplo: PacoteProduto Coleção de produtos do pacote. [] PacoteProduto Sim Não Ver objeto PacoteProduto 44

45 Observacoes Observações. String Não Não 200 Exemplo: Pacote enviado na data Produtos de um pacote Objeto: PacoteProduto Nome Tipo de dado Obrigatório Chave Tamanho PacoteID Código do pacote. Int(positivo) Não Sim 8 Exemplo: 1 ProdutoCodigo Código de integracao do produto. Int(positivo) Sim Não 8 Exemplo: 1 VariacaoCodigo Código de integracao da variação. Int(positivo) Não Não 8 Exemplo: 1 SubVariacaoCodigo Código de integracao da subvariação. Int(positivo) Não Não 8 Exemplo: 1 Quantidade Quantidade do produto. Int(positivo) Sim Não 8 Exemplo: 10 Data Data de envio. Datetime Sim Não 16 Exemplo: 05/04/2010 Acompanhamento de pacote Objeto: PacoteAcompanhamentoStatus Nome Tipo de dado Obrigatório Chave Tamanho PacoteID Código do pacote. Int(positivo) Sim Sim 8 Exemplo: 1 TrackingStatusID Código do status do acompanhamento. Int(positivo) Sim Sim 8 Exemplo: 1 Data Data do acompanhamento. Datetime Sim Não 16 Exemplo: 05/04/2010 Observacao Observações do acompanhamento. String Não Não 50 Exemplo: Pacote enviado na data Cupom de Desconto Objeto: CupomDesconto Nome Tipo de dado Obrigatório Chave Tamanho Cupom Titulo Id de indentificação do cupom de desconto. String Não Não 10 Deverá ser um código aleatório de 10 posições, que será informado para o cliente. Deve conter apenas letras maiúsculas e números. Exemplo: 8T5F7O7R6C Título para identificar o cupom String Sim Não 100 Exemplo: Cupom para pedido

46 Ativo ValorMinimo DataInicio DataFim LimiteUso Desconto TipoDesconto ValorDesconto FreteGratis Produtos Clube ClubePalavraChave ClubeTitulo ClubeTemplate Indica se o cupom está ativo Bool Sim Não 1 Exemplo: True Valor mínimo do pedido para aplicar o desconto Money Sim Não 8,2 Indica o valor mínimo para tornar o desconto válido, assim será possível criar um cupom para as compras acima de R$ 100,00 Exemplo: 10,00 Data de inicio da validade do cupom Datetime Sim Não 16 Exemplo: 23/03/2010 Data de fim da validade do cupom Datetime Sim Não 16 Exemplo: 23/03/2011 Identifica qual o comportamento de uso do cupom LimiteUsoEnum Sim Não - Pode ser indeterminado, podendo ser utilizado quantas vezes quiser, apenas barrado pelas datas. Ou 1 vez e o cupom é invalidado. Exemplo: 1vez Flag que indica que o cupom deve dar desconto no pedido/produtos Bool Sim Não 1 Exemplo: true Indica o tipo de desconto do cupom TipoDescontoEnum Não Não - O Cupom pode dar desconto % ou em R$ Exemplo: Percentual É obrigatório se a propriedade Desconto vier marcada como true Indica o valor em % ou em R$ para o desconto Decimal Não Não 10,2 O valor do desconto %: 40,55 siginifica 40,55 % O valor em R$ deve ser o valor absoluto: 56,32 siginifica R$ 56,32 de desconto É obrigatório se a propriedade Desconto vier marcada como true Flag que indica que o cupom deve dar frete grátis no pedido/produtos Bool Sim Não 1 Exemplo: true Coleção de produtos [] string Não Não - Coleção de CodigoIntegracao dos produtos que fazem parte do cupom. Se essa coleção não for informada, o cupom será aplicado para o pedido. Se for informado, o cupom será aplicado somente para os produtos. (tanto desconto como frete grátis) Indica se o cupom faz parte de um clube Bool Sim Não 1 Exemplo: true Palavra chave para entrar no clube String Não Não 20 É obrigatório se a propriedade Clube vier marcada como true Exemplo: clubeloja Título do clube String Não Não 100 É obrigatório se a propriedade Clube vier marcada como true Exemplo: Produtos especiais para você Template do skin do clube String Não Não 20 Exemplo: clube-hdtv Limite de Uso do Cupom Objeto: LimiteUsoEnum Valores 1vez Indeterminado Tipo de Desconto do Cupom Objeto: TipoDescontoEnum Valores Percentual Valor 46

47 Tabelas de Códigos de Referência para Integração Endereço: Status do Pedido Formas de Pagamento Formas de Entrega Templates de Status de Rastreamento Códigos de Associações Lista todos os status possíveis de pedidos. Novos status deverão ser cadastrados através da ferramenta administrativa (Configurações / Situações de Pedido) Lista todas as formas de pagamento cadastradas no sistema. Novas formas de pagamento poderão ser cadastradas/configuradas através da ferramenta administrativa (Configurações / Formas de Pagamento) Lista todas as formas de entrega cadastradas no sistema. Novas formas de entrega poderão ser cadastradas/configuradas através da ferramenta administrativa (Configurações / Formas de Entrega) Lista todos os templates de s cadastrados no sistema. Novos templates de poderão ser cadastradas/configuradas através da ferramenta administrativa (Configurações / s Personalizados) Lista os status de rastreamento cadastrados no sistema. Lista os códigos de associações cadastrados no sistema. Histórico de Alterações Data Versão Histórico de Alterações Autor 15/04/ Implementações do tracking de pedidos s Cícero Wolowski CriarPacote RemoverPacotePorPacoteID RemoverPacotePorPacoteID AtualizarStatusPacotePorPacoteID AtualizarStatusPacotePorCodigoBarras AtualizarStatusPacotePorObjeto AdicionarProdutoPacote RemoverProdutoPacote Objetos Pacote AcompanhamentoStatus PacoteProduto PacoteAcompanhamentoStatus Codigos de Erro 47

48 315 - Pacote não encontrado Status de andamento de pacote informado não encontrado Código de barras não informado Código do pacote e código de barras não informados O produto {Alias} não foi encontrado no pedido. Verificar se não foi removido O pedido não possui produtos ativos para a montagem do pacote O produto {Alias} possui uma quantidade indevida para a montagem do pacote. Verificar a quantidade contratada no pedido de acordo com oque ja foi despachado 04/05/ Implementações associações de produtos s SalvarProduto Cícero Wolowski Objetos Produto Codigos de Erro Produto O código de associação informado {0} nao foi encontrado. 05/05/ Implementações criação de cupom de desconto s SalvarCupomDesconto Cícero Wolowski Objetos CupomDesconto Enumeradores LimiteUsoEnum TipoDescontoEnum 11/05/ Implementações lista de produtos s SalvarListaProdutos Cícero Wolowski Objetos ListaProdutos LIstaProdutosLista 16/09/ Implementação da leitura das filas da layer por multiplos sistemas Cícero Wolowski de um mesmo cliente s: PedidosAtualizados ConfirmaRecebimentoPedidoAtualizado ConfirmaRecebimentoPedidoAtualizadoLst Objetos PedidoAcompanhamento 17/05/ Implementação de visibilidade de produtos. Jefferson Souza 48

49 Implementeção de visibiliade de seções. 03/06/ Implementação de novos campos para pacote de presente no Jefferson Souza produto 19/01/ Fluxo de criação de pacotes testado e alterado para aceitar Jefferson Souza variação e subvariação. 15/02/ Inclusão de métodos dos menus personalizados Leonardo Bortolini 18/02/ Inclusão do parâmetro Observações da loja no método de Leonardo Bortolini PedidosDisponiveis 20/02/ Inclusão do parâmetro DataCaptura no método de PedidosDisponiveis na ConfirmacaoPagamento. Gustavo Baladão 49

50 Exemplo de integração no Visual Studio 2008 Passo 1: Criando a referência com o serviço. 1. No visual Studio, criar o projeto da integração. 2. Clicar com o direito no projeto criado no solution Explorer e ir em Add Service Reference A tela de Add Service Reference, digitar em Address o endereço do serviço 4. No campo Namespace colocar o nome para a referencia (Ex: Catalogo) 50