Modelos de datos

Descripción de los objetos correspondientes a los modelos de datos de cada entidad manejada en esta documentación.

Orden

Clave	Tipo	Descripción
⚠️ numeroOrden	Numeric	Número de la orden. OBSOLETO. Utilizar idOrden.
idOrden	String(32)	Identificador de la orden en Fenicio.
idOrdenOrigen	String(32) | null	Identificador de la orden en su origen, en caso de haber sido generada en un origen externo a Fenicio (por ejemplo un marketplace).
referencia	String(32) | null	Identificador único de referencia con el cual se registró la orden en el sistema del comercio.
estado	EstadoOrden	Estado de la orden en Fenicio.
motivoCancelacion	String(255) | null	Texto descriptivo del motivo de la cancelación.
origen	String	Origen de la orden. Posibles valores: MERCADOLIBRE, CALLCENTER, WEB.
fechaInicio	DateTime	Fecha de iniciada la orden.
fechaAbandono	DateTime | null	Fecha de abandono de la orden.
fechaRecuperada	DateTime | null	Fecha de recuperación de la orden.
fechaFin	DateTime | null	Fecha de finalizada la orden.
fechaCancelada	DateTime | null	Fecha de cancelación de la orden.
comprador	Usuario	Datos del comprador.
direccionFacturacion	Direccion | null	Dirección de facturación de la orden.
codigoTributario	String(32) | null	Número de registro tributario de la empresa.
razonSocial	String(64) | null	Nombre legal de la empresa.
moneda	String(4)	Código ISO 4217 de la moneda. Ejemplo: UYU
pago	Pago | null	Datos del pago realizado para la orden.
entrega	OrdenEntrega | null	Datos de como se entregará la orden realizada.
lineas	List<OrdenLinea>	Datos de todos las líneas que contiene la orden.
impuestos	Numeric	Importe de los impuestos aplicados.
importeTotal	Numeric	Importe total de la orden.
observaciones	String (255) | null	Observaciones generales de la orden.
historialCallCenter	List<EventoCallCenter>	Listado de eventos de call center.
linkCarrito	Link	Link para recuperar carrito abandonado.

OrdenEntrega

Clave	Tipo	Descripción
tipo	String	Tipo de entrega para la orden. Posibles valores: RETIRO, ENVIO.
estado	EstadoEntrega | null	Estado de la entrega de la orden.
horario	FranjaEntrega | null	Franja de horario en el que se entrega la orden.
destinatario	String(255) | null	Persona que recibirá la orden.
direccionEnvio	Direccion | null	Para envíos a domicilio, indica la dirección de entrega.
local	String(16) | null	Para retiro en local, código del local de entrega.
servicioEntrega	ServicioEntrega | null	Datos del servicio encargado de la entrega de la orden.
codigoTracking	String(32) | null	Código asignado por el servicio encargado de la entrega para pedido.
etiqueta	String(255) | null	URL del archivo de la etiqueta para adjuntar al pedido generada por el servicio encargado de la entrega.

Usuario

Clave	Tipo	Descripción
id	int(32)	Identificador del comprador en Fenicio.
codigo	String(16) | null	Código del usuario.
email	String(255)	Email del usuario.
nombre	String(255)	Nombre del usuario.
apellido	String(255) | null	Apellido del usuario.
telefono	String(255)	Teléfono del usuario en formato +[CODIGOPAIS][NUMERO]. Ejemplo: [phone]
genero	String | null	Género del usuario. Valores posibles: M, F.
documento	Documento | null	Datos del documento del usuario.
extras	Object | null	Clave / Valor de datos extras referidos al usuario. Estos datos extras son configurables por comercio.

Documento

Clave	Tipo	Descripción
numero	String(32)	Número de documento.
pais	String(2)	Código ISO 3166-1 del país.
tipo	String	Tipo de documento. Valores posibles: PASAPORTE, DOCUMENTO_IDENTIDAD.

ServicioEntrega

Clave	Tipo	Descripción
id	Int(32)	Identificador del servicio de entrega en Fenicio.
codigo	String(64) | null	Código del servicio de entrega.
nombre	String(64)	Nombre del servicio de entrega.

Direccion

Clave	Tipo	Descripción
latitud	Numeric | null	Latitud.
longitud	Numeric | null	Longitud.
pais	String(64)	Nombre del País.
estado	String(255)	Nombre del estado, provincia o departamento.
localidad	String(255)	Nombre de la localidad.
calle	String(255)	Nombre de la calle.
numeroPuerta	String(16)	Número de puerta.
numeroApto	String(16) | null	Número de apartamento.
codigoPostal	String (16) | null	Código postal de la dirección.
observaciones	String(255) | null	Observaciones extra de la dirección.

Pago

