INTEGRAO E-COMMERCE CIASHOP ERP VIRTUAL AGE

Legenda:
Ciashop
Compradores (Customers)
Departamentos (Department)
Subdepartamentos
Pedidos (Orders)
Status do pedido
Produto (Product)
Produto com Variantes (Variant)
Preo
Estoque
Parcelamento (Installment)

Virtual Age
Clientes
Tipo de Classificao
Em desenvolvimento
Pedido de Venda
Situao
Produto
Grade: Cor/Tamanho
Valor / Tipo valor: Preo = 1
Saldo / Tipo saldo: Fsico = 1
-

Indicao de item de integrao contemplado no ERP assinalado com (X):

1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.

Item de Integrao
Departamentos
Produtos
Produtos c/ Variantes
Envio de Compradores
Recebimento de Compradores
Envio de Pedidos
Recebimento de Pedidos
Envio de Pedidos (Embarcados)
Emisso de NFC-e
Emisso de NF-e
Meios de Pagamento
Promoes
Tabela de Preos
Moedas
Tabela de Frete
Parcelamento

(WS)
X
X
X
X
X
X
X
X
X
X
X
X
X
X

Virtual Age (ERP)

X
X
X
X
X
X
X
X
X
X
-

Configurao do sistema Virtual Age:

Parmetro
Cdigo do tipo de classificao que equivale
CD_TPCLAS_INT_CIASHOP_PRD ao departamento de produto para o Ecommerce Ciashop.

Integrao VirtualAge - Ciashop - Legenda.Tabela.Consideraes

Defina um Tipo de Classificao para Departamento (PRDFL011-Lista/Manuteno

Tipo de Classificao) e classifique cada um deles conforme as figuras 1 e 2 com os
campos destacados na cor azul de exemplo logo abaixo (PRDFL012-Lista/Manuteno
Classificao):
Figura 1-Lista/Manuteno Tipo de Classificao

Figura 2-Lista/Manuteno Classificao

O sistema possui Multivalor e Multisaldo de produto e para a integrao com o E-commerce foi
utilizado, por padro, os cdigos de nmero 1 inicialmente, sem parametrizao.

Integrao VirtualAge - Ciashop - Legenda.Tabela.Consideraes

Para a atribuio do preo do produto o sistema seleciona o Tipo de valor Preo de

cdigo 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 implantao.
Para a atribuio do estoque do produto o sistema seleciona o Tipo de saldo de cdigo 1FSICO, veja no exemplo da figura 4 o destaque na cor azul. Normalmente este tipo de
saldo j pr-definido na base de dados de implantao, observe o campo Inativo
desmarcado.
Figura 3-Lista/Manuteno Tipo de Valor

Figura 4-Lista/Manuteno Tipo Saldo

Consideraes:
A contratao do sistema Virtual Age com a integrao com E-commerce da Ciashop deve
ser realizada pelo Depto. Comercial.

Integrao VirtualAge - Ciashop - Legenda.Tabela.Consideraes

A integrao 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 parmetros
necessrios no arquivo kettle.properties pelo setor tcnico, conforme Manual de
Integrao do Setor de Anlise de Projetos.
Sincronizao de pessoa cliente: no Cadastro de Pessoa grave a Opo de Cliente para
que a caixa de seleo no Tipo funcional fique selecionada como Cliente [ ] Ativo. O
cadastro precisa, alm dos dados principais da tela inicial, conter um e-mail vlido, se
houver mais de um ser selecionado o Padro [ ], veja a figura 5 de exemplo:
Figura 5-Cadastro de Pessoa Opo Cliente

Integrao VirtualAge - Ciashop - Legenda.Tabela.Consideraes

Figura 06-Cadastro de Pessoa Manuteno de Cliente

Campos com * (asterisco) so de preenchimento obrigatrio e com (*) (entre parntesis) so

