Guia de integração omnichannel através de arquivos via FTP/SFTP
A integração omnichannel através de arquivos via FTP/SFTP permite o processamento de grandes volumes de dados de forma simples, ágil e a partir de qualquer plataforma de origem, seja online ou offline.
A partir da geração diária de 4 arquivos, o ICOMM poderá obter as transações (e seus clientes) relevantes para o seu negócio. Ao processá-los, serão obtidos mais de 75 indicadores que serão recalculados diariamente e poderão ser utilizados em processos dinâmicos de segmentação e automação.
Os 4 arquivos de texto simples a seguir devem ser gerados diariamente:
Clientes: O objetivo deste arquivo é conter a lista de clientes (e seus atributos relevantes para a área de marketing) vinculados às transações informadas no arquivo Pedidos, bem como qualquer cliente novo e/ou atualizado para através qualquer uma das fontes de dados gerenciadas pela organização. Nesse arquivo é possível incluir prospects que ainda não efetuaram uma compra. No entanto, é um requisito essencial enviar os clientes que fizeram compras que estão sendo informados no restante dos arquivos.
Pedidos: Este arquivo tem por objetivo conter o resumo das transações faturadas ou pedidos de compra, relatando valores e valores totais, bem como outros atributos relevantes da operação.
OrderDetails: O objetivo deste arquivo é informar a composição da transação ou pedido de compra -> Seus produtos e/ou serviços com seus detalhes ou atributos.
OrderDetailCategories: O objetivo deste arquivo é listar todas as categorias que podem ser atribuídas a cada um dos produtos e/ou serviços incluídos no arquivo OrderDetails.
Pedidos: ICOMMKT_ORDERS_[INSTANCE UNIQUE ID]_YYYYMMDD
OrderDetail: ICOMMKT_ORDERSDETAIL_[INSTANCE UNIQUE ID]_YYYYMMDD
OrderDetailCategories: ICOMMKT_ORDERSDETAILCATEGORIES_[INSTANCE UNIQUE ID]_YYYYMMDD
Clientes: ICOMMKT_CUSTOMERS_[INSTANCE UNIQUE ID]_YYYYMMDD
[UNIQUE INSTANCE ID] deve ser um identificador relativo à instância, quando existem múltiplas marcas/países/unidades de negócio representadas em diferentes instâncias da nossa plataforma.
Os arquivos devem ser gerados diariamente, contendo ou não informações. Quando algum deles não contiver dados, deve ser enviado apenas com a linha do cabeçalho.
É o Id do Usuário/Cliente no sistema fonte de onde o arquivo é gerado. Pode ser qualquer tipo de identificador, até mesmo o próprio EMAIL se os dados forem provenientes de um e-commerce onde não foi atribuído nenhum outro ID ao usuário.
Deve então coincidir com as informações do arquivo de pedidos para vincular o Cliente às suas transações.
Tipo: CHAR(50)
É o Código da loja.
Este campo DEVE ser enviado vazio quando a organização possui um ID de usuário único em todas as suas lojas, que foi unificado em seu sistema de CRM, ERP ou fonte de dados. Reporte somente quando um cliente possui IDs diferentes para cada Loja, onde deve ser detalhado o código da loja que origina este usuário/cliente.
Tipo: CHAR (30)
E-mail
Email do cliente.
Tipo: CHAR(300)
Coleção.
Você pode informar quantos atributos quiser. Acordar as ações que a área de marketing deseja realizar. Cada um de
esses atributos são então transformados em um campo de perfil (banco de dados) dentro da plataforma
Tipo: chave/valor JSON
Formato: Chave/Valor no formato Json
Exemplo: {"Chave":"FIRST_NAME","Valor":"João"},
{"Chave":"LAST_NAME","Valor":"Sanchez"}
É o número da transação ou pedido.
Tipo: CHAR(50)
É o código da loja onde se originou a transação ou pedido.
Tipo: CHAR(30) ()
Id do Usuário/Cliente no sistema de origem de onde o arquivo é gerado.
Tipo: CHAR(50) ()
Data do pedido
Tipo: DATA
Formato: mm/dd/aaaa
Quantidade de Itens no pedido. Ou seja, o número de unidades totais da transação ou pedido, somando os valores informados de cada um dos diferentes produtos.
Tipo: DECIMAL(5,2)
Quantidade de Produtos (diferentes itens) no pedido. Quantidade de diferentes produtos da transação ou pedido. Diferentes SKUs ou ITEM CODE, dependendo do valor informado no ITEM CODE do Arquivo de Detalhes.
Tipo: DECIMAL(5,2)
Valor total e final do pedido incluindo impostos.
Tipo: DECIMAL(10,2)
Valor total dos itens do pedido (Sem impostos)
Tipo: DECIMAL(10,2)
Valor dos descontos aplicados ao pedido. Quer sejam códigos de desconto aplicados no final da operação ou outros descontos por quantidade.
Tipo: DECIMAL(10,2) ()
Custo de envio: Valor total do custo atribuído aos serviços de entrega da mercadoria. Envie zero se não houver entrega e seja retirado na loja.
Tipo: DECIMAL(10,2)
Soma do valor total dos impostos vinculados ao pedido.
Tipo: DECIMAL(10,2)
Códigos de promoção aplicados.
Tipo: TEXTO
Valor total da Encomenda sem custo de envio. Deve haver um valor maior que zero. Deve ser igual a TotalAmount menos ShippingAmount.
Tipo: DECIMAL(10,2)
Tipo de Envio (Ex: Normal, Expresso).
Quando houver mais de um dado a informar para o campo, eles devem ser enviados um após o outro usando um separador diferente do arquivo geral. Por exemplo: VALUE1##VALUE2##VALUE3
Tipo: CHAR(50)
Operadora.
Quando houver mais de um dado a informar para o campo, eles devem ser enviados um após o outro usando um separador diferente do arquivo geral. Por exemplo: VALUE1##VALUE2##VALUE3
Tipo: CHAR(50)
Operadora.
Quando houver mais de um dado a informar para o campo, eles devem ser enviados um após o outro usando um separador diferente do arquivo geral. Por exemplo: VALUE1##VALUE2##VALUE3
Tipo: CHAR(80)
Forma de pagamento (Cartão, dinheiro, paypal, etc.).
Quando houver mais de um dado a informar para o campo, eles devem ser enviados um após o outro usando um separador diferente do arquivo geral. Por exemplo: VALUE1##VALUE2##VALUE3.
Tipo: CHAR(80)
Detalhes da forma de pagamento (Ex: VISA).
Quando houver mais de um dado a informar para o campo, eles devem ser enviados um após o outro usando um separador diferente do arquivo geral. Por exemplo: VALUE1##VALUE2##VALUE3.
Tipo: CHAR(80)
Entidade da forma de pagamento (Ex: Banxo XXX).
Quando houver mais de um dado a informar para o campo, eles devem ser enviados um após o outro usando um separador diferente do arquivo geral. Por exemplo: VALUE1##VALUE2##VALUE3.
Tipo: CHAR(80)
Condições de pagamento (Ex: 1 pagamento, 3 pagamentos, etc).
Quando houver mais de um dado a informar para o campo, eles devem ser enviados um após o outro usando um separador diferente do arquivo geral. Por exemplo: VALUE1##VALUE2##VALUE3.
Tipo: CHAR(50)
Envie valores que vinculem os dados do cabeçalho (ou resumo) do pedido do arquivo Pedidos com seus produtos e/ou linhas.
Envie valores que vinculem os dados do cabeçalho (ou resumo) do pedido do arquivo Pedidos com seus produtos e/ou linhas.
Número da linha. Inteiro incremental para numerar cada uma das linhas do pedido. Envia de 1 a N, onde N é o número total de produtos da transação.
Tipo: INT(11)
Quantia.
Tipo: DECIMAL(5,2)
Código do produto. Código do produto ou SKU com o qual a área de marketing poderá posteriormente identificar o item a segmentar por comportamento de compra do usuário.
Tipo: CHAR(80)
Nome abreviado do produto.
Tipo: CHAR(200)
Marca do produto.
Tipo: CHAR(200)
Descrição do produto.
Tipo: CHAR(200)
Preço do produto. (Preço unitário final do produto após descontos). Sem tributação
Tipo: DECIMAL(10,2)
Preço de tabela. (Preço unitário da lista de produtos. Enviar o mesmo valor do Preço quando não houver descontos ou preços diferenciados). Sem tributação.
Tipo: DECIMAL(10,2)
Preço de venda. (Preço do produto antes dos descontos. Enviar o mesmo valor do Preço quando não houver descontos). Sem tributação.
Tipo: DECIMAL(10,2)
URL da imagem principal do produto. URL da imagem principal do produto em e-commerce ou hospedagem pública. (Enviar vazio se não estiver disponível ou não puder ser obtido).
Tipo: CHAR(255)
URL de detalhes do produto. URL do produto em e-commerce ou hospedagem pública. (Enviar vazio se não estiver disponível ou não puder ser obtido).
Tipo: CHAR(255)
Nome do Vendedor do Produto.
Tipo: CHAR(100)
Código da loja.
Tipo: CHAR(30)
Numero de ordem.
Tipo: CHAR(50)
Número da linha.
Tipo: INT(11)
Use a combinação de Código da loja + Número do pedido + Número da linha para atribuir a categoria à linha do pedido correspondente relatada em OrderDetails.
Categoria de Produto.
Texto curto da categoria.
Tipo: CHAR(255)
Quando um produto possui mais de uma categoria atribuída, deve ser enviado um registro para cada categoria com o mesmo StoreCode/OrderNumber/LineNumber.
Como delimitador é recomendado o uso de “|”.
Todos os campos do tipo DECIMAL devem incorporar o ponto (“.”) como separador decimal. Não use separador de milhar.
Nos campos que não contiverem informações, substitua por vazio (“”) ou zero (0) conforme o caso, dependendo do tipo de dado (Vazio para CHAR, ou Zero para números inteiros ou decimais)
Respeite a ordem dos campos nos arquivos de acordo com o desenho enviado.
Verifique se os 4 arquivos são gerados com a mesma CODIFICAÇÃO.
Remova todos os tipos de caracteres não alfabéticos especiais.
Os formatos serão recebidos em um repositório SFTP. Este repositório pode ser próprio do cliente ou se necessário, o ICOMMKT pode ter um espaço para esta troca de informações.
Baixe esses arquivos de exemplo na Integração Omnichannel no seguinte link.
Têm dúvidas? Consulte as perguntas frequentes sobre Integração Omnichannel em nosso centro de ajuda.
A partir da geração diária de 4 arquivos, o ICOMM poderá obter as transações (e seus clientes) relevantes para o seu negócio. Ao processá-los, serão obtidos mais de 75 indicadores que serão recalculados diariamente e poderão ser utilizados em processos dinâmicos de segmentação e automação.
Formatos
Os 4 arquivos de texto simples a seguir devem ser gerados diariamente:
Clientes: O objetivo deste arquivo é conter a lista de clientes (e seus atributos relevantes para a área de marketing) vinculados às transações informadas no arquivo Pedidos, bem como qualquer cliente novo e/ou atualizado para através qualquer uma das fontes de dados gerenciadas pela organização. Nesse arquivo é possível incluir prospects que ainda não efetuaram uma compra. No entanto, é um requisito essencial enviar os clientes que fizeram compras que estão sendo informados no restante dos arquivos.
Pedidos: Este arquivo tem por objetivo conter o resumo das transações faturadas ou pedidos de compra, relatando valores e valores totais, bem como outros atributos relevantes da operação.
OrderDetails: O objetivo deste arquivo é informar a composição da transação ou pedido de compra -> Seus produtos e/ou serviços com seus detalhes ou atributos.
OrderDetailCategories: O objetivo deste arquivo é listar todas as categorias que podem ser atribuídas a cada um dos produtos e/ou serviços incluídos no arquivo OrderDetails.
Nomenclatura de arquivo
Pedidos: ICOMMKT_ORDERS_[INSTANCE UNIQUE ID]_YYYYMMDD
OrderDetail: ICOMMKT_ORDERSDETAIL_[INSTANCE UNIQUE ID]_YYYYMMDD
OrderDetailCategories: ICOMMKT_ORDERSDETAILCATEGORIES_[INSTANCE UNIQUE ID]_YYYYMMDD
Clientes: ICOMMKT_CUSTOMERS_[INSTANCE UNIQUE ID]_YYYYMMDD
[UNIQUE INSTANCE ID] deve ser um identificador relativo à instância, quando existem múltiplas marcas/países/unidades de negócio representadas em diferentes instâncias da nossa plataforma.
Os arquivos devem ser gerados diariamente, contendo ou não informações. Quando algum deles não contiver dados, deve ser enviado apenas com a linha do cabeçalho.
Estrutura dos arquivos
Clientes
ID do usuário:
É o Id do Usuário/Cliente no sistema fonte de onde o arquivo é gerado. Pode ser qualquer tipo de identificador, até mesmo o próprio EMAIL se os dados forem provenientes de um e-commerce onde não foi atribuído nenhum outro ID ao usuário.
Deve então coincidir com as informações do arquivo de pedidos para vincular o Cliente às suas transações.
Tipo: CHAR(50)
StoreCode
É o Código da loja.
Este campo DEVE ser enviado vazio quando a organização possui um ID de usuário único em todas as suas lojas, que foi unificado em seu sistema de CRM, ERP ou fonte de dados. Reporte somente quando um cliente possui IDs diferentes para cada Loja, onde deve ser detalhado o código da loja que origina este usuário/cliente.
Tipo: CHAR (30)
Email do cliente.
Tipo: CHAR(300)
Dados do cliente
Coleção.
Você pode informar quantos atributos quiser. Acordar as ações que a área de marketing deseja realizar. Cada um de
esses atributos são então transformados em um campo de perfil (banco de dados) dentro da plataforma
Tipo: chave/valor JSON
Formato: Chave/Valor no formato Json
Exemplo: {"Chave":"FIRST_NAME","Valor":"João"},
{"Chave":"LAST_NAME","Valor":"Sanchez"}
Pedidos
Número do pedido
É o número da transação ou pedido.
Tipo: CHAR(50)
StoreCode
É o código da loja onde se originou a transação ou pedido.
Tipo: CHAR(30) ()
ID do usuário
Id do Usuário/Cliente no sistema de origem de onde o arquivo é gerado.
Tipo: CHAR(50) ()
Data
Data do pedido
Tipo: DATA
Formato: mm/dd/aaaa
Total de Itens
Quantidade de Itens no pedido. Ou seja, o número de unidades totais da transação ou pedido, somando os valores informados de cada um dos diferentes produtos.
Tipo: DECIMAL(5,2)
TotalProdutos
Quantidade de Produtos (diferentes itens) no pedido. Quantidade de diferentes produtos da transação ou pedido. Diferentes SKUs ou ITEM CODE, dependendo do valor informado no ITEM CODE do Arquivo de Detalhes.
Tipo: DECIMAL(5,2)
Montante total
Valor total e final do pedido incluindo impostos.
Tipo: DECIMAL(10,2)
ItemsAmount
Valor total dos itens do pedido (Sem impostos)
Tipo: DECIMAL(10,2)
Valor dos descontos
Valor dos descontos aplicados ao pedido. Quer sejam códigos de desconto aplicados no final da operação ou outros descontos por quantidade.
Tipo: DECIMAL(10,2) ()
ShippingAmount
Custo de envio: Valor total do custo atribuído aos serviços de entrega da mercadoria. Envie zero se não houver entrega e seja retirado na loja.
Tipo: DECIMAL(10,2)
Valor do imposto
Soma do valor total dos impostos vinculados ao pedido.
Tipo: DECIMAL(10,2)
Códigos promocionais
Códigos de promoção aplicados.
Tipo: TEXTO
PreShippingAmount
Valor total da Encomenda sem custo de envio. Deve haver um valor maior que zero. Deve ser igual a TotalAmount menos ShippingAmount.
Tipo: DECIMAL(10,2)
Tipo de entrega
Tipo de Envio (Ex: Normal, Expresso).
Quando houver mais de um dado a informar para o campo, eles devem ser enviados um após o outro usando um separador diferente do arquivo geral. Por exemplo: VALUE1##VALUE2##VALUE3
Tipo: CHAR(50)
DeliverySubType
Operadora.
Quando houver mais de um dado a informar para o campo, eles devem ser enviados um após o outro usando um separador diferente do arquivo geral. Por exemplo: VALUE1##VALUE2##VALUE3
Tipo: CHAR(50)
Empresa de entrega
Operadora.
Quando houver mais de um dado a informar para o campo, eles devem ser enviados um após o outro usando um separador diferente do arquivo geral. Por exemplo: VALUE1##VALUE2##VALUE3
Tipo: CHAR(80)
Forma de pagamento
Forma de pagamento (Cartão, dinheiro, paypal, etc.).
Quando houver mais de um dado a informar para o campo, eles devem ser enviados um após o outro usando um separador diferente do arquivo geral. Por exemplo: VALUE1##VALUE2##VALUE3.
Tipo: CHAR(80)
PaymentMethodDetail
Detalhes da forma de pagamento (Ex: VISA).
Quando houver mais de um dado a informar para o campo, eles devem ser enviados um após o outro usando um separador diferente do arquivo geral. Por exemplo: VALUE1##VALUE2##VALUE3.
Tipo: CHAR(80)
PaymentMethodEntity
Entidade da forma de pagamento (Ex: Banxo XXX).
Quando houver mais de um dado a informar para o campo, eles devem ser enviados um após o outro usando um separador diferente do arquivo geral. Por exemplo: VALUE1##VALUE2##VALUE3.
Tipo: CHAR(80)
Termos de pagamento
Condições de pagamento (Ex: 1 pagamento, 3 pagamentos, etc).
Quando houver mais de um dado a informar para o campo, eles devem ser enviados um após o outro usando um separador diferente do arquivo geral. Por exemplo: VALUE1##VALUE2##VALUE3.
Tipo: CHAR(50)
Detalhes do pedido
StoreCode
Envie valores que vinculem os dados do cabeçalho (ou resumo) do pedido do arquivo Pedidos com seus produtos e/ou linhas.
Número do pedido
Envie valores que vinculem os dados do cabeçalho (ou resumo) do pedido do arquivo Pedidos com seus produtos e/ou linhas.
Número da linha
Número da linha. Inteiro incremental para numerar cada uma das linhas do pedido. Envia de 1 a N, onde N é o número total de produtos da transação.
Tipo: INT(11)
Quantidade
Quantia.
Tipo: DECIMAL(5,2)
Código do item
Código do produto. Código do produto ou SKU com o qual a área de marketing poderá posteriormente identificar o item a segmentar por comportamento de compra do usuário.
Tipo: CHAR(80)
Nome do item
Nome abreviado do produto.
Tipo: CHAR(200)
Marca
Marca do produto.
Tipo: CHAR(200)
Descrição
Descrição do produto.
Tipo: CHAR(200)
Preço
Preço do produto. (Preço unitário final do produto após descontos). Sem tributação
Tipo: DECIMAL(10,2)
ListPrice
Preço de tabela. (Preço unitário da lista de produtos. Enviar o mesmo valor do Preço quando não houver descontos ou preços diferenciados). Sem tributação.
Tipo: DECIMAL(10,2)
Preço de venda
Preço de venda. (Preço do produto antes dos descontos. Enviar o mesmo valor do Preço quando não houver descontos). Sem tributação.
Tipo: DECIMAL(10,2)
Imagem URL
URL da imagem principal do produto. URL da imagem principal do produto em e-commerce ou hospedagem pública. (Enviar vazio se não estiver disponível ou não puder ser obtido).
Tipo: CHAR(255)
DetailUrl
URL de detalhes do produto. URL do produto em e-commerce ou hospedagem pública. (Enviar vazio se não estiver disponível ou não puder ser obtido).
Tipo: CHAR(255)
Vendedor
Nome do Vendedor do Produto.
Tipo: CHAR(100)
Categorias de detalhes do pedido
StoreCode
Código da loja.
Tipo: CHAR(30)
Número do pedido
Numero de ordem.
Tipo: CHAR(50)
Número da linha
Número da linha.
Tipo: INT(11)
Use a combinação de Código da loja + Número do pedido + Número da linha para atribuir a categoria à linha do pedido correspondente relatada em OrderDetails.
Categoria
Categoria de Produto.
Texto curto da categoria.
Tipo: CHAR(255)
Quando um produto possui mais de uma categoria atribuída, deve ser enviado um registro para cada categoria com o mesmo StoreCode/OrderNumber/LineNumber.
Anotação geral:
Como delimitador é recomendado o uso de “|”.
Todos os campos do tipo DECIMAL devem incorporar o ponto (“.”) como separador decimal. Não use separador de milhar.
Nos campos que não contiverem informações, substitua por vazio (“”) ou zero (0) conforme o caso, dependendo do tipo de dado (Vazio para CHAR, ou Zero para números inteiros ou decimais)
Respeite a ordem dos campos nos arquivos de acordo com o desenho enviado.
Verifique se os 4 arquivos são gerados com a mesma CODIFICAÇÃO.
Remova todos os tipos de caracteres não alfabéticos especiais.
Transferência
Os formatos serão recebidos em um repositório SFTP. Este repositório pode ser próprio do cliente ou se necessário, o ICOMMKT pode ter um espaço para esta troca de informações.
Arquivos de amostra
Baixe esses arquivos de exemplo na Integração Omnichannel no seguinte link.
Têm dúvidas? Consulte as perguntas frequentes sobre Integração Omnichannel em nosso centro de ajuda.
Atualizado em: 03/08/2023
Obrigado!