Transacciones

Para tener el historial comercial que han concretado los Comercios a lo largo de su relación con el cliente, se manejan sus Transacciones.

¿Qué es una transacción? Una Transacción en YOM representa un evento comercial asociado a un Comercio: puede corresponder a un pedido, una factura, una boleta, una nota de crédito o una nota de débito. Cada fila del archivo representa una línea de producto dentro de un documento.

Granulidad de una transacción

El grano de una transacción es una fila por combinación de documentCode + orderId + documentType + productId. Un mismo producto no puede repetirse dentro de una misma orden (orderId).

Sí permitido: un mismo producto en la misma factura (documentCode) pero en órdenes distintas (orderId distinto). Es el caso de una factura consolidada: cada orden se registra por separado y las cantidades se conservan.

No soportado: el mismo producto en dos o más líneas bajo el mismo orderId. En ese caso YOM conserva una sola línea por producto (la última procesada) y descarta las demás, perdiendo cantidad y venta.

Acción requerida: si en el origen un producto aparece en varias líneas de la misma orden (por ejemplo, picking o despacho parcial), deben consolidarse en una sola línea antes de enviar el archivo, sumando la quantity y dejando un único precio unitario.

Endpoint

El endpoint de Transacciones permite a YOM acceder a información detallada sobre cada pedido completado.

GET /api/transactions

El endpoint debe soportan filtro sobre el campo date, fecha del pedido o factura.

date_from → Fecha y hora desde la cual se quieren obtener los registros creados.

date_to → Fecha y hora hasta la cual se quieren obtener los registros creados.

GET /api/transactions?date_from=2024-01-01T00:00:00Z&date_to=2024-12-31T23:59:59Z

Campos

Campo	Tipo	Carácter	Descripción	Ejemplos
`orderId`	📝 Texto	🟢 Requerido	Identificador único del pedido (independiente del tipo de documento).	"TR12345"
`internalOrderId`	📝 Texto	⚪ Opcional	Identificador del pedido hecho en YOM. (El que enviamos en la inyección hacia el ERP)	"YOM12345"
`productId`	📝 Texto	🟢 Requerido	Identificador externo del producto	"PROD5678"
`commerceId`	📝 Texto	🟢 Requerido	Identificador externo del comercio	"COM987"
`sellerId`	📝 Texto	🟢 Requerido	Identificador externo del vendedor	"SEL987"
`sellerRouteId`	📝 Texto	⚪ Opcional	Identificador externo de la ruta del vendedor	"ROUSEL987"
`date`	📅 Fecha	🟢 Requerido	Fecha del pedido o factura. La fecha debe estar en formato ISO 8601.	"2018-10-22T00:00:00.000Z"
`documentType`	📝 Texto	🟢 Requerido	Tipo de documento.
`"order"` → pedido
`"invoice"` → factura
`"bill"` → boleta
`"credit note"` → nota de crédito
`”debit note”` → nota de débito

Respuesta

La respuesta del endpoint de Transacciones devuelve un JSON que contiene la información detallada de cada orden registrado en el cliente (son las ordenes de YOM más los pedidos que puede crear el cliente desde algún sistema propio de ellos), incluyendo datos del cliente, productos, precios, y más.

Ejemplo de Respuesta

{
    "orderId": "TR12345",
    "internalOrderId": "YOM12345",
    "productId": "PROD5678",
    "commerceId": "COM987",
    "customerId": "CUS987",
    "sellerId": "SEL987",
    "sellerRouteId": "ROUSEL987",
    "date": "2018-10-22T00:00:00.000Z",
    "documentType": "order",
    "documentCode": "12345",
    "quantity": 10,
    "netPricePerUnit": 900,
    "discountedNetPricePerUnit": 850,
    "taxPerUnit": 190,
    "discountedTaxPerUnit": 170,
    "discountPerUnit": 50,
    "grossPricePerUnit": 1100,
    "discountedGrossPricePerUnit": 950,
    "currency": "clp",
    "origin": "carga inicial",
    "sourceChannel": "app movil",
    "deliveryDate": "2018-10-22T00:00:00.000Z",
    "referenceCode": "REF123",
    "couponCode": "CUPON123",
    "isDeleted": true,
    "dispatchPricePerUnit": 1500
}

Pasos anteriores

<aside> <img src="/icons/arrow-left_gray.svg" alt="/icons/arrow-left_gray.svg" width="40px" /> Promociones

</aside>

Siguientes pasos

</aside>

Tabla de contenidos