Clave	Tipo	Descripción
id	Int(32)	Identificador del pago en Fenicio.
idExterno	String(255) | null	Identificador externo del medio de pago con el que se realizó.
codigo	String(32)	Código del medio de pago. Posibles valores: ver Medios de pago.
conector	String(32)	Tipo de conector utilizado para realizar el pago. Posibles valores: ver Integradores de pago.
estado	String(16)	Estado del pago en Fenicio. Posibles valores: PENDIENTE, APROBADO, ERROR, CANCELADO, REVERSADO.
fechaVencimiento	DateTime | null	Fecha de vencimiento del pago.
fechaPago	DateTime | null	Fecha de confirmación de pago.
fechaCancelacion	DateTime | null	Fecha de cancelación del pago.
cuotas	Int(2)	Cantidad de cuotas en la que se realizó el pago.
importe	Numeric	Importe total del pago.
moneda	String(4)	Código ISO 4217 de la moneda. Ejemplo: UYU.
bin	String(6) | null	Primeros 6 dígitos de la tarjeta de pago.
autorizacion	String(128) | null	Código de autorización enviado por el medio de pago.
numeroTarjeta	String(128) | null	Número de tarjeta de pago (enmascarado).
terminacionTarjeta	String(4) | null	Últimos 4 dígitos de la tarjeta de pago.

OrdenLinea

Clave	Tipo	Descripción
nombre	String(255)	Nombre del artículo.
sku	String(128)	Código único que identifica al artículo en el sistema externo.
codigoPrecio	String(16)	Código que corresponde al tipo de precio del artículo. Si el artículo corresponde a precios alternativos, se devolverá el código con el que ingresó, de lo contrario por defecto es un valor 1.
cantidad	Int(4)	Cantidad de unidades compradas.
cantidadRegalo	Int(4)	Cantidad de unidades para regalo.
precio	Numeric	Precio unitario de la línea.
descuentos	List<OrdenDescuento> | null	Lista de descuentos aplicados a cada unidad de la línea.
atributos	Object | null	Objeto con Claves /Valores con los atributos relevantes del artículo.

OrdenDescuento

Clave	Tipo	Descripción
nombre	String(32)	Nombre del descuento.
codigo	String(128)	Código del descuento.
origen	String	Origen del descuento, posibles valores: CUPON, PRODUCTO, MEDIO_DE_PAGO, PROMOCION.
monto	Numeric	Monto del descuento.

EventoCallCenter

Clave	Tipo	Descripción
evento	String	Evento de call center. Los posibles valores son: CREAR, ENVIAR, FINALIZAR.
fecha	DateTime	Fecha del evento.
operador	OperadorCallCenter	Datos del operador asociado al evento.

OperadorCallCenter

Clave	Tipo	Descripción
nombre	String(255)	Nombre del operador.
apellido	String(255)	Apellido del operador.
email	String(255)	Email del operador.

FranjaEntrega

Clave	Tipo	Descripción
desde	DateTime	Fecha y hora de inicio de la franja de entrega.
hasta	DateTime	Fecha y hora de fin de la franja de entrega.

Nota: las franjas de entrega deben comenzar y terminar dentro del mismo día calendario.

Order

Clave	Tipo	Descripción
id	String	Identificador de la orden.
currency	String	Moneda de la orden en formato ISO 4217.
customer	<Customer>	Información del comprador.
deliveryInformation	<DeliveryInformation>	Información sobre la entrega de la orden.
items	List<Item>	Detalle de los productos que contiene la orden.
packages	List<Package>	Detalle de los paquetes.

Customer

Clave	Tipo	Descripción
name	String	Nombre del comprador.
lastName	String	Apellido del comprador.
document	<Document>	Datos del documento del comprador.
email	String	Correo electrónico del comprador.
phone	String	Teléfono en formato +[CODIGOPAIS] [NUMERO].

Document

Clave	Tipo	Descripción
number	String	Número de documento.
country	String	Código ISO 3166-1 del país.
type	Enum	Tipo de documento. Valores posibles.

Valores posibles para el tipo de documento

Valor	Descripción
CI_UY	Cédula de Identidad (Uruguay).
RUN_CL	Rol Único Nacional (Chile).
CC_CO	Cédula de Ciudadanía (Colombia).
CE_CO	Cédula de Extranjería (Colombia).
CIC_PY	Cédula de Identidad Civil (Paraguay).
CIE_DO	Cédula de Identidad y Electoral (República Dominicana).
PASAPORTE	Pasaporte.

Delivery Information

Clave	Tipo	Descripción
recipientName	String	Nombre de la persona que recibirá la orden.
fromAddress	<Address>	Datos de la dirección de retiro.
toAddress	<Address>	Datos de la dirección de envío.
deliveryDate	<DeliveryDate> | null	Franja horaria de entrega del envío. Este dato es opcional y se puede incluir o no dependiendo del Service Type enviado. Este campo solo se envía en el servicio Create Shipping.

Address

