API V1

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

Orden

Clave	Tipo	Descripción
id	String(32)	Identificador de la orden en Fenicio.
moneda	String(4)	Código ISO 4217 de la moneda. Ejemplo: UYU
codigoTributario	String(32) | null	Número de registro tributario de la empresa.
razonSocial	String(64) | null	Nombre legal de la empresa.
comprador	Comprador	Datos del comprador.
items	Item	Lista de ítems de la orden.
pago	Pago | null	Datos del pago realizado para la orden.
entrega	TipoEntrega | null	Tipo de entrega para la orden. Posibles valores: RETIRO, ENVIO.
direccionFacturacion	Direccion | null	Dirección de facturación de la orden.
observaciones	String (255) | null	Observaciones generales de la orden.

Comprador

Clave	Tipo	Descripción
nombre	String(255)	Nombre del comprador.
apellido	String(255) | null	Apellido del comprador.
documento	Documento | null	Datos del documento del comprador.
email	String(255)	Email del comprador.
telefono	String(255)	Teléfono del comprador en formato +[CODIGOPAIS][NUMERO]. Ejemplo: [phone]

Documento

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

Item

Clave	Tipo	Descripción
sku	String(128)	Código único que identifica al artículo en el sistema externo.
nombre	String(255)	Nombre del artículo.
cantidad	Int(4)	Cantidad de unidades compradas.
cantidadRegalo	Int	Cantidad de ítems que seleccionaron para regalo.
importe	Numeric	Precio unitario de la línea.

Pago

Clave	Tipo	Descripción
id	Int(32)	Identificador del pago en Fenicio.
metodo	String(32)	Método de pago utilizado.
importe	Numeric	Importe total del pago.
cuotas	Int(2)	Cantidad de cuotas en la que se realizó el pago.
moneda	String(4)	Código ISO 4217 de la moneda. Ejemplo: UYU.
autorizacion	String(128) | null	Código de autorización enviado por el medio de pago.

Entrega

Clave	Tipo	Descripción
idTipoEnvio	String(255) | null	Identificador del tipo de envío.
destinatario	FranjaHoraria | null	Persona que recibirá la orden.
franjaHoraria	Direccion | null	Servicio de entrega.
costo	Numeric	Costo de la entrega.
direccion	Direccion | null	Dirección de entrega.

Retiro

Clave	Tipo	Descripción
retira	String | null	Nombre de la persona que retira el pedido.
codigoSucursal	String | null	Código de la sucursal donde se retira el pedido.

FranjaHoraria

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.

Direccion

Clave	Tipo	Descripción
idLocalidad	Int	Identificador de la localidad.
calle	String(255)	Nombre de la calle.
nroPuerta	String(16)	Número de puerta.
nroApartamento	String(5) | null	Número de apartamento.
codigoPostal	String(16) | null	Código postal de la dirección.
latitud	Numeric | null	Latitud.
longitud	Numeric | null	Longitud.
observaciones	String(255) | null	Observaciones extra de la dirección.

Catalogo

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	Categoria	ID y nombre completo de la categoría.
marca	Marca	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	VarianteProducto	Contiene las variantes del producto, incluyendo su código, nombre, y los enlaces a imágenes en tamaño completo y miniatura.

Categoria

Clave	Tipo	Descripción
id	number	Identificador de la categoría.
nom	string	Nombre de la categoría.

Marca

Clave	Tipo	Descripción
id	number	Identificador de la marca.
nom	string	Nombre de la marca.

VarianteProducto

Clave	Tipo	Descripción
cod	number	Código de la variante.
nom	string	Nombre de la variante.
desc	string	Descripción de la variante.
imgs	string	URLs de imágenes.
thumbs	string	URLs de thumbnails.
pres	PresentacionProducto	Presentaciones disponibles.
caracts	object	Características específicas de la variante.

PresentacionProducto

Clave	Tipo	Descripción
sku	string	Código de la variante.
sku_fn	string	SKU interno Fenicio.
stock	string	Stock disponible.
pr_normal	Precio	Precio normal.
pr_promo	Precio	Precio promocional.
pr_lista	Precio	Precio de lista.
identificadores	string	Identificadores adicionales.
sku_cm	string
cod	string
nom	string

Precio

Clave	Tipo	Descripción
UYU	number	Precio en pesos uruguayos.
USD	number	Precio en dólares.

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-envio

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.