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 |
---|---|---|
⚠️ | Numeric | Número de la orden.
OBSOLETO. Utilizar |
| String(32) | Identificador de la orden en Fenicio. |
| 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). |
| String(32) | null | Identificador único de referencia con el cual se registró la orden en el sistema del comercio. |
| Estado de la orden en Fenicio. | |
| String(255) | null | Texto descriptivo del motivo de la cancelación. |
| String | Origen de la orden. Posibles valores: |
| Fecha de iniciada la orden. | |
| DateTime | null | Fecha de abandono de la orden. |
| DateTime | null | Fecha de recuperación de la orden. |
| DateTime | null | Fecha de finalizada la orden. |
| DateTime | null | Fecha de cancelación de la orden. |
| Datos del comprador. | |
| Direccion | null | Dirección de facturación de la orden. |
| String(32) | null | Número de registro tributario de la empresa. |
| String(64) | null | Nombre legal de la empresa. |
| String(4) | Código ISO 4217 de la moneda. Ejemplo: UYU |
| Pago | null | Datos del pago realizado para la orden. |
| OrdenEntrega | null | Datos de como se entregará la orden realizada. |
| List<OrdenLinea> | Datos de todos las líneas que contiene la orden. |
| Numeric | Importe de los impuestos aplicados. |
| Numeric | Importe total de la orden. |
| String (255) | null | Observaciones generales de la orden. |
| List<EventoCallCenter> | Listado de eventos de call center. |
OrdenEntrega
Clave | Tipo | Descripción |
---|---|---|
| String | Tipo de entrega para la orden. Posibles valores: |
| EstadoEntrega | null | Estado de la entrega de la orden. |
| FranjaEntrega | null | Franja de horario en el que se entrega la orden. |
| String(255) | null | Persona que recibirá la orden. |
| Direccion | null | Para envíos a domicilio, indica la dirección de entrega. |
| String(16) | null | Para retiro en local, código del local de entrega. |
| ServicioEntrega | null | Datos del servicio encargado de la entrega de la orden. |
| String(32) | null | Código asignado por el servicio encargado de la entrega para pedido. |
| 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 |
---|---|---|
| int(32) | Identificador del comprador en Fenicio. |
| String(16) | null | Código del usuario. |
| String(255) | Email del usuario. |
| String(255) | Nombre del usuario. |
| String(255) | null | Apellido del usuario. |
| String(255) | Teléfono del usuario en formato |
| String | null | Género del usuario. Valores posibles: |
| Documento | null | Datos del documento del usuario. |
| Object | null | Clave / Valor de datos extras referidos al usuario. Estos datos extras son configurables por comercio. |
Documento
Clave | Tipo | Descripción |
---|---|---|
| String(32) | Número de documento. |
| String(2) | Código ISO 3166-1 del país. |
| String | Tipo de documento. Valores posibles: |
ServicioEntrega
Clave | Tipo | Descripción |
---|---|---|
| Int(32) | Identificador del servicio de entrega en Fenicio. |
| String(64) | null | Código del servicio de entrega. |
| String(64) | Nombre del servicio de entrega. |
Direccion
Clave | Tipo | Descripción |
---|---|---|
| Numeric | null | Latitud. |
| Numeric | null | Longitud. |
| String(64) | Nombre del País. |
| String(255) | Nombre del estado, provincia o departamento. |
| String(255) | Nombre de la localidad. |
| String(255) | Nombre de la calle. |
| String(16) | Número de puerta. |
| String(16) | null | Número de apartamento. |
| String (16) | null | Código postal de la dirección. |
| String(255) | null | Observaciones extra de la dirección. |
Pago
Clave | Tipo | Descripción |
---|---|---|
| Int(32) | Identificador del pago en Fenicio. |
| String(255) | null | Identificador externo del medio de pago con el que se realizó. |
| String(32) | Código del medio de pago. Posibles valores: ver Medios de pago. |
| String(32) | Tipo de conector utilizado para realizar el pago. Posibles valores: ver Integradores de pago. |
| String(16) | Estado del pago en Fenicio. Posibles valores: |
| DateTime | null | Fecha de vencimiento del pago. |
| DateTime | null | Fecha de confirmación de pago. |
| DateTime | null | Fecha de cancelación del pago. |
| Int(2) | Cantidad de cuotas en la que se realizó el pago. |
| Numeric | Importe total del pago. |
| String(4) | Código ISO 4217 de la moneda. Ejemplo: |
| String(6) | null | Primeros 6 dígitos de la tarjeta de pago. |
| String(128) | null | Código de autorización enviado por el medio de pago. |
| String(128) | null | Número de tarjeta de pago (enmascarado). |
| String(4) | null | Últimos 4 dígitos de la tarjeta de pago. |
OrdenLinea
Clave | Tipo | Descripción |
---|---|---|
| String(255) | Nombre del artículo. |
| String(128) | Código único que identifica al artículo en el sistema externo. |
| 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 |
| Int(4) | Cantidad de unidades compradas. |
| Int(4) | Cantidad de unidades para regalo. |
| Numeric | Precio unitario de la línea. |
| List<OrdenDescuento> | null | Lista de descuentos aplicados a cada unidad de la línea. |
| Object | null | Objeto con Claves / Valores con los atributos relevantes del artículo. |
OrdenDescuento
Clave | Tipo | Descripción |
---|---|---|
| String(32) | Nombre del descuento. |
| String(128) | Código del descuento. |
| String | Origen del descuento, posibles valores: |
| Numeric | Monto del descuento. |
EventoCallCenter
Clave | Tipo | Descripción |
---|---|---|
| String | Evento de call center. Los posibles valores son: |
| Fecha del evento. | |
| Datos del operador asociado al evento. |
OperadorCallCenter
Clave | Tipo | Descripción |
---|---|---|
| String(255) | Nombre del operador. |
| String(255) | Apellido del operador. |
| String(255) | Email del operador. |
FranjaEntrega
Clave | Tipo | Descripción |
---|---|---|
| Fecha y hora de inicio de la franja de entrega. | |
| 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 |
---|---|---|
| String | Identificador de la orden. |
| String | Moneda de la orden en formato ISO 4217. |
| <Customer> | Información del comprador. |
| Información sobre la entrega de la orden. | |
| List<Item> | Detalle de los productos que contiene la orden. |
| List<Package> | Detalle de los paquetes. |
Customer
Clave | Tipo | Descripción |
---|---|---|
| String | Nombre del comprador. |
| String | Apellido del comprador. |
| <Document> | Datos del documento del comprador. |
| String | Correo electrónico del comprador. |
| String | Teléfono en formato |
Document
Clave | Tipo | Descripción |
---|---|---|
| String | Número de documento. |
| String | Código ISO 3166-1 del país. |
| Enum | Tipo de documento. Valores posibles. |
Valores posibles para el tipo de documento
Valor | Descripción |
---|---|
| Cédula de Identidad (Uruguay). |
| Rol Único Nacional (Chile). |
| Cédula de Ciudadanía (Colombia). |
| Cédula de Extranjería (Colombia). |
| Cédula de Identidad Civil (Paraguay). |
| Cédula de Identidad y Electoral (República Dominicana). |
| Pasaporte. |
Delivery Information
Clave | Tipo | Descripción |
---|---|---|
| String | Nombre de la persona que recibirá la orden. |
| <Address> | Datos de la dirección de retiro. |
| <Address> | Datos de la dirección de envío. |
| <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 |
---|---|---|
| String | Nombre del País. |
| String | Nombre del departamento. |
| String | Nombre de la localidad. |
| String | Nombre de la calle. |
| String | Número de puerta. |
| String | null | Número de apartamento.. |
| String | null | Código postal de la dirección. |
| Float | null | Latitud. Si se requiere puede ser un dato obligatorio. |
| Float | null | Longitud. Si se requiere puede ser un dato obligatorio. |
| String | null | Información extra sobre la dirección. |
Delivery Date
Clave | Tipo | Descripción |
---|---|---|
| Fecha y hora comienzo de la franja de entrega. | |
| Fecha y hora fin de la franja de entrega. |
Item
Clave | Tipo | Descripción |
---|---|---|
| String | Identificador del ítem. |
| String | null | Nombre del ítem. |
| Int | Cantidad de unidades compradas. |
| Float | null | Precio unitario de ítem. |
| Float | null | Peso del ítem en gramos. |
| Float | null | Largo del ítem en centímetros. |
| Float | null | Ancho del ítem en centímetros. |
| Float | null | Alto del ítem en centímetros. |
Package
Clave | Tipo | Descripción |
---|---|---|
| Enum | Código del tipo de paquete. Valores a definir por empresa logística. |
| Int | Cantidad del paquete. |
Alertas
Clave | Tipo | Descripción |
---|---|---|
| String(32) | Identificador de la orden en Fenicio |
| Bool | Estado de la alerta |
| String | Información del estado de la alerta |
| String | Asunto general de la alerta |
| String | Descripción detallada de la alerta |
| String | Tipo de alerta |
| String | Tipo de clase CSS |
| Integrar | Cantidad de incidencias en la alerta |
| String | Máximo de tiempo |
| DateTime | null | Fecha de inicio y fin del incidentes resueltos |
| String | |
|
Sucursales
Clave | Tipo | Descripción |
---|---|---|
| String(32) | Identificador de la orden en Fenicio |
| ||
| String | Nombre de sucursal. |
| String | Correo electrónico de sucursal. |
| String | Código de sucursal. |
| String | Nombre del País. |
| String | Nombre del departamento. |
| String | Dirección de sucursal. |
| String | Horario de sucursal. |
| String | Teléfono de sucursal. |
| ||
| Float | null | Latitud. |
| Float | null | Longitud. |
| String | Nombre de la localidad. |
| ||
| ||
|
Tipos-envío
Clave | Tipo | Descripción |
---|---|---|
| String(32) | Identificador de la orden en Fenicio |
| Bool | Estado de habilitación del tipo de envío |
| String | Nombre del integrador |
| array | Nombre del integrador y ID. |
Ventas
Clave | Tipo | Descripción |
---|---|---|
| String(32) | Identificador de la orden en Fenicio |
| ||
| ||
| ||
| URL de la venta | |
| Fecha de la venta | |
| ||
obs | ||
| DateTime | null | Fecha de la venta con el Estado de la Venta |
| Código ISO 4217 de la moneda. Ejemplo: UYU | |
| Detalle del importe de la venta | |
| Estado de la entrega | |
| Método de entrega de la venta | |
| Datos completos del cliente | |
|
Última actualización