YOM puede notificar al sistema del cliente cada solicitud de devolución que registran los vendedores o los comercios sobre un pedido ya creado. Cuando se registra la solicitud, YOM envía una llamada HTTP POST al endpoint del cliente con el detalle de la devolución, del Order, del Commerce y del Seller.
La devolución es de mercadería: se declara qué líneas del pedido se devuelven, en qué cantidad y por qué motivo. YOM no emite ni administra notas de crédito.
El resultado de la revisión lo informa el cliente de vuelta a YOM mediante un webhook de estado, línea por línea.
<aside> ⚙️
El módulo de devoluciones se habilita por cliente desde YOM. Para activarlo hay que informar a YOM la URL del endpoint de recepción; a diferencia de otras integraciones, aquí no existe una ruta estándar obligatoria. Los requisitos generales de autenticación y formato están en Requisitos técnicos
</aside>
POST <tu_dominio>/webhooks/yom/refunds
Cuerpo de la solicitud
{
"refundRequest": { ... },
"order": { ... },
"commerce": { ... },
"seller": { ... }
}
La entidad refundRequest: la solicitud de devolución propiamente dicha.
| Campo | Tipo | Carácter | Descripción | Ejemplos |
|---|---|---|---|---|
requestId |
📝 Texto | 🟢 Requerido | Identificador único de la Solicitud de devolución. Formato RF-AAAAMMDD-<16 caracteres>. |
|
| Es la clave con la que el cliente responde el resultado de la revisión. | "RF-20260914-9f3c1a2b8d4e5f60" |
|||
domain |
📝 Texto | 🟢 Requerido | Dominio del cliente al que pertenece la solicitud. | "cliente.youorder.me" |
externalOrderId |
📝 Texto | ⚪ Opcional | Código del Pedido en el sistema del cliente. Identifica el pedido sobre el que se pide la devolución. | "PED-000123456" |
orderDate |
📅 Fecha | ⚪ Opcional | Fecha de creación del Pedido original, en formato ISO 8601. | "2026-09-10T14:22:31.004Z" |
externalCommerceId |
📝 Texto | ⚪ Opcional | Código del Comercio en el sistema del cliente. | "CL-0099231" |
externalSellerId |
📝 Texto | ⚪ Opcional | Código del Vendedor en el sistema del cliente. | "V-0451" |
channel |
📝 Texto | 🟢 Requerido | Canal desde el que se registró la solicitud. | |
"app" → aplicación del vendedor |
||||
"ecommerce" → plataforma del comercio |
"app" |
|||
status |
📝 Texto | 🟢 Requerido | Estado general de la solicitud. En esta llamada siempre es "in_review". |
|
"in_review" · "approved" · "rejected" · "partial" |
||||
| Se recalcula a partir del estado de cada línea. | "in_review" |
|||
items |
🔡 Lista de Objetos → RefundItem | 🟢 Requerido | Líneas que se devuelven. Máximo 200 por solicitud. Ver detalle abajo. | |
events |
🔡 Lista de Objetos | ⚪ Opcional | Traza de auditoría interna de YOM: type, name, message y createdAt. |
|
createdAt |
📅 Fecha | 🟢 Requerido | Fecha de creación de la solicitud, en formato ISO 8601. | "2026-09-14T11:05:12.881Z" |
updatedAt |
📅 Fecha | 🟢 Requerido | Fecha de la última modificación de la solicitud, en formato ISO 8601. | "2026-09-14T11:05:12.881Z" |
Cada línea de refundRequest.items.
| --- | --- | --- | --- | --- |
Cada respuesta de items[].extraFields. El formulario de devolución es configurable por cliente, así que el conjunto de campos depende de la configuración de cada uno.
| --- | --- | --- | --- | --- |
Los objetos order, commerce y seller se envían completos, con la misma estructura que en el resto de las integraciones.