Integraciones

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,PEDIDO.
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	Comprador	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>	Líneas de productos asociadas a la orden.
impuestos	Numeric	Monto total de impuestos de la orden.
importeTotal	Numeric	Importe total final de la orden.
observaciones	String (255) | null	Observaciones adicionales de la orden.
historialCallCenter	List<EventoCallCenter>	Historial de acciones realizadas desde call center.
_idSolicitud	string	Identificador interno de la solicitud.

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.
skuFenicio	String(128)	Código único que identifica al artículo en Fenicio.
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 por unidad.

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.

Comprador

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.

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(5) | 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.

Entrega

Clave	Tipo	Descripción
tipo	TipoEntrega | null	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	Dirección de entrega.
local	object | null	Información del local asociado.
servicioEntrega	ServicioEntrega | null	Servicio de entrega.
codigoTracking	String(128) | null	Código de seguimiento.
etiqueta	String(255) | null	URL del archivo de la etiqueta para adjuntar al pedido generada por el servicio encargado de la entrega.

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.

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.

OrdenLinea

Clave	Tipo	Descripción
nombre	String(255)	Nombre descriptivo del artículo en la línea de la orden.
sku	String(128)	Código único del artículo en el sistema externo o del comercio.
cantidad	Int(4)	Cantidad de unidades compradas.
cantidadRegalo	Int(4)	Cantidad de unidades para regalo.
codigoPrecio	String(16)	Código del tipo de precio aplicado al artículo. Por defecto: 1.
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 descriptivo del descuento.
codigo	String(128)	Código identificador del descuento.
origen	OrigenDescuento	Origen del descuento.
monto	Numeric	Monto del descuento aplicado a la unidad del artículo.