YOM Docs

Untitled

Untitled

Untitled

Transacciones

Para tener el historial de compra 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 una compra concretada del Comercio. Contiene información sobre el Comercio, los Productos que compró, los Precios, Descuentos, Impuestos, y más.

Carpeta y nombre de archivos

Entidad → transaction

/<nombre_cliente>
	/production
		/load
			/transaction
				/all
					20240201_180000_transaction.csv
					...
				/created
					...
				/updated
					...
	/development
		...

Campos

Campo Tipo Carácter Descripción Ejemplos
orderId 📝 Texto 🟢 Requerido Identificador único del pedido (independiente del tipo de documento). "TR12345"
internalOrderId 📝 Texto 🟢 Requerido 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 🟢 Requerido 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

Si el tipo de documento es nota de crédito, los valores deben ser negativos | "order" "invoice" "credit note" "debit note" | | documentCode | 📝 Texto | 🟡 Recomendado | Código del documento, en caso de ser un pedido se repite orderId en este campo. | "12345" | | quantity | #️⃣ Número | 🟢 Requerido | Cantidad de unidades pedidas del producto. | 10 | | netPricePerUnit | #️⃣ Número flotante | 🟢 Requerido | Precio unitario sin descuento y sin impuesto del Producto. | 900 | | discountedNetPricePerUnit | #️⃣ Número flotante | 🟢 Requerido | Precio sin impuesto y con descuento del producto | 850 | | taxPerUnit | #️⃣ Número flotante | 🟢 Requerido | Monto del impuesto aplicado a cada unidad del Producto. | 190 | | discountedTaxPerUnit | #️⃣ Número flotante | 🟢 Requerido | Monto del impuesto con descuento aplicado a cada unidad del Producto. | 170 | | discountPerUnit | #️⃣ Número flotante | 🟢 Requerido | Descuento unitario sin impuesto aplicado al Producto. | 50 | | grossPricePerUnit | #️⃣ Número flotante | 🟢 Requerido | Precio con impuesto y sin descuento del producto | 1100 | | discountedGrossPricePerUnit | #️⃣ Número flotante | 🟢 Requerido | Precio con impuesto y con descuento del producto | 950 | | currency | 📝 Texto | 🟢 Requerido | Moneda en la que se realiza la venta. "clp" | "clp" | | origin | 📝 Texto | 🟢 Requerido | Origen de la Transacción. Esta es una definición propia del cliente | "carga inicial", ”ventas_yom” | | sourceChannel | 📝 Texto | 🟢 Requerido | Canal de venta contacto | "app movil”, ”ecommerce | | deliveryDate | 📅 Fecha | 🟡 Recomendado | Fecha en que se entregó el pedido. La fecha debe estar en formato ISO 8601. | "2018-10-22T00:00:00.000Z" | | referenceCode | 📝 Texto | 🟢 Requerido | Código del documento de referencia en caso de que documentType sea "credit note" o ”debit note”. Normalmente el código hace referencia a una “invoice”. | "REF123" | | couponCode | 📝 Texto | ⚪ Opcional | Código de cupón | "CUPON123" | | isDeleted | 🔘 Bool | ⚪ Opcional | ¿Fue eliminada la Transacción? | "true" | | dispatchPricePerUnit | #️⃣ Número flotante | ⚪ Opcional | Precio del despacho por unidad | 1100 |

Respuesta

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
}

CSV Aplanado

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

Lista de campos CSV

Columna Valor
orderId 12345
internalOrderId TIPER123
productId PROD5678
commerceId COM1234
customerId CUS001
sellerId SEL001
sellerRouteId ROUSEL001
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 CUP123
isDeleted true

Con esta estructura puedes gestionar y consultar la información de los pedidos en YOM de manera eficiente.

Pasos anteriores

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

</aside>

Siguientes pasos

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

</aside>