YOM notifica al sistema del cliente cada solicitud de comodato que registran los vendedores desde la aplicación o los comercios desde la plataforma B2B. El comodato es un equipo que el cliente entrega en préstamo al comercio — un congelador, un refrigerador, un exhibidor —, y la solicitud es el formulario con el que se pide esa entrega.
Cuando la solicitud se registra, y cada vez que se modifica después, YOM envía una llamada HTTP POST al endpoint del cliente con el detalle del Comercio y las respuestas del formulario.
El mismo endpoint recibe las altas y las modificaciones. Cada mensaje trae el identificador de la solicitud en comodatoId, y el sistema del cliente debe tratarlo como un upsert: registrar la solicitud si es la primera vez que ve ese identificador, o reemplazarla si ya la conoce.
<aside> ⚙️
El módulo de comodatos se habilita por cliente desde YOM. Para activarlo hay que informar a YOM la URL del endpoint de recepción y las credenciales con las que YOM debe autenticarse contra él. Los requisitos generales de autenticación y formato están en Requisitos técnicos
</aside>
eventType: "created".eventType: "created".eventType: "updated".<aside> ⚠️
Las solicitudes que el propio cliente carga en YOM por lote no generan ninguna llamada. Devolverlas duplicaría en el ERP lo que el cliente acaba de enviar.
</aside>
<aside> ℹ️
El formulario de comodato es configurable por cliente: los campos, sus opciones y su obligatoriedad se definen en YOM. Por eso el contenido de responses cambia de un cliente a otro, y este documento describe la forma de cada respuesta, no la lista de preguntas.
</aside>
POST <tu_dominio>/webhooks/yom/comodatos
Cuerpo de la solicitud
{
"eventType": "created",
"comodatoId": "66f0a1b2c3d4e5f6a7b8c9d0",
"externalId": "COM-000123",
"commerce": { ... },
"responses": [ ... ]
}
El cuerpo del mensaje.
| Campo | Tipo | Carácter | Descripción | Ejemplos |
|---|---|---|---|---|
eventType |
📝 Texto | 🟢 Requerido | Qué originó la llamada. | |
"created" → la solicitud se acaba de registrar |
||||
"updated" → se modificaron las respuestas de una solicitud ya enviada |
"created" |
|||
comodatoId |
📝 Texto | 🟢 Requerido | Identificador único de la Solicitud de comodato en YOM. Es la clave del upsert: no cambia nunca y es el mismo en el alta y en todas sus modificaciones posteriores. | "66f0a1b2c3d4e5f6a7b8c9d0" |
externalId |
📝 Texto | ⚪ Opcional | Código de la Solicitud en el sistema del cliente. Solo viaja en las solicitudes que el propio cliente cargó en YOM; las que registra un vendedor o un comercio no tienen ninguno. | "COM-000123" |
commerce |
📝 Objeto → Commerce | 🟢 Requerido | El Comercio que recibe el equipo, completo. Su código en el sistema del cliente está en contact.externalId. Ver detalle abajo. |
|
responses |
🔡 Lista de Objetos → Response | 🟢 Requerido | Las respuestas del formulario. Ver detalle abajo. |
Cada respuesta de responses. La lista llega ordenada igual que el formulario en pantalla y contiene solo los campos visibles que fueron respondidos: los campos opcionales sin responder y los que quedaron ocultos por la lógica condicional del formulario no viajan.
| --- | --- | --- | --- | --- |