Guía de integración Omnicanal a través de archivos vía FTP/SFTP
La integración omnicanal a través de archivos via FTP/SFTP permite procesar grandes volúmenes de datos de forma sencilla, ágil, y desde cualquier plataforma de origen, ya sea en forma online u offline.
A partir de la generación diaria de 4 archivos, ICOMM podrá obtener las transacciones (y sus clientes) relevantes para su negocio. Mediante el procesamiento de los mismos se obtendrán más de 75 indicadores que serán recalculados en forma diaria y podrán ser utilizados en los procesos de segmentación dinámica y automation
Se deben generar diariamente los siguientes 4 archivos de texto plano:
Customers: Este archivo tiene por objeto contener el listado de clientes (y sus atributos relevantes para el área de marketing) vinculados a las transacciones informadas en el archivo de Orders, así como de todo aquel cliente nuevo y/o actualizado a través de alguna de las fuentes de datos que maneje la organización. En este archivo, es posible incluir prospectos que aún no hayan realizado una compra. Sin embargo es requisito indispensable enviar aquellos clientes que hayan realizado compras que estén siendo informadas en el resto de los archivos.
Orders: Este archivo tiene por objeto contener el resumen de las transacciones u órdenes de compra facturadas, informando montos y cantidades totales, así como otros atributos relevantes de la operación.
OrderDetails: Este archivo tiene por objeto informar la composición de la transacción u orden de compra -> Sus productos y/o servicios con el detalle o atributos de los mismos.
OrderDetailCategories: Este archivo tiene por objeto listar toda aquella categorías que podría ser atribuíble a cada uno de los productos y/o servicios onformados en el archivo OrderDetails.
Orders: ICOMMKT_ORDERS_[ID UNICO INSTANCIA]_YYYYMMDD
OrderDetail: ICOMMKT_ORDERSDETAIL_[ID UNICO INSTANCIA]_YYYYMMDD
OrderDetailCategories: ICOMMKT_ORDERSDETAILCATEGORIES_[ID UNICO INSTANCIA]_YYYYMMDD
Customers: ICOMMKT_CUSTOMERS_[ID UNICO INSTANCIA]_YYYYMMDD
[ID UNICO INSTANCIA] debe ser un identificador relativo a la instancia, cuando se posean múltiples marcas/países/unidades de negocio representadas en distintas instancias de nuestra plataforma.
Los archivos deben ser generados diariamente, contengan o no información. Cuando cualquiera de ellos no contenga datos, se deberá enviar el mismo únicamente con la línea de los encabezados.
Es el Id del Usuario/Cliente en el sistema de origen desde donde se genera el archivo. Puede ser cualquier tipo de identificador, incluso el mismo EMAIL si los datos se originan desde un e-commerce donde el usuario no tenga atribuído ningún otro ID.
Debe coincidir luego con el informado en el archivo de órdenes para vincular al Cliente con sus transacciones.
Tipo: CHAR(50)
Es el Código de la tienda.
Este campo DEBE ser enviado vacío cuando la organización posea un ID único de usuario a través de todas sus tiendas, el cual haya sido unificado en su CRM, ERP o sistema de origen de los datos. Informar sólo cuando un cliente posea IDs diferentes para cada Store, donde se debe detallar el código de tienda que origina a este usuario/cliente.
Tipo: CHAR (30)
Email
Email del cliente.
Tipo: CHAR(300)
Colección.
Se pueden informar tantos atributos como se deseen. Consensuar según las acciones que el área de marketing desee realizar. Cada uno de
estos atributos se transforma luego en un campo del perfil (base de datos) dentro de la plataforma
Tipo: JSON Key/Value
Formato: Key/Value en formato Json
Ejemplo: {"Key":"FIRST_NAME","Value":"Juan"},
{"Key":"LAST_NAME","Value":"Sanchez"}
Es el número de transacción u orden.
Tipo: CHAR(50)
Es el código de la tienda donde se originó la transacción u orden.
Tipo: CHAR(30) ()
Id del Usuario/Cliente en el sistema de origen desde donde se genera el archivo.
Tipo: CHAR(50) ()
Fecha de la Orden
Tipo: DATE
Formato: dd/mm/aaaa
Cantidad de Ítems en la orden. Es decir, la cantidad de unidades totales de la transacción u orden, sumando las cantidades informadas de cada uno de los diferentes productos.
Tipo: DECIMAL(5,2)
Cantidad de Productos (artículos diferentes) en la orden. Cantidad de productos diferentes de la transacción u orden. SKU’s o ITEM CODE diferentes, según el valor que se informe en el ITEM CODE del Archivo de Details.
Tipo: DECIMAL(5,2)
Monto total y final de la orden incluyendo los impuestos.
Tipo: DECIMAL(10,2)
Monto total de los ítems de la orden (Sin impuestos)
Tipo: DECIMAL(10,2)
Monto de los descuentos aplicados a la orden. Ya sean códigos de descuento aplicados al final de la operación u otros descuentos por cantidad.
Tipo: DECIMAL(10,2) ()
Costo de envío: Monto total del costo atribuido a los servicios de entrega de la mercadería. Enviar cero en caso de no haber entrega y ser retiro en tienda.
Tipo: DECIMAL(10,2)
Sumatoria del monto total de impuestos vinculados a la orden.
Tipo: DECIMAL(10,2)
Códigos de promoción aplicados.
Tipo: TEXT
Monto Total de la Orden sin costo de envío. Debe venir un valor mayor a cero. Debería ser igual a TotalAmount menos ShippingAmount.
Tipo: DECIMAL(10,2)
Tipo de Envío (Ej: Standard, Express).
Cuando exista más de un dato a informar para el campo, se deberán enviar uno tras otro utilizando un separador diferente al general del archivo. Por ej: VALOR1##VALOR2##VALOR3
Tipo: CHAR(50)
Transportista.
Cuando exista más de un dato a informar para el campo, se deberán enviar uno tras otro utilizando un separador diferente al general del archivo. Por ej: VALOR1##VALOR2##VALOR3
Tipo: CHAR(50)
Transportista.
Cuando exista más de un dato a informar para el campo, se deberán enviar uno tras otro utilizando un separador diferente al general del archivo. Por ej: VALOR1##VALOR2##VALOR3
Tipo: CHAR(80)
Método de pago (Tarjeta, efectivo, paypal, etc.).
Cuando exista más de un dato a informar para el campo, se deberán enviar uno tras otro utilizando un separador diferente al general del archivo. Por ej: VALOR1##VALOR2##VALOR3.
Tipo: CHAR(80)
Detalle del método de pago (Ej: VISA).
Cuando exista más de un dato a informar para el campo, se deberán enviar uno tras otro utilizando un separador diferente al general del archivo. Por ej: VALOR1##VALOR2##VALOR3.
Tipo: CHAR(80)
Entidad del método de pago (Ej: Banxo XXX).
Cuando exista más de un dato a informar para el campo, se deberán enviar uno tras otro utilizando un separador diferente al general del archivo. Por ej: VALOR1##VALOR2##VALOR3.
Tipo: CHAR(80)
Términos de pago (Ej: 1 pago, 3 pagos, etc).
Cuando exista más de un dato a informar para el campo, se deberán enviar uno tras otro utilizando un separador diferente al general del archivo. Por ej: VALOR1##VALOR2##VALOR3.
Tipo: CHAR(50)
Enviar valores que vinculen los datos de la cabecera (o resumen) de la orden del archivo Orders con sus productos y/o líneas.
Enviar valores que vinculen los datos de la cabecera (o resumen) de la orden del archivo Orders con sus productos y/o líneas.
Número de Línea. Número entero incremental para enumerar cada una de las líneas de la órden. Enviar de 1 a N, siendo N el número total de productos de la transacción.
Tipo: INT(11)
Cantidad.
Tipo: DECIMAL(5,2)
Código del Producto. Código del producto o SKU con el que el área de marketing pueda identificar luego al item para segmentar por comportamiento de compra de los usuarios.
Tipo: CHAR(80)
Nombre corto del Producto.
Tipo: CHAR(200)
Marca del Producto.
Tipo: CHAR(200)
Descripción del Producto.
Tipo: CHAR(200)
Precio del Producto. (Precio final unitario del producto después de descuentos). Sin Impuestos
Tipo: DECIMAL(10,2)
Precio de Lista. (Precio unitario de lista del producto. Enviar mismo valor que Price cuando no hayan descuentos ni precios diferenciales). Sin Impuestos.
Tipo: DECIMAL(10,2)
Precio de Venta. (Precio del producto antes de descuentos. Enviar mismo valor que Price cuando no hayan descuentos). Sin Impuestos.
Tipo: DECIMAL(10,2)
URL de la Imagen principal del producto. Url de la imagen principal del producto en e-commerce o hosting público. (Enviar vacío si no se dispone o no se puede obtener).
Tipo: CHAR(255)
URL del detalle del producto. Url del producto en e-commerce o hosting público. (Enviar vacío si no se dispone o no se puede obtener).
Tipo: CHAR(255)
Nombre del Vendedor del Producto.
Tipo: CHAR(100)
Código de la Tienda.
Tipo: CHAR(30)
Número de Orden.
Tipo: CHAR(50)
Número de Línea.
Tipo: INT(11)
Utilice la Combinación de Código de Tienda + Número de Orden + Número de Línea para asignar la categoría a la línea de la orden correspondiente informada en OrderDetails.
Categoría del Producto.
Texto corto de la categoría.
Tipo: CHAR(255)
Cuando un producto tenga asignada más de una categoría, se deberá enviar un registro por cada categoría con mismo StoreCode/OrderNumber/LineNumber.
Como delimitador se recomienda usar “|”.
Todos los campos de tipo DECIMAL deben incorporar el punto (“.”) como separador decimal. No utilizar separador de miles.
En los campos que No contengan información reemplazar por vacío (“”) o cero (0) según corresponda en función del tipo de dato (Vacío para CHAR, o Cero para enteros o decimales)
Respetar en los archivos el orden de los campos según el diseño enviado.
Verificar que los 4 archivos sean generados con el mismo ENCODING.
Eliminar todo tipo de caracteres especiales ajenos al alfabeto.
Los formatos serán recibidos en un repositorio SFTP. Dicho repositorio puede ser propio del cliente o en caso de requerirlo, ICOMMKT puede disponer de un espacio para este intercambio de información.
Descarga estos archivos de muestra sobre la Integración Omnicanal en el siguiente link
Consulta FAQs sobre Integración Omnicanal en nuestro centro de ayuda: ¿Es posible enviar clientes sin el dato del EMAIL en el archivo de clientes?
A partir de la generación diaria de 4 archivos, ICOMM podrá obtener las transacciones (y sus clientes) relevantes para su negocio. Mediante el procesamiento de los mismos se obtendrán más de 75 indicadores que serán recalculados en forma diaria y podrán ser utilizados en los procesos de segmentación dinámica y automation
Formatos
Se deben generar diariamente los siguientes 4 archivos de texto plano:
Customers: Este archivo tiene por objeto contener el listado de clientes (y sus atributos relevantes para el área de marketing) vinculados a las transacciones informadas en el archivo de Orders, así como de todo aquel cliente nuevo y/o actualizado a través de alguna de las fuentes de datos que maneje la organización. En este archivo, es posible incluir prospectos que aún no hayan realizado una compra. Sin embargo es requisito indispensable enviar aquellos clientes que hayan realizado compras que estén siendo informadas en el resto de los archivos.
Orders: Este archivo tiene por objeto contener el resumen de las transacciones u órdenes de compra facturadas, informando montos y cantidades totales, así como otros atributos relevantes de la operación.
OrderDetails: Este archivo tiene por objeto informar la composición de la transacción u orden de compra -> Sus productos y/o servicios con el detalle o atributos de los mismos.
OrderDetailCategories: Este archivo tiene por objeto listar toda aquella categorías que podría ser atribuíble a cada uno de los productos y/o servicios onformados en el archivo OrderDetails.
Nomenclatura de Archivos
Orders: ICOMMKT_ORDERS_[ID UNICO INSTANCIA]_YYYYMMDD
OrderDetail: ICOMMKT_ORDERSDETAIL_[ID UNICO INSTANCIA]_YYYYMMDD
OrderDetailCategories: ICOMMKT_ORDERSDETAILCATEGORIES_[ID UNICO INSTANCIA]_YYYYMMDD
Customers: ICOMMKT_CUSTOMERS_[ID UNICO INSTANCIA]_YYYYMMDD
[ID UNICO INSTANCIA] debe ser un identificador relativo a la instancia, cuando se posean múltiples marcas/países/unidades de negocio representadas en distintas instancias de nuestra plataforma.
Los archivos deben ser generados diariamente, contengan o no información. Cuando cualquiera de ellos no contenga datos, se deberá enviar el mismo únicamente con la línea de los encabezados.
Estructura de los archivos
Customers
User Id:
Es el Id del Usuario/Cliente en el sistema de origen desde donde se genera el archivo. Puede ser cualquier tipo de identificador, incluso el mismo EMAIL si los datos se originan desde un e-commerce donde el usuario no tenga atribuído ningún otro ID.
Debe coincidir luego con el informado en el archivo de órdenes para vincular al Cliente con sus transacciones.
Tipo: CHAR(50)
StoreCode
Es el Código de la tienda.
Este campo DEBE ser enviado vacío cuando la organización posea un ID único de usuario a través de todas sus tiendas, el cual haya sido unificado en su CRM, ERP o sistema de origen de los datos. Informar sólo cuando un cliente posea IDs diferentes para cada Store, donde se debe detallar el código de tienda que origina a este usuario/cliente.
Tipo: CHAR (30)
Email del cliente.
Tipo: CHAR(300)
CustomerData
Colección.
Se pueden informar tantos atributos como se deseen. Consensuar según las acciones que el área de marketing desee realizar. Cada uno de
estos atributos se transforma luego en un campo del perfil (base de datos) dentro de la plataforma
Tipo: JSON Key/Value
Formato: Key/Value en formato Json
Ejemplo: {"Key":"FIRST_NAME","Value":"Juan"},
{"Key":"LAST_NAME","Value":"Sanchez"}
Orders
Order number
Es el número de transacción u orden.
Tipo: CHAR(50)
StoreCode
Es el código de la tienda donde se originó la transacción u orden.
Tipo: CHAR(30) ()
UserId
Id del Usuario/Cliente en el sistema de origen desde donde se genera el archivo.
Tipo: CHAR(50) ()
Date
Fecha de la Orden
Tipo: DATE
Formato: dd/mm/aaaa
TotalItems
Cantidad de Ítems en la orden. Es decir, la cantidad de unidades totales de la transacción u orden, sumando las cantidades informadas de cada uno de los diferentes productos.
Tipo: DECIMAL(5,2)
TotalProducts
Cantidad de Productos (artículos diferentes) en la orden. Cantidad de productos diferentes de la transacción u orden. SKU’s o ITEM CODE diferentes, según el valor que se informe en el ITEM CODE del Archivo de Details.
Tipo: DECIMAL(5,2)
TotalAmount
Monto total y final de la orden incluyendo los impuestos.
Tipo: DECIMAL(10,2)
ItemsAmount
Monto total de los ítems de la orden (Sin impuestos)
Tipo: DECIMAL(10,2)
DiscountsAmount
Monto de los descuentos aplicados a la orden. Ya sean códigos de descuento aplicados al final de la operación u otros descuentos por cantidad.
Tipo: DECIMAL(10,2) ()
ShippingAmount
Costo de envío: Monto total del costo atribuido a los servicios de entrega de la mercadería. Enviar cero en caso de no haber entrega y ser retiro en tienda.
Tipo: DECIMAL(10,2)
TaxAmount
Sumatoria del monto total de impuestos vinculados a la orden.
Tipo: DECIMAL(10,2)
PromoCodes
Códigos de promoción aplicados.
Tipo: TEXT
PreShippingAmount
Monto Total de la Orden sin costo de envío. Debe venir un valor mayor a cero. Debería ser igual a TotalAmount menos ShippingAmount.
Tipo: DECIMAL(10,2)
DeliveryType
Tipo de Envío (Ej: Standard, Express).
Cuando exista más de un dato a informar para el campo, se deberán enviar uno tras otro utilizando un separador diferente al general del archivo. Por ej: VALOR1##VALOR2##VALOR3
Tipo: CHAR(50)
DeliverySubType
Transportista.
Cuando exista más de un dato a informar para el campo, se deberán enviar uno tras otro utilizando un separador diferente al general del archivo. Por ej: VALOR1##VALOR2##VALOR3
Tipo: CHAR(50)
DeliveryCompany
Transportista.
Cuando exista más de un dato a informar para el campo, se deberán enviar uno tras otro utilizando un separador diferente al general del archivo. Por ej: VALOR1##VALOR2##VALOR3
Tipo: CHAR(80)
PaymentMethod
Método de pago (Tarjeta, efectivo, paypal, etc.).
Cuando exista más de un dato a informar para el campo, se deberán enviar uno tras otro utilizando un separador diferente al general del archivo. Por ej: VALOR1##VALOR2##VALOR3.
Tipo: CHAR(80)
PaymentMethodDetail
Detalle del método de pago (Ej: VISA).
Cuando exista más de un dato a informar para el campo, se deberán enviar uno tras otro utilizando un separador diferente al general del archivo. Por ej: VALOR1##VALOR2##VALOR3.
Tipo: CHAR(80)
PaymentMethodEntity
Entidad del método de pago (Ej: Banxo XXX).
Cuando exista más de un dato a informar para el campo, se deberán enviar uno tras otro utilizando un separador diferente al general del archivo. Por ej: VALOR1##VALOR2##VALOR3.
Tipo: CHAR(80)
PaymentTerms
Términos de pago (Ej: 1 pago, 3 pagos, etc).
Cuando exista más de un dato a informar para el campo, se deberán enviar uno tras otro utilizando un separador diferente al general del archivo. Por ej: VALOR1##VALOR2##VALOR3.
Tipo: CHAR(50)
Order Details
StoreCode
Enviar valores que vinculen los datos de la cabecera (o resumen) de la orden del archivo Orders con sus productos y/o líneas.
OrderNumber
Enviar valores que vinculen los datos de la cabecera (o resumen) de la orden del archivo Orders con sus productos y/o líneas.
LineNumber
Número de Línea. Número entero incremental para enumerar cada una de las líneas de la órden. Enviar de 1 a N, siendo N el número total de productos de la transacción.
Tipo: INT(11)
Quantity
Cantidad.
Tipo: DECIMAL(5,2)
ItemCode
Código del Producto. Código del producto o SKU con el que el área de marketing pueda identificar luego al item para segmentar por comportamiento de compra de los usuarios.
Tipo: CHAR(80)
ItemName
Nombre corto del Producto.
Tipo: CHAR(200)
Brand
Marca del Producto.
Tipo: CHAR(200)
Description
Descripción del Producto.
Tipo: CHAR(200)
Price
Precio del Producto. (Precio final unitario del producto después de descuentos). Sin Impuestos
Tipo: DECIMAL(10,2)
ListPrice
Precio de Lista. (Precio unitario de lista del producto. Enviar mismo valor que Price cuando no hayan descuentos ni precios diferenciales). Sin Impuestos.
Tipo: DECIMAL(10,2)
SellingPrice
Precio de Venta. (Precio del producto antes de descuentos. Enviar mismo valor que Price cuando no hayan descuentos). Sin Impuestos.
Tipo: DECIMAL(10,2)
ImageUrl
URL de la Imagen principal del producto. Url de la imagen principal del producto en e-commerce o hosting público. (Enviar vacío si no se dispone o no se puede obtener).
Tipo: CHAR(255)
DetailUrl
URL del detalle del producto. Url del producto en e-commerce o hosting público. (Enviar vacío si no se dispone o no se puede obtener).
Tipo: CHAR(255)
Seller
Nombre del Vendedor del Producto.
Tipo: CHAR(100)
Order Details Categories
StoreCode
Código de la Tienda.
Tipo: CHAR(30)
OrderNumber
Número de Orden.
Tipo: CHAR(50)
LineNumber
Número de Línea.
Tipo: INT(11)
Utilice la Combinación de Código de Tienda + Número de Orden + Número de Línea para asignar la categoría a la línea de la orden correspondiente informada en OrderDetails.
Category
Categoría del Producto.
Texto corto de la categoría.
Tipo: CHAR(255)
Cuando un producto tenga asignada más de una categoría, se deberá enviar un registro por cada categoría con mismo StoreCode/OrderNumber/LineNumber.
Nota General:
Como delimitador se recomienda usar “|”.
Todos los campos de tipo DECIMAL deben incorporar el punto (“.”) como separador decimal. No utilizar separador de miles.
En los campos que No contengan información reemplazar por vacío (“”) o cero (0) según corresponda en función del tipo de dato (Vacío para CHAR, o Cero para enteros o decimales)
Respetar en los archivos el orden de los campos según el diseño enviado.
Verificar que los 4 archivos sean generados con el mismo ENCODING.
Eliminar todo tipo de caracteres especiales ajenos al alfabeto.
Transferencia
Los formatos serán recibidos en un repositorio SFTP. Dicho repositorio puede ser propio del cliente o en caso de requerirlo, ICOMMKT puede disponer de un espacio para este intercambio de información.
Archivos de muestra
Descarga estos archivos de muestra sobre la Integración Omnicanal en el siguiente link
Consulta FAQs sobre Integración Omnicanal en nuestro centro de ayuda: ¿Es posible enviar clientes sin el dato del EMAIL en el archivo de clientes?
Actualizado el: 26/09/2023
¡Gracias!