INTEGRAÇÃO E-COMMERCE CIASHOP ERP VIRTUAL AGE Legenda: Ciashop Virtual Age Compradores (Customers) Clientes Departamentos (Department) Tipo de Classificação Subdepartamentos Em desenvolvimento Pedidos (Orders) Pedido de Venda Status do pedido Situação Produto (Product) Produto Produto com Variantes (Variant) Grade: Cor/Tamanho Preço Valor / Tipo valor: Preço = 1 Estoque Saldo / Tipo saldo: Físico = 1 Parcelamento (Installment) - Indicação de item de integração contemplado no ERP assinalado com (X): Item de Integração (WS) Virtual Age (ERP) 1. Departamentos X X 2. Produtos X X 3. Produtos c/ Variantes X X 4. Envio de Compradores X X 5. Recebimento de Compradores X X 6. Envio de Pedidos X X 7. Recebimento de Pedidos X X 8. Envio de Pedidos (Embarcados) X X 9. Emissão de NFC-e - X 10. Emissão de NF-e - X 11. Meios de Pagamento X - 12. Promoções X - 13. Tabela de Preços X - 14. Moedas X - 15. Tabela de Frete X - 16. Parcelamento X - Configuração do sistema Virtual Age: Parâmetro Código do tipo de classificação que equivale CD_TPCLAS_INT_CIASHOP_PRD ao departamento de produto para o E- commerce Ciashop.
Defina um Tipo de Classificação para Departamento (PRDFL011-Lista/Manutenção Tipo de Classificação) e classifique cada um deles conforme as figuras 1 e 2 com os campos destacados na cor azul de exemplo logo abaixo (PRDFL012-Lista/Manutenção Classificação): Figura 1-Lista/Manutenção Tipo de Classificação Figura 2-Lista/Manutenção Classificação O sistema possui Multivalor e Multisaldo de produto e para a integração com o E-commerce foi utilizado, por padrão, os códigos de número 1 inicialmente, sem parametrização.
Para a atribuição do preço do produto o sistema seleciona o Tipo de valor Preço de código 1-VENDA, veja no exemplo da figura 3 o destaque na cor azul. Normalmente este tipo de valor já é pré-definido na base de dados de implantação. Para a atribuição do estoque do produto o sistema seleciona o Tipo de saldo de código 1- FÍSICO, veja no exemplo da figura 4 o destaque na cor azul. Normalmente este tipo de saldo já é pré-definido na base de dados de implantação, observe o campo Inativo desmarcado. Figura 3-Lista/Manutenção Tipo de Valor Figura 4-Lista/Manutenção Tipo Saldo Considerações: A contratação do sistema Virtual Age com a integração com E-commerce da Ciashop deve ser realizada pelo Depto. Comercial.
A integração por meio do srv-robô sincroniza automaticamente a base de dados do ambiente do cliente ERP conectado a um User no servidor Linux com os parâmetros necessários no arquivo kettle.properties pelo setor técnico, conforme Manual de Integração do Setor de Análise de Projetos. Sincronização de pessoa cliente: no Cadastro de Pessoa grave a Opção de Cliente para que a caixa de seleção no Tipo funcional fique selecionada como Cliente [ ] Ativo. O cadastro precisa, além dos dados principais da tela inicial, conter um e-mail válido, se houver mais de um será selecionado o Padrão [ ], veja a figura 5 de exemplo: Figura 5-Cadastro de Pessoa Opção Cliente
Figura 06-Cadastro de Pessoa Manutenção de Cliente Campos com * (asterisco) são de preenchimento obrigatório e com (*) (entre parêntesis) são preenchidos automaticamente. Comprador (E-commerce) / Clientes (ERP) Descrição da Propriedade (Ciashop) Descrição de campo na tela (ERP) ID (identificador=código) do cliente gerado pela Dados de pessoa -> Código (*) plataforma. Data e hora de criação do registro. Dados de cliente -> Atualização (*) Data e hora de alteração do registro. Dados de cliente -> Atualização (*) Nome completo do comprador (nome e Dados de pessoa -> Nome * sobrenomes). E-mail do comprador. E-mail -> Email Código de área do telefone do comprador. Telefone -> Número Número do telefone do comprador. Telefone -> Número Código de área do telefone secundário do Telefone -> Número comprador. Número do telefone secundário do comprador. Telefone -> Número Sexo do comprador. Dados pessoa física -> Sexo Data de nascimento do comprador. Dados pessoa física -> Data nascimento Estado civil do comprador. Dados pessoa física -> Estado civil Tipo da pessoa do comprador. Dados de pessoa -> Tipo fiscal* Tipo do documento de identificação do Dados de pessoa -> Tipo fiscal* comprador. Número do documento de identificação. Dados de pessoa -> Número CPF/CNPJ
Tipo do documento regional. Dados de pessoa -> Tipo fiscal* Número do documento regional. Se Dados de pessoa->tipo fiscal* =Física, campo RG, se não se Dados de pessoa->tipo fiscal* =Jurídica, campo CNPJ Sigla do estado (UF) referente ao documento Se Dados de pessoa->tipo fiscal* regional. =Jurídica, campo Estado da Inscrição estadual Profissão do comprador. Dados pessoa física -> Cargo/Função Indica se o comprador aceita receber as newsletters da loja. Quantidade de bônus corrente do comprador. Status do comprador. Tipo funcional -> Cliente/Situação Endereço de cobrança associada ao comprador. Endereço -> Tipo*, CEP, Tipo Logradouro e Logradouro, Número, Bairro, Complemento, Município, UF, País, Referência Lista de endereços de entrega associados ao Endereço -> Tipo*, CEP, Tipo Logradouro comprador. e Logradouro, Número, Bairro, Complemento, Município, UF, País, Referência Fonte E-commerce: http://wiki.ciashop.com.br/desenvolvedores/apis/customers/ Figura 07-Manutenção de Grupo/Grade
Produto (E-commerce) / Produto (ERP) Descrição da Propriedade (Ciashop) Descrição de campo na tela (ERP) ID (identificador=código) do produto gerado. Dados > Código do produto > Grade -> Cor/Tamanho = Código do Produto (*) Data e hora de criação do registro. Dados -> Atualização (*) Data e hora de alteração do registro. Dados -> Atualização (*) Nome do produto. Dados -> Descrição * Descrição resumida do produto. Descrição produto -> Descrição grupo Data e hora do início de exibição do selo de prévenda do produto. Data a partir da qual o produto deixa de exibir o selo de pré-venda e passa a exibir o selo de lançamento. Data e hora do fim da exibição do selo de lançamento do produto. Indica se o produto está ou não bloqueado para venda. Produtos com status de bloqueados não são exibidos em qualquer lugar da loja, nem aparecem em resultados de buscas. Quantidade de bônus que o produto oferece quando de sua compra. Ordem em que o produto é exibido nas páginas do departamento. Quanto menor a ordem, antes o produto será exibido. Código de referência do produto cadastrado no Dados -> Código* (Grupo completo) ERP. ID (identificador=código) do departamento Classificação > Classificação -> Tipo principal do produto. classificação Array (lista) dos códigos de departamentos Classificação > Classificação -> Tipo vinculados ao produto. classificação ID (identificador=código) do parcelamento cadastrado no produto. Veja a API de Installments. Indica se o produto pode ou não ser vendido quando está fora de estoque. Mensagem de disponibilidade do produto, exibida quando o produto está fora de estoque. Exemplo: Disponibilidade em 15 dias. Indica se o produto exibe o alerta para escolha de variante na loja. Indica se o produto precisa ou não de aceite de contrato para sua compra. Descrição do contrato de aceite do produto. URL da página do produto (sem domínio). Tipo de desconto no produto.
Valor do desconto do produto. Data e hora de início da vigência do desconto. Data e hora de término da vigência do desconto. ID (identificador=código) da variante principal do Dados -> Produto padrão produto. Nome da variação 1 do produto. Inclusão produto > Grade -> Cor Indica o tipo de exibição da definição 1 para o produto. Pode ser combobox (os valores de definição são exibidos em uma lista para escolha), image (permite enviar uma imagem representativa dos valores de definição) ou text (os valores de definição são exibidos lado a lado na página do produto). Indica se a definição 1 é exibida nas vitrines da loja. Somente uma definição pode ser exibida por vez. Objeto com os valores da definição 1. Esses Inclusão produto > Grade -> valores são os valores da definição determinada Cor/Tamanho no campo definition1. É o valor que representa a variante conforme Inclusão produto > Grade -> informado no definition1. Cor/Tamanho É url da imagem que representa o valor Imagem > Imagem -> informado, será informada a url completa para visualização da imagem. É o nome do arquivo informado. Imagem > Imagem -> Arquivo Nome da variação 2 do produto. Informação não Inclusão produto > Grade -> Tamanho obrigatória. Exemplo: Tamanho Indica o tipo de exibição da definição 2 para o produto. Pode ser combobox (os valores de definição são exibidos em uma lista para escolha), image (permite enviar uma imagem representativa dos valores de definição) ou text (os valores de definição são exibidos lado a lado na página do produto). Indica se a definição 2 é exibida nas vitrines da loja. Somente uma definição pode ser exibida por vez. Objeto com os valores da definição 2. Esses Inclusão produto > Grade -> valores são os valores da definição determinada Cor/Tamanho no campo definition1. É o valor que representa a variante conforme Inclusão produto > Grade -> informado no definition2. Cor/Tamanho É url da imagem que representa o valor Imagem > Imagem -> informado, será informada a url completa para visualização da imagem. É o nome do arquivo informado. Imagem > Imagem -> Arquivo
Informa se o produto está configurado para aceitar solicitações de Orçamento. Fonte E-commerce: http://wiki.ciashop.com.br/desenvolvedores/apis/products/ Figura 8-Manutenção de Pedido de Venda (Capa) Figura 9-Detalhe da Baixa do Pedido de Venda
Figura10-Manutenção de Item de Pedido de Venda RESPONSE: Lista da descrição dos campos retornados na requisição de um Pedido (E-commerce) / Pedido (ERP) Response Descrição da Propriedade (Ciashop) Descrição de campo na tela (ERP) ID (identificação=código) do pedido, gerado pela Dados ->Número pedido cliente plataforma. Data e hora de criação do Dados ->Inclusão Data e hora da última alteração dos dados do Dados ->Atualização Status (estágio atual) do Pedido ->Situação* Motivos de cancelamento. [Consultar] > Alteração de situação > Motivo -> Cancelamento Mensagem de status exibida ao lojista. Mensagem de status exibida ao comprador. Código do template onde o pedido foi realizado. Valor do subtotal do É a soma dos preços Dados ->Valor total finais dos itens do Objeto que tem os dados dos descontos e acréscimos no valor total do Tipo de desconto ou acréscimo. Valor do desconto/acréscimo. Descrição do desconto/acréscimo. Código do cupom que utilizado no
Lista com as promoções que foram aplicadas no Código da promoção que foi aplicada no Nome da promoção. Indica o tipo da promoção. Dados de entrega do ID (identificação=código) do fornecedor do cálculo de frete. ID (identificação=código) do método de entrega. Nome do método de entrega. Exemplo: Sedex Valor do frete, sem qualquer desconto. Valor do frete, com desconto. Se o frete não tiver Dados ->Percentual frete utilizado promoções, será idêntico ao cost. Mensagem do prazo de entrega do Preço das taxas (seguro etc.) sobre o valor do frete. Prazo mínimo, em dias, de entrega do pacote para o método de entrega. Prazo máximo, em dias, de entrega do pacote para o método de entrega. É o código da cotação de frete que foi realizada para o Total a pagar (ou pago) pelo [Consultar... Baixa] Detalhe da baixa > Nota fiscal -> Valor total Dados do endereço de entrega selecionado para o Nome do local de entrega do Exemplo: trabalho. Nome da pessoa que receberá a entrega. Dados > [Pessoa] Dados de pessoa -> Nome* Nome do logradouro de entrega do (Depende do Tipo* de Endereço) Dados > [Pessoa] Endereço -> Logradouro Número predial do endereço de entrega do (Depende do Tipo* de Endereço) Complemento do número predial. Dados > [Pessoa] Endereço -> Número (Depende do Tipo* de Endereço) Dados > [Pessoa] Endereço -> Complemento Nome do bairro do endereço de entrega do (Depende do Tipo* de Endereço) Dados > [Pessoa] Endereço -> Bairro Nome da cidade do endereço de entrega do (Depende do Tipo* de Endereço) Dados > [Pessoa] Endereço -> Município* (busca do CEP) Sigla do Estado do endereço de entrega do (Depende do Tipo* de Endereço)
Apenas estados brasileiros. Dados > [Pessoa] Endereço -> UF (busca do CEP) Sigla do país do endereço de entrega conforme (Depende do Tipo* de Endereço) padrão ISO 3166. Dados > [Pessoa] Endereço -> País (busca do CEP) CEP do endereço de entrega do (Depende do Tipo* de Endereço) Dados > [Pessoa] Endereço -> CEP* Ponto de referência do endereço de entrega do (Depende do Tipo* de Endereço) Dados > [Pessoa] Endereço -> Referência Código de área (DDD) do telefone principal Dados > [Pessoa] Telefone -> associado ao endereço de entrega do Tipo/Número Número do telefone alternativo associado ao Dados > [Pessoa] Telefone -> endereço de entrega do Tipo/Número Indica se o pedido foi realizado por um comprador tipo guest (convidado). (True/False) ID (identificador=código) do comprador. Se o Dados ->Cliente* pedido foi realizado por comprador guest terá valor nulo. Dados de cobrança do Nome do comprador. Dados > [Pessoa] Dados de pessoa -> Nome* E-mail do comprador. Dados > [Pessoa] E-mail -> Tipo/Email Tipo da pessoa. Dados > [Pessoa] Dados de pessoa -> Tipo fiscal* Tipo de documento. (Depende do Tipo* da pessoa, antes) Dados > [Pessoa] Dados de pessoa -> Tipo fiscal* Número do documento da pessoa (CPF ou CNPJ). (Depende do Tipo* da pessoa, antes) Dados > [Pessoa] Dados de pessoa -> Número CPF ou CNPJ Nome do logradouro do endereço de cobrança do (Depende do Tipo* de Endereço, Dados > [Pessoa] Endereço -> Logradouro Número predial do endereço de cobrança do (Depende do Tipo* de Endereço, Dados > [Pessoa] Endereço -> Número Complemento do número predial. (Depende do Tipo* de Endereço, Dados > [Pessoa] Endereço -> Complemento Nome do bairro do endereço de cobrança do (Depende do Tipo* de Endereço, Dados > [Pessoa] Endereço -> Bairro Nome da cidade do endereço de cobrança do (Depende do Tipo* de Endereço,
Dados > [Pessoa] Endereço -> Município* (busca do CEP) Sigla do Estado do endereço de cobrança do (Depende do Tipo* de Endereço, Dados > [Pessoa] Endereço -> UF (busca do CEP) Sigla do país do endereço de cobrança (conforme (Depende do Tipo* de Endereço, padrão ISO 3166). Dados > [Pessoa] Endereço -> País (busca do CEP) CEP do endereço de entrega do (Depende do Tipo* de Endereço, Dados > [Pessoa] Endereço -> CEP* Ponto de referência do endereço de cobrança do (Depende do Tipo* de Endereço, Dados > [Pessoa] Endereço -> Referência Código de área (DDD) do telefone principal Dados > [Pessoa] Telefone -> associado ao endereço de cobrança do Tipo/Número Número do telefone principal associado ao Dados > [Pessoa] Telefone -> endereço de cobrança do Tipo/Número Código de área (DDD) do telefone alternativo Dados > [Pessoa] Telefone -> associado ao endereço de cobrança do Tipo/Número Sexo do comprador. Dados > [Pessoa] > Pessoa física -> Sexo Data de nascimento do comprador. Dados > [Pessoa] Dados de pessoa -> Data nascimento Identificação do carrinho (checkstock). Identificação de cotação retornado pelo serviço (checkstock). Número IP da máquina de onde o pedido foi realizado. URL (endereço HTTP) de origem do URL (domínio) no qual o pedido foi realizado. Indica a origem do Dados ->Operador/Componente Dados do comprador. Veja a API Customers. Dados dos itens do Veja a API Order Itens. São as informações sobre todas as remessas existentes para o Veja a API Shipments. São as informações sobre todas as transações realizadas para o Veja a API PaymentTransactions. Informa se o pedido é do tipo payment ou
subscription. Quando a transação for do tipo Subscription, será exibido esse novo campo onde é informado o Token de Recorrência. Dados dos documentos fiscais vinculados com o Veja a API Invoices. Objeto que contém as informações da tabela de preço utilizada no Código interno da tabela de preço utilizada no Este id é gerado pela plataforma. Código ERP da tabela de preço utilizada no Nome da tabela de preço, conforme definido em seu cadastro. Indica o nome do canal de origem informado pelo próprio App quando realizou o POST do Fonte: http://wiki.ciashop.com.br/desenvolvedores/apis/orders/ Figura 11-Manutenção de Item de Pedido de Venda Item de Pedido: os itens de pedido são vinculados ao pedido que deve ter no mínimo uma variante (Cor/Tamanho) com quantidade e valor definidos para o produto (Sku) em uma sequência.
Itens de Pedido (E-commerce) / Itens de Pedido (ERP) OrderItems Descrição da Propriedade (Ciashop) Descrição de campo na tela (ERP) ID (identificador) sequencial do item é gerado [Item...] > Grupo -> Seq. pela plataforma. Data e hora de inserção do item no pedido [Item...] > Grade -> Inclusão realizado. Padrão ISO 8601 UTC. Data e hora da última alteração do item no [Item...] > Grade -> Atualização Padrão ISSO 8601 UTC. ID (identificador) sequencial do produto que foi [Item...] > Grade -> Produto comprado. ID (identificador) sequencial da variante que foi [Item...] > Grade -> Cor / Tamanho comprada. Código de referência da variante para o ERP, essa [Item...] > Grade -> Grupo / Código informação é utilizada para a integração da loja com sistemas de terceiros. Lista com as promoções que foram aplicadas no item do Código da promoção que foi aplicada no item do É o preço ajustado da variante. Nesse preço é [Item...] > Grade -> Valor unitário considerado quaisquer ofertas/descontos para a variante, sendo o seu valor unitário final. É a quantidade da variante que foi comprada. [Item...] > Grade -> Quantidade solicitada É a mensagem de disponibilidade que está configurada para o produto. Quando o produto possui estoque é exibida a mensagem de disponibilidade. Quando o produto está fora do estoque é exibida uma mensagem de indisponibilidade para o produto. É o valor de Bônus ganho pela compra do item em questão. Essa informação pode ser configurada pelo lojista no cadastro do produto. Objeto que contém as informações sobre a embalagem escolhida para o item. Cada item de pedido possui seu próprio embrulho de presente, quando o comprador não escolher nenhum embrulho o objeto package será entregue, porém os campos Id e Description serão iguais a null. É o ID (identificador) do pacote de presente. É a descrição do pacote de presente que o comprador escolheu. É a soma do valor do pacote de presente e o cartão que o comprador escolher para o item. O campo value representa a soma do embrulho de presente e do cartão. Por isso poderá possuir
um valor quando o item não possuir embrulho, nesse caso o valor é referente ao cartão escolhido pelo comprador. Objeto que contém as informações sobre o cartão de presente escolhido para o item. Cada item de pedido possui seu próprio cartão, quando o comprador não escolher nenhum cartão o objeto card será entregue, porém o campo message será igual a null. É a mensagem que comprador inseriu para o cartão que acompanhará o item do Identifica o tipo do produto que foi comprado no Objeto que retorna a url de GET da variante. Objeto que retorna a url de GET do produto. Objeto que retorna a lista de módulos acoplados ao item do Módulos são propriedades do item, por exemplo, personalizações (customizações) do produto. Identificação do módulo. Exemplo: customization Nome do módulo. Exemplo: customização do produto. URL de acesso às informações do módulo associado ao item do Objeto que retorna a url de GET para a API de OrderKitItems do Kit que está vinculado ao Fonte E-commerce: http://wiki.ciashop.com.br/desenvolvedores/apis/orderitems/ Descrição das propriedades das entidades do E-commerce conforme Central de Suporte Ciashop. Link: http://wiki.ciashop.com.br/desenvolvedores/apis/