Los comodatos son los equipos que entregas a tus comercios para que los usen, manteniendo tú la propiedad del equipo.
¿Qué se informa como comodato? Cada registro representa un equipo entregado a un comercio bajo un contrato de comodato — por ejemplo un congelador, un refrigerador o un exhibidor instalado en el punto de venta.
Un Comodato contiene la identificación del equipo, el Comercio donde está instalado, la vigencia del contrato y el Vendedor responsable. Con esta información YOM puede mostrar el parque de equipos instalado en cada comercio y dar contexto a las solicitudes de equipos nuevos.
El endpoint de Comodatos le permite a YOM acceder a información detallada sobre cada equipo entregado en comodato.
GET /api/comodatos
La siguiente tabla define el modelo base de integración de la entidad Comodato. Este modelo corresponde al contrato base y es extensible: puede complementarse con atributos adicionales a través del objeto otherProperties, según se describe en la sección Atributos adicionales.
| Campo | Tipo | Carácter | Descripción | Ejemplos |
|---|---|---|---|---|
comodatoId |
📝 Texto | 🟢 Requerido | Identificador único del Comodato. | |
| *\Debe ser estable en el tiempo: es la llave con la que YOM identifica el registro en cada actualización. | “COM-00123” |
|||
commerceId |
📝 Texto → Comercios | 🟢 Requerido | Id del Comercio donde está instalado el equipo. | |
| *\Debe ser el mismo identificador informado en el endpoint de Comercios. | “12345” |
|||
equipmentType |
📝 Texto | 🟢 Requerido | Tipo de equipo entregado. | “Congelador 400L” |
equipmentCode |
📝 Texto | ⚪ Opcional | Código del modelo o artículo del equipo. | “CONG-400” |
brand |
📝 Texto | ⚪ Opcional | Marca del equipo. | “Electrolux” |
serialNumber |
📝 Texto | ⚪ Opcional | Número de serie de la unidad física entregada. | “SN-8891233” |
quantity |
🔢 Número | ⚪ Opcional | Cantidad de equipos del mismo tipo cubiertos por el registro. | |
*\*Si no se informa, se asume *1. Cuando el equipo tiene número de serie, se recomienda un registro por unidad. |
1 |
|||
contractNumber |
📝 Texto | ⚪ Opcional | Número del contrato de comodato firmado con el Comercio. | “CT-2026-0891” |
startDate |
📅 Fecha | 🟢 Requerido | Fecha de inicio del comodato, es decir de entrega o instalación del equipo. | |
| *\La fecha debe estar en formato ISO 8601. | “2026-03-15” |
|||
“2026-03-15T00:00:00.000Z” |
||||
endDate |
📅 Fecha | ⚪ Opcional | Fecha de término del contrato, cuando tiene plazo definido. | |
| *\La fecha debe estar en formato ISO 8601. | “2027-03-15” |
|||
withdrawalDate |
📅 Fecha | ⚪ Opcional | Fecha de retiro efectivo del equipo del Comercio. | |
| *\La fecha debe estar en formato ISO 8601. | “2026-11-02” |
|||
isInactive |
🔘 Bool | 🟢 Requerido | ¿Está terminado el comodato? | |
*\*Un equipo retirado o un contrato finalizado se informa con *true, manteniendo el registro histórico. |
true |
|||
false |
||||
status |
📝 Texto | ⚪ Opcional | Estado del comodato tal como lo nombra tu sistema. | |
*\*Es informativo y complementa a *isInactive, no lo reemplaza. |
“Vigente” |
|||
“Retirado” |
||||
sellerId |
📝 Texto → Vendedores | ⚪ Opcional | Id del Vendedor responsable del equipo. | “1234” |
otherProperties |
📝 Objeto | ⚪ Opcional | Objeto clave-valor con atributos adicionales del Comodato. Ver sección Atributos adicionales. | {"maintenanceFrequency": "Semestral", "assetOwner": "Planta Norte"} |
otherProperties)El modelo documentado en esta página corresponde al contrato base de la entidad Comodato. Además de los campos base, los clientes pueden disponibilizar atributos adicionales para identificación, clasificación, mantenimiento o análisis, a través del objeto otherProperties.
Algunos ejemplos de atributos adicionales son: frecuencia de mantenimiento, planta o bodega propietaria del activo, valor libro del equipo, capacidad en litros o responsable interno del contrato.
Los atributos dentro de otherProperties deben cumplir las siguientes condiciones:
equipmentType, serialNumber o status).YOM podrá conservar estos atributos como información extendida cuando el mecanismo de integración y el pipeline lo permitan. Recibir un atributo no implica que YOM lo utilice automáticamente: su uso debe validarse durante la implementación.
Ejemplo con atributos adicionales maintenanceFrequency, assetOwner y capacityLiters:
{
"comodatoId": "COM-00123",
"commerceId": "12345",
"equipmentType": "Congelador 400L",
"startDate": "2026-03-15T00:00:00.000Z",
"isInactive": false,
"otherProperties": {
"maintenanceFrequency": "Semestral",
"assetOwner": "Planta Norte",
"capacityLiters": 400
}
}