Edición de órdenes

YOM permite que el vendedor edite una orden que ya fue enviada al sistema del cliente. Antes de guardar el cambio, YOM envía una solicitud HTTP POST al endpoint del cliente con la orden editada, la orden anterior, el Commerce y el Usuario que edita. El cliente aplica el cambio en su sistema y responde si lo acepta o lo rechaza. La edición solo se guarda en YOM si el cliente la acepta.

<aside> 📝

Para habilitar la edición, el cliente expone el endpoint e informa a YOM su URL. Mientras no haya una URL configurada, la opción de editar órdenes enviadas no aparece en la aplicación.

</aside>

Endpoint

POST <tu_dominio>/webhooks/yom/order/edit

Ruta sugerida. YOM llama a la URL exacta que el cliente informe.

Encabezados que envía YOM

Content-Type: application/json
x-auth-token: {identificador del cliente en YOM}
origin: legacy.youorder.me
x-yom-idempotency-key: {clave única de la operación}

Cuerpo de la solicitud

{
  "order": { ... },
  "previousOrder": { ... },
  "commerce": { ... },
  "user": { ... }
}

Cuándo se envía

La orden está en estado "pending" o "processing".
La orden ya está en el sistema del cliente: tiene orderId (folio del cliente) o está en "processing".

Si la orden todavía no llegó al sistema del cliente, la edición se guarda solo en YOM, no se llama a este endpoint y el cliente recibe la orden ya editada cuando se envíe.

Campos que el vendedor puede editar

products → productos y cantidades
sellerDiscounts → descuentos del vendedor
shippingAddress → dirección de despacho
observation → observación
externalPurchaseOrderId → orden de compra del comercio
type → tipo de orden
distributionCenterId / distributionCenterName → centro de distribución

El estado, la fecha de entrega y los identificadores de la orden no se pueden editar. YOM recalcula los precios, descuentos y promociones de la orden editada antes de enviarla.

Campos

Order

La orden con los cambios aplicados (order). El objeto previousOrder tiene la misma estructura y contiene la orden tal como estaba antes de la edición.

Respuesta esperada

El resultado se informa con el código HTTP de la respuesta, con Content-Type: application/json.

| --- | --- | --- |

Cuerpo de la respuesta

| --- | --- | --- | --- | --- |

Edición aceptada

HTTP/1.1 200 OK

{
  "erpOrderId": "30264709"
}

Edición rechazada

HTTP/1.1 422 Unprocessable Entity

{
  "message": "El pedido ya fue despachado"
}

Ejemplo

POST https://api.cliente.com/webhooks/yom/order/edit
Content-Type: application/json
x-auth-token: 6a5a8ee27726337b51c72405
origin: legacy.youorder.me
x-yom-idempotency-key: 6712fa9b8c1d2e3f40567890:edit:1:3f9a1c0b7d2e4a58

{
  "previousOrder": { ... },
  "user": {
    "name": "Juan Pérez",
    "email": "[email protected]"
  },
  "commerce": {
    "domain": "cliente.youorder.me",
    "contact": {
      "name": "Almacén Doña Rosa",
      "externalId": "CLI-004512",
      "email": "[email protected]",
      "phone": "+59171234567"
    },
    "address": [
      { "street": "Av. Blanco Galindo 1234", "city": "Cochabamba" }
    ],
    "administrativeLevel1": { "value": "CBBA", "description": "Cochabamba" },
    "channel": "TRADICIONAL",
    "subChannel": "ALMACEN",
    "payConditionId": "30",
    "payDescription": "Crédito 30 días",
    "credit": {
      "usesCredit": true,
      "balance": 350000,
      "maxAmount": 500000,
      "state": "ok"
    },
    "active": true,
    "authorized": true
  },
  "order": {
    "domain": "cliente.youorder.me",
    "commerceId": "65f0a1b2c3d4e5f601234567",
    "commerceName": "Almacén Doña Rosa",
    "externalId": "CLI-004512",
    "sellerId": ["186"],
    "externalSellerIds": ["V-0186"],
    "orderId": "32670617",
    "editCount": 0,
    "status": "processing",
    "type": "order",
    "receiptType": "factura",
    "orderDate": "2026-08-10T14:22:05.113Z",
    "shippingAddress": { "street": "Av. Blanco Galindo 1234", "city": "Cochabamba" },
    "products": [
      {
        "sku": "7501234567890",
        "productId": "660b1c2d3e4f5a6b70123456",
        "name": "Leche Entera 1L",
        "quantity": 24,
        "unit": "unit",
        "type": "product",
        "packaging": {
          "packageUnit": "box",
          "amountPerBox": 12,
          "selectedPackaging": "box",
          "boxName": "Caja"
        },
        "pricing": { "pricePerUnit": 9.5 },
        "pricingAfterDiscounts": { "pricePerUnit": 8.9 },
        "fullPricing": {
          "netPricePerUnit": 8.9,
          "discountedPricePerUnit": 8.9,
          "netTaxedPricePerUnit": 10.59,
          "finalPricePerUnit": 10.59
        },
        "taxes": [{ "taxCode": "IVA_13", "taxName": "IVA", "taxRate": 0.13, "type": "percentage" }]
      }
    ],
    "pricing": {
      "totalPrice": 228,
      "netTotalPrice": 213.6,
      "discountedTotalPrice": 213.6,
      "netTaxedTotalPrice": 254.16,
      "finalTotalPrice": 254.16,
      "shipping": { "netValue": 0, "netTaxedValue": 0 }
    },
    "observation": "Entregar por la mañana"
  }
}

curl -X POST \
  'https://api.cliente.com/webhooks/yom/order/edit' \
  -H 'Content-Type: application/json' \
  -H 'x-auth-token: 6a5a8ee27726337b51c72405' \
  -H 'x-yom-idempotency-key: 6712fa9b8c1d2e3f40567890:edit:1:3f9a1c0b7d2e4a58' \
  -d '{"order": { ... }, "previousOrder": { ... }, "commerce": { ... }, "user": { ... }}'

Consideraciones

<aside> ⏱️

</aside>