Luego de empezar a operar con YOM, es posible recibir las intenciones de compra de tus Comercios. Estas se reflejan en la entidad Orden.
¿Qué es una Orden?
Una Orden en YOM representa una solicitud de compra de un Comercio realizada a través de la plataforma. Cada Orden contiene información detallada sobre el Comercio, los Productos seleccionados, la dirección de envío, el precio total y otros detalles importantes para la ejecución de la venta.
POST order.created
POST order.updated
Una Orden incluye la información completa de las entidades relacionadas a ella con el estado al momento de su creación.
<aside> <img src="/icons/shop_gray.svg" alt="/icons/shop_gray.svg" width="40px" />
Comercio
</aside>
<aside> <img src="/icons/profile_gray.svg" alt="/icons/profile_gray.svg" width="40px" />
Vendedor
</aside>
<aside> <img src="/icons/hair-care_gray.svg" alt="/icons/hair-care_gray.svg" width="40px" />
Productos
</aside>
<aside> <img src="/icons/user-circle-filled_gray.svg" alt="/icons/user-circle-filled_gray.svg" width="40px" />
Usuario
</aside>
Una Orden incluye los montos base, impuestos, descuentos y costos de envío aplicados sobre cada Producto y sobre la Orden completa.
<aside> <img src="/icons/hashtag_gray.svg" alt="/icons/hashtag_gray.svg" width="40px" />
Subtotal
</aside>
<aside> <img src="/icons/remove_gray.svg" alt="/icons/remove_gray.svg" width="40px" />
Descuentos
</aside>
<aside> <img src="/icons/plus_gray.svg" alt="/icons/plus_gray.svg" width="40px" />
Despacho
</aside>
<aside> <img src="/icons/plus_gray.svg" alt="/icons/plus_gray.svg" width="40px" />
Impuestos
</aside>
<aside> <img src="/icons/priority-mid_gray.svg" alt="/icons/priority-mid_gray.svg" width="40px" />
Total
</aside>
Cada Pricing contiene cada uno de los montos anteriores, con el detalle del cálculo de los descuentos e impuestos aplicados.
La entidad order representa la solicitud de compra de Productos hecha por un Comercio a través de Yom. Contiene la información principal de una solicitud de compra realizada por un Comercio, incluyendo detalles del Comercio, Productos, Precios, y estado del pedido.
| Campo | Tipo | Carácter | Descripción | Ejemplos |
|---|---|---|---|---|
orderId |
📝 Texto | 🟢 Requerido | Identificador único de la Orden asignado por el cliente. | "ORDER001" |
internalOrderId |
🆔 ObjectId | 🟡 Opcional | Identificador único de la Orden. | |
| **Generado por YOM | ||||
Se envía en el evento order.created |
"YOM-ORDER001" |
|||
orderDate |
📅 Fecha | 🟢 Requerido | Fecha en que se realizó la Orden. | |
| *La fecha debe estar en formato ISO 8601. | “2023-04-27” |
|||
“2018-10-22T00:00:00.000Z” |
||||
observation |
📝 Texto | 🟡 Opcional | Observaciones adicionales sobre la Orden. | "Entrega rápida solicitada" |
status |
📝 Texto | 🟢 Requerido | Estado actual de la Orden. | |
draft |
||||
awaiting_approval |
||||
approved |
||||
processing |
||||
ready_to_ship |
||||
shipped |
||||
out_for_delivery |
||||
delivered |
||||
completed |
||||
returned |
||||
partially_returned |
||||
failed_delivery |
||||
rejected |
||||
awaiting_pickup |
||||
partialy_fullfilled |
draft |
|||
awaiting_approval |
||||
approved |
||||
processing |
||||
ready_to_ship |
||||
shipped |
||||
out_for_delivery |
||||
delivered |
||||
completed |
||||
returned |
||||
partially_returned |
||||
failed_delivery |
||||
rejected |
||||
awaiting_pickup |
||||
partialy_fullfilled |
||||
type |
📝 Texto | 🟢 Requerido | Tipo de Orden | “orden” |
user |
📝 Objecto → User | 🟢 Requerido | Información sobre el Usuario que realiza la Orden. | { "userId": "YOM-USER001", "name": "Juan Pérez" } |
pricing |
📝 Objeto → Pricing | 🟢 Requerido | Detalle de los montos asociados a la Orden. | { "subtotalAmount": 1000, "totalAmount": 1140 } |
shipping |
📝 Objeto → Shipping | 🟡 Opcional | Información detallada del envío de la Orden. | {"name": "Oficina Central", "address": "Calle 123", "city": "Ciudad XYZ"} |
seller |
📝 Objecto → Seller | 🟡 Opcional | Información sobre el Vendedor asociado a la Orden. | { "sellerId": "SELLER001", "name": "Carlos López" } |
commerce |
📝 Objeto → Commerce | 🟢 Requerido | Información sobre el Comercio relacionado con la Orden. | { "commerceId": "COMM001", "name": "Tienda XYZ" } |
products |
🔡 Lista de Objetos → OrderProduct | 🟢 Requerido | Detalle de los Productos incluidos en la Orden. | [{"name": "Producto A", "quantity": 2, "price": 200}] |
El objeto user define los detalles del Usuario que realiza la Orden. Esto incluye información personal, contacto, y un identificador único generado por Yom.
| --- | --- | --- | --- | --- |