YOM permite que el vendedor cancele una orden que ya fue enviada al sistema del cliente. Antes de cancelarla, YOM envía una solicitud HTTP POST al endpoint del cliente con la orden, el Commerce, el Usuario que cancela y el motivo. El cliente anula la orden en su sistema y responde si acepta o rechaza la cancelación. La orden solo pasa a "canceled" en YOM si el cliente la acepta.
<aside> 📝
Para habilitar la cancelación, el cliente expone el endpoint e informa a YOM su URL. Mientras no haya una URL configurada, la opción de cancelar órdenes enviadas no aparece en la aplicación.
</aside>
POST <tu_dominio>/webhooks/yom/order/cancel
Ruta sugerida. YOM llama a la URL exacta que el cliente informe.
Encabezados que envía YOM
Content-Type: application/jsonx-auth-token: {identificador del cliente en YOM}origin: legacy.youorder.mex-yom-idempotency-key: {clave única de la operación}Cuerpo de la solicitud
{
"order": { ... },
"commerce": { ... },
"user": { ... },
"reason": "..."
}
"pending" o "processing".orderId (folio del cliente) o está en "processing".Si la orden todavía no llegó al sistema del cliente, se cancela solo en YOM, no se llama a este endpoint y la orden ya no se envía al cliente.
La orden a cancelar (order), tal como está en YOM al momento de la solicitud.
| --- | --- | --- | --- | --- |
Cada línea de order.products.
| --- | --- | --- | --- | --- |
El objeto order.pricing.
| --- | --- | --- | --- | --- |
La entidad commerce.
| --- | --- | --- | --- | --- |
El Usuario de YOM que solicita la operación: el vendedor o un administrador. No incluye credenciales.