preenchidos automaticamente.
Comprador (E-commerce) / Clientes (ERP)
Descrio da Propriedade (Ciashop)
Descrio de campo na tela (ERP)
ID (identificador=cdigo) do cliente gerado pela
Dados de pessoa -> Cdigo (*)
plataforma.
Data e hora de criao do registro.
Dados de cliente -> Atualizao (*)
Data e hora de alterao do registro.
Dados de cliente -> Atualizao (*)
Nome completo do comprador (nome e
Dados de pessoa -> Nome *
sobrenomes).
E-mail do comprador.
E-mail -> Email
Cdigo de rea do telefone do comprador.
Telefone -> Nmero
Nmero do telefone do comprador.
Telefone -> Nmero
Cdigo de rea do telefone secundrio do
Telefone -> Nmero
comprador.
Nmero do telefone secundrio do comprador.
Telefone -> Nmero
Sexo do comprador.
Dados pessoa fsica -> Sexo
Data de nascimento do comprador.
Dados pessoa fsica -> Data nascimento
Estado civil do comprador.
Dados pessoa fsica -> Estado civil
Tipo da pessoa do comprador.
Dados de pessoa -> Tipo fiscal*
Tipo do documento de identificao do
Dados de pessoa -> Tipo fiscal*
comprador.
Nmero do documento de identificao.
Dados de pessoa -> Nmero CPF/CNPJ

Integrao VirtualAge - Ciashop - Legenda.Tabela.Consideraes

Tipo do documento regional.

Nmero do documento regional.

Sigla do estado (UF) referente ao documento

regional.
Profisso do comprador.
Indica se o comprador aceita receber as
newsletters da loja.
Quantidade de bnus corrente do comprador.
Status do comprador.
Endereo de cobrana associada ao comprador.

Dados de pessoa -> Tipo fiscal*

Se Dados de pessoa->Tipo fiscal*
=Fsica, campo RG, se no se Dados de
pessoa->Tipo fiscal* =Jurdica, campo
CNPJ
Se Dados de pessoa->Tipo fiscal*
=Jurdica, campo Estado da Inscrio
estadual
Dados pessoa fsica -> Cargo/Funo

Tipo funcional -> Cliente/Situao

Endereo -> Tipo*, CEP, Tipo Logradouro
e Logradouro, Nmero, Bairro,
Complemento, Municpio, UF, Pas,
Referncia
Lista de endereos de entrega associados ao
Endereo -> Tipo*, CEP, Tipo Logradouro
comprador.
e Logradouro, Nmero, Bairro,
Complemento, Municpio, UF, Pas,
Referncia
Fonte E-commerce: http://wiki.ciashop.com.br/desenvolvedores/apis/customers/
Figura 07-Manuteno de Grupo/Grade

Integrao VirtualAge - Ciashop - Legenda.Tabela.Consideraes

Produto (E-commerce) / Produto (ERP)

Descrio da Propriedade (Ciashop)
Descrio de campo na tela (ERP)
ID (identificador=cdigo) do produto gerado.
Dados > Cdigo do produto > Grade ->
Cor/Tamanho = Cdigo do Produto (*)
Data e hora de criao do registro.
Dados -> Atualizao (*)
Data e hora de alterao do registro.
Dados -> Atualizao (*)
Nome do produto.
Dados -> Descrio *
Descrio resumida do produto.
Descrio produto -> Descrio grupo
Data e hora do incio de exibio do selo de prvenda do produto.
Data a partir da qual o produto deixa de exibir o
selo de pr-venda e passa a exibir o selo de
lanamento.
Data e hora do fim da exibio do selo de
lanamento do produto.
Indica se o produto est ou no bloqueado para
venda. Produtos com status de bloqueados no
so exibidos em qualquer lugar da loja, nem
aparecem em resultados de buscas.
Quantidade de bnus que o produto oferece
quando de sua compra.
Ordem em que o produto exibido nas pginas
do departamento. Quanto menor a ordem, antes o
produto ser exibido.
Cdigo de referncia do produto cadastrado no
Dados -> Cdigo* (Grupo completo)
ERP.
ID (identificador=cdigo) do departamento
Classificao > Classificao -> Tipo
principal do produto.
classificao
Array (lista) dos cdigos de departamentos
Classificao > Classificao -> Tipo
vinculados ao produto.
classificao
ID (identificador=cdigo) do parcelamento
cadastrado no produto. Veja a API de
Installments.
Indica se o produto pode ou no 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 no de aceite de
contrato para sua compra.
Descrio do contrato de aceite do produto.
URL da pgina do produto (sem domnio).
Tipo de desconto no produto.