Clave	Tipo	Descripción
country	String	Nombre del País.
region	String	Nombre del departamento.
locality	String	Nombre de la localidad.
street	String	Nombre de la calle.
doorNumber	String	Número de puerta.
apartmentNumber	String | null	Número de apartamento..
postcode	String | null	Código postal de la dirección.
latitude	Float | null	Latitud. Si se requiere puede ser un dato obligatorio.
longitude	Float | null	Longitud. Si se requiere puede ser un dato obligatorio.
additionalInformation	String | null	Información extra sobre la dirección.

Delivery Date

Clave	Tipo	Descripción
from	DateTime	Fecha y hora comienzo de la franja de entrega.
to	DateTime	Fecha y hora fin de la franja de entrega.

Item

Clave	Tipo	Descripción
id	String	Identificador del ítem.
name	String | null	Nombre del ítem.
quantity	Int	Cantidad de unidades compradas.
price	Float | null	Precio unitario de ítem.
weight	Float | null	Peso del ítem en gramos.
length	Float | null	Largo del ítem en centímetros.
width	Float | null	Ancho del ítem en centímetros.
height	Float | null	Alto del ítem en centímetros.

Package

Clave	Tipo	Descripción
code	Enum	Código del tipo de paquete. Valores a definir por empresa logística.
quantity	Int	Cantidad del paquete.

Alertas

Clave	Tipo	Descripción
id	String(32)	Identificador de la orden en Fenicio.
resuelta	Bool	Estado de la alerta.
resueltaInfo	String	Información del estado de la alerta.
asunto	String	Asunto general de la alerta.
desc	String	Descripción detallada de la alerta.
tipo	String	Tipo de alerta.
ico	String	Tipo de clase CSS.
totalIncidencias	Integrar	Cantidad de incidencias en la alerta.
tiempo	String	Máximo de tiempo.
fechas	DateTime | null	Fecha de inicio y fin del incidentes resueltos.
_link	String	Link con redirección a la alerta
adm	String	Link con redirección al administrador en alertas

Sucursales

Clave	Tipo	Descripción
id	String(32)	Identificador de la orden en Fenicio.
hab	Boolean	Sucursal habilitada.
nom	String	Nombre de sucursal.
email	String	Correo electrónico de sucursal.
cod	String	Código de sucursal.
pais	String	Nombre del País.
dpto	String	Nombre del departamento.
dir	String	Dirección de sucursal.
hor	String	Horario de sucursal.
tel	String	Teléfono de sucursal.
pickUp	Boolean	Definido como PickUp.
lat	Float | null	Latitud.
long	Float | null	Longitud.
localidad	String	Nombre de la localidad.
pagoContraEntrega	Boolean	Acepta pago contra entrega.
publico	Boolean	Permite atención al público.
esStorePickUp	Boolean	Deinido como PickUp.

Tipos-envío

Clave	Tipo	Descripción
id	String(32)	Identificador de la orden en Fenicio.
hab	Boolean	Estado de habilitación del tipo de envío.
nom	String	Nombre del integrador.
integrador	Array	Nombre del integrador y ID.

Ventas

Clave	Tipo	Descripción
id	Int	Identificador de la orden en Fenicio.
v	String	Representa el número de versión de la plataforma.
cod	String	Código total de la venta
cv	String	Identificador único de la venta.
url	String	URL del detalle de la venta
fecha	DateTime	Fecha de la venta.
pendienteRegistrar	Boolean	Estado del proceso de pago pendiente de confirmación
obs	String	Observaciones
fechas	DateTime | null	Muestra las fechas en los distintos estados de la venta.
moneda	String(4)	Código ISO 4217 de la moneda. Ejemplo: UYU
importes	Numeric	Detalle del importe de la venta.
estado	Boolean	Estado de la entrega.
entrega	String	Método de entrega de la venta.
cliente	String	Datos completos del cliente.
pago	String	Detalle del pago de la venta.
ítems	String	Detalle de los ítems en la venta.
promos	String	Detalle de las promos aplicadas a la venta.
cupones	String	Detalle de los cupones aplicadas a la venta.
_link	String	URL de la venta.

Catálogo

Clave	Tipo	Descripción
cod	String	Código de la venta.
nom	String	Nombre completo del producto.
moneda	String(4)	Código ISO 4217 de la moneda. Ejemplo: UYU.
categ	Object	ID y nombre completo de la categoría.
marca	Object	ID y nombre completo de la marca.
caracts	String	Contiene las características activas del producto con valores asignados. Las claves corresponden al nombre interno de cada característica.
vars	Array	Contiene las variantes del producto, incluyendo su código, nombre, y los enlaces a imágenes en tamaño completo y miniatura.
pres	Array de objetos	Contiene las presentaciones del producto, incluyendo el SKU, código interno, nombre, stock disponible y precios (normal, promocional y de lista), todos organizados por moneda. También incluye identificadores opcionales.
caracts	Object	Contiene información sobre las promociones y el estado de los precios del producto, incluyendo detalles como la promoción activa y si tiene o no un nuevo precio.