Integrao VirtualAge - Ciashop - Legenda.Tabela.Consideraes

Valor do desconto do produto.

Data e hora de incio da vigncia do desconto.
Data e hora de trmino da vigncia do desconto.
ID (identificador=cdigo) da variante principal do
produto.
Nome da variao 1 do produto.
Indica o tipo de exibio da definio 1 para o
produto. Pode ser comboBox (os valores de
definio so exibidos em uma lista para
escolha), image (permite enviar uma imagem
representativa dos valores de definio) ou text
(os valores de definio so exibidos lado a lado
na pgina do produto).
Indica se a definio 1 exibida nas vitrines da
loja. Somente uma definio pode ser exibida por
vez.
Objeto com os valores da definio 1. Esses
valores so os valores da definio determinada
no campo definition1.
o valor que representa a variante conforme
informado no definition1.
url da imagem que representa o valor
informado, ser informada a url completa para
visualizao da imagem.
o nome do arquivo informado.
Nome da variao 2 do produto. Informao no
obrigatria. Exemplo: Tamanho
Indica o tipo de exibio da definio 2 para o
produto. Pode ser comboBox (os valores de
definio so exibidos em uma lista para
escolha), image (permite enviar uma imagem
representativa dos valores de definio) ou text
(os valores de definio so exibidos lado a lado
na pgina do produto).
Indica se a definio 2 exibida nas vitrines da
loja. Somente uma definio pode ser exibida por
vez.
Objeto com os valores da definio 2. Esses
valores so os valores da definio determinada
no campo definition1.
o valor que representa a variante conforme
informado no definition2.
url da imagem que representa o valor
informado, ser informada a url completa para
visualizao da imagem.
o nome do arquivo informado.

Dados -> Produto padro

Incluso produto > Grade -> Cor

Incluso produto > Grade ->

Cor/Tamanho
Incluso produto > Grade ->
Cor/Tamanho
Imagem > Imagem ->

Imagem > Imagem -> Arquivo

Incluso produto > Grade -> Tamanho

Incluso produto > Grade ->

Cor/Tamanho
Incluso produto > Grade ->
Cor/Tamanho
Imagem > Imagem ->

Imagem > Imagem -> Arquivo

Integrao VirtualAge - Ciashop - Legenda.Tabela.Consideraes

Informa se o produto est configurado para

aceitar solicitaes de Oramento.
Fonte E-commerce: http://wiki.ciashop.com.br/desenvolvedores/apis/products/
Figura 8-Manuteno de Pedido de Venda (Capa)

Figura 9-Detalhe da Baixa do Pedido de Venda

Integrao VirtualAge - Ciashop - Legenda.Tabela.Consideraes

Figura10-Manuteno de Item de Pedido de Venda

RESPONSE: Lista da descrio dos campos retornados na requisio de um pedido.

Pedido (E-commerce) / Pedido (ERP)
Response
Descrio da Propriedade (Ciashop)
Descrio de campo na tela (ERP)
Dados ->Nmero pedido cliente
ID (identificao=cdigo) do pedido, gerado pela
plataforma.
Data e hora de criao do pedido.
Dados ->Incluso
Data e hora da ltima alterao dos dados do
Dados ->Atualizao
pedido.
Status (estgio atual) do pedido.
Pedido ->Situao*
Motivos de cancelamento.
[Consultar] > Alterao de situao >
Motivo -> Cancelamento
Mensagem de status exibida ao lojista.
Mensagem de status exibida ao comprador.
Cdigo do template onde o pedido foi realizado.
Valor do subtotal do pedido. a soma dos preos Dados ->Valor total
finais dos itens do pedido.
Objeto que tem os dados dos descontos e
acrscimos no valor total do pedido.
Tipo de desconto ou acrscimo.
Valor do desconto/acrscimo.
Descrio do desconto/acrscimo.
Cdigo do cupom que utilizado no pedido.
Integrao VirtualAge - Ciashop - Legenda.Tabela.Consideraes

Lista com as promoes que foram aplicadas no

pedido.
Cdigo da promoo que foi aplicada no pedido.
Nome da promoo.
Indica o tipo da promoo.
Dados de entrega do pedido.
ID (identificao=cdigo) do fornecedor do
clculo de frete.
ID (identificao=cdigo) do mtodo de entrega.
Nome do mtodo de entrega. Exemplo: Sedex
Valor do frete, sem qualquer desconto.
Valor do frete, com desconto. Se o frete no tiver Dados ->Percentual frete
utilizado promoes, ser idntico ao cost.
Mensagem do prazo de entrega do pedido.
Preo das taxas (seguro etc.) sobre o valor do
frete.
Prazo mnimo, em dias, de entrega do pacote para
o mtodo de entrega.
Prazo mximo, em dias, de entrega do pacote
para o mtodo de entrega.
o cdigo da cotao de frete que foi realizada
para o pedido.
Total a pagar (ou pago) pelo pedido.
[Consultar... Baixa] Detalhe da baixa >
Nota fiscal -> Valor total
Dados do endereo de entrega selecionado para
o pedido.
Nome do local de entrega do pedido. Exemplo:
trabalho.
Nome da pessoa que receber a entrega.
Dados > [Pessoa] Dados de pessoa ->
Nome*
Nome do logradouro de entrega do pedido.
(Depende do Tipo* de Endereo)
Dados > [Pessoa] Endereo ->
Logradouro
Nmero predial do endereo de entrega do
(Depende do Tipo* de Endereo)
pedido.
Dados > [Pessoa] Endereo -> Nmero
Complemento do nmero predial.
(Depende do Tipo* de Endereo)
Dados > [Pessoa] Endereo ->
Complemento
Nome do bairro do endereo de entrega do
(Depende do Tipo* de Endereo)
pedido.
Dados > [Pessoa] Endereo -> Bairro
Nome da cidade do endereo de entrega do
(Depende do Tipo* de Endereo)
pedido.
Dados > [Pessoa] Endereo ->
Municpio* (busca do CEP)
Sigla do Estado do endereo de entrega do

(Depende do Tipo* de Endereo)

Integrao VirtualAge - Ciashop - Legenda.Tabela.Consideraes

pedido. Apenas estados brasileiros.

Sigla do pas do endereo de entrega conforme
padro ISO 3166.
CEP do endereo de entrega do pedido.
Ponto de referncia do endereo de entrega do
pedido.
Cdigo de rea (DDD) do telefone principal
associado ao endereo de entrega do pedido.
Nmero do telefone alternativo associado ao
endereo de entrega do pedido.
Indica se o pedido foi realizado por um
comprador tipo guest (convidado). (True/False)
ID (identificador=cdigo) do comprador. Se o
pedido foi realizado por comprador guest ter
valor nulo.
Dados de cobrana do pedido.
Nome do comprador.
E-mail do comprador.
Tipo da pessoa.
Tipo de documento.

Nmero do documento da pessoa (CPF ou CNPJ).

Nome do logradouro do endereo de cobrana do

pedido.

Nmero predial do endereo de cobrana do

pedido.
Complemento do nmero predial.

Nome do bairro do endereo de cobrana do

pedido.
Nome da cidade do endereo de cobrana do

Dados > [Pessoa] Endereo -> UF

(busca do CEP)
(Depende do Tipo* de Endereo)
Dados > [Pessoa] Endereo -> Pas
(busca do CEP)
(Depende do Tipo* de Endereo)
Dados > [Pessoa] Endereo -> CEP*
(Depende do Tipo* de Endereo)
Dados > [Pessoa] Endereo ->
Referncia
Dados > [Pessoa] Telefone ->
Tipo/Nmero
Dados > [Pessoa] Telefone ->
Tipo/Nmero

Dados ->Cliente*

Dados > [Pessoa] Dados de pessoa ->

Nome*
Dados > [Pessoa] E-mail -> Tipo/Email
Dados > [Pessoa] Dados de pessoa ->
Tipo fiscal*
(Depende do Tipo* da pessoa, antes)
Dados > [Pessoa] Dados de pessoa ->
Tipo fiscal*
(Depende do Tipo* da pessoa, antes)
Dados > [Pessoa] Dados de pessoa ->
Nmero CPF ou CNPJ
(Depende do Tipo* de Endereo,
Cobrana)
Dados > [Pessoa] Endereo ->
Logradouro
(Depende do Tipo* de Endereo,
Cobrana)
Dados > [Pessoa] Endereo -> Nmero
(Depende do Tipo* de Endereo,
Cobrana)
Dados > [Pessoa] Endereo ->
Complemento
(Depende do Tipo* de Endereo,
Cobrana)
Dados > [Pessoa] Endereo -> Bairro
(Depende do Tipo* de Endereo,

Integrao VirtualAge - Ciashop - Legenda.Tabela.Consideraes

pedido.

Sigla do Estado do endereo de cobrana do

pedido.

Sigla do pas do endereo de cobrana (conforme

padro ISO 3166).

CEP do endereo de entrega do pedido.

Ponto de referncia do endereo de cobrana do

pedido.

Cdigo de rea (DDD) do telefone principal

associado ao endereo de cobrana do pedido.
Nmero do telefone principal associado ao
endereo de cobrana do pedido.
Cdigo de rea (DDD) do telefone alternativo
associado ao endereo de cobrana do pedido.
Sexo do comprador.
Data de nascimento do comprador.
Identificao do carrinho (checkstock).
Identificao de cotao retornado pelo servio
(checkstock).
Nmero IP da mquina de onde o pedido foi
realizado.
URL (endereo HTTP) de origem do pedido.
URL (domnio) no qual o pedido foi realizado.
Indica a origem do pedido.
Dados do comprador. Veja a API Customers.
Dados dos itens do pedido. Veja a API Order
Itens.
So as informaes sobre todas as remessas
existentes para o pedido. Veja a API Shipments.
So as informaes sobre todas as transaes
realizadas para o pedido. Veja a API
PaymentTransactions.
Informa se o pedido do tipo payment ou

Cobrana)
Dados > [Pessoa] Endereo ->
Municpio* (busca do CEP)
(Depende do Tipo* de Endereo,
Cobrana)
Dados > [Pessoa] Endereo -> UF
(busca do CEP)
(Depende do Tipo* de Endereo,
Cobrana)
Dados > [Pessoa] Endereo -> Pas
(busca do CEP)
(Depende do Tipo* de Endereo,
Cobrana)
Dados > [Pessoa] Endereo -> CEP*
(Depende do Tipo* de Endereo,
Cobrana)
Dados > [Pessoa] Endereo ->
Referncia
Dados > [Pessoa] Telefone ->
Tipo/Nmero
Dados > [Pessoa] Telefone ->
Tipo/Nmero
Dados > [Pessoa] Telefone ->
Tipo/Nmero
Dados > [Pessoa] > Pessoa fsica ->
Sexo
Dados > [Pessoa] Dados de pessoa ->
Data nascimento

Dados ->Operador/Componente

Integrao VirtualAge - Ciashop - Legenda.Tabela.Consideraes

subscription.
Quando a transao for do tipo Subscription,
ser exibido esse novo campo onde informado
o Token de Recorrncia.
Dados dos documentos fiscais vinculados com o
pedido. Veja a API Invoices.
Objeto que contm as informaes da tabela de
preo utilizada no pedido.
Cdigo interno da tabela de preo utilizada no
pedido. Este id gerado pela plataforma.
Cdigo ERP da tabela de preo utilizada no
pedido.
Nome da tabela de preo, conforme definido em
seu cadastro.
Indica o nome do canal de origem informado pelo
prprio App quando realizou o POST do pedido.

Fonte: http://wiki.ciashop.com.br/desenvolvedores/apis/orders/

Figura 11-Manuteno de Item de Pedido de Venda

Item de Pedido: os itens de pedido so vinculados ao pedido que deve ter no mnimo
uma variante (Cor/Tamanho) com quantidade e valor definidos para o produto (Sku)
em uma sequncia.

Itens de Pedido (E-commerce) / Itens de Pedido (ERP)

OrderItems
Descrio da Propriedade (Ciashop)
Descrio de campo na tela (ERP)
ID (identificador) sequencial do item gerado
[Item...] > Grupo -> Seq.
pela plataforma.
Data e hora de insero do item no pedido
[Item...] > Grade -> Incluso
realizado. Padro ISO 8601 UTC.
Data e hora da ltima alterao do item no
[Item...] > Grade -> Atualizao
pedido. Padro 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.
Cdigo de referncia da variante para o ERP, essa [Item...] > Grade -> Grupo / Cdigo
informao utilizada para a integrao da loja
com sistemas de terceiros.
Lista com as promoes que foram aplicadas no
item do pedido.
Cdigo da promoo que foi aplicada no item do
pedido.
o preo ajustado da variante. Nesse preo
[Item...] > Grade -> Valor unitrio
considerado quaisquer ofertas/descontos para a
variante, sendo o seu valor unitrio 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 Bnus ganho pela compra do item
em questo. Essa informao pode ser
configurada pelo lojista no cadastro do produto.
Objeto que contm as informaes sobre a
embalagem escolhida para o item. Cada item de
pedido possui seu prprio embrulho de presente,
quando o comprador no escolher nenhum
embrulho o objeto package ser entregue,
porm os campos Id e Description sero iguais a
null.
o ID (identificador) do pacote de presente.
a descrio do pacote de presente que o
comprador escolheu.
a soma do valor do pacote de presente e o
carto que o comprador escolher para o item. O
campo value representa a soma do embrulho
de presente e do carto. Por isso poder possuir

um valor quando o item no possuir embrulho,

nesse caso o valor referente ao carto
escolhido pelo comprador.
Objeto que contm as informaes sobre o carto
de presente escolhido para o item. Cada item de
pedido possui seu prprio carto, quando o
comprador no escolher nenhum carto o objeto
card ser entregue, porm o campo message
ser igual a null.
a mensagem que comprador inseriu para o
carto que acompanhar o item do pedido.
Identifica o tipo do produto que foi comprado no
pedido.
Objeto que retorna a url de GET da variante.
Objeto que retorna a url de GET do produto.
Objeto que retorna a lista de mdulos acoplados
ao item do pedido. Mdulos so propriedades do
item, por exemplo, personalizaes
(customizaes) do produto.
Identificao do mdulo. Exemplo:
customization
Nome do mdulo. Exemplo: customizao do
produto.
URL de acesso s informaes do mdulo
associado ao item do pedido.
Objeto que retorna a url de GET para a API de
OrderKitItems do Kit que est vinculado ao
pedido.
Fonte E-commerce: http://wiki.ciashop.com.br/desenvolvedores/apis/orderitems/
Descrio das propriedades das entidades do E-commerce conforme Central de Suporte Ciashop.

Link: http://wiki.ciashop.com.br/desenvolvedores/apis/

Integrao VirtualAge - Ciashop - Legenda.Tabela.Consideraes