El Costo de despacho es una funcionalidad en YOM que permite asignar un costo de despacho a una Orden en base a las reglas de negocio que tenga el cliente, ya sea por cantidad de productos, dirección de despacho, etc.
GET /api/shipping-cost
Este endpoint recibe como payload una Orden de YOM, así desde el lado del cliente tendrán toda la información necesaria para hacer el cálculo.
{
"order": {
"orderId": "ORD004",
"orderDate": "2025-04-23T10:00:00.000Z",
"invoiceDate": "",
"type": "order",
"observation": "Entrega antes de las 12:00",
"commerce": {
"commerceId": "COMM004",
"internalCommerceId": "YOM-COMM004",
"name": "Panadería Estrella",
"class": "Panadería",
"locations": [
{
"address": "Calle Las Condes 123, Local 3, Las Condes",
"commune": "Las Condes",
"city": "Santiago",
"region": "Región Metropolitana",
"country": "Chile",
"locality": "San Carlos de Apoquindo",
"coordinates": {
"latitude": "-33.4167",
"longitude": "-70.5833"
}
}
],
"governmentId": "76543210-9",
"phone": "+56965432109",
"email": "[email protected]",
"createdDate": "2023-08-15T00:00:00.000Z",
"isInactive": false,
"nextDeliveryDate": "2025-04-25T00:00:00.000Z",
"visitPlan": "wednesday,saturday",
"channel": "Canal Tradicional",
"subChannel": "Canal almacenes",
"nextVisitDate": "2025-04-26T00:00:00.000Z",
"visitRoute": "1-3V,2-6V"
},
"user": {
"internalUserId": "YOM-USER004",
"name": "Carlos Gómez",
"email": "[email protected]",
"phone": "+56934567891",
"governmentId": "19876543-2"
},
"seller": {
"sellerId": "SELLER004",
"internalSellerId": "YOM-SELLER004",
"name": "Elena Vargas",
"email": "[email protected]",
"phone": "+56987654322",
"governmentId": "18765432-3",
"supervisorIds": ["SUPER004"],
"isInactive": false
},
"status": "pending",
"pricing": {
"subtotalAmount": 40460,
"discountAmount": 2023,
"shippingAmount": 3000,
"taxAmount": 7697.4,
"totalAmount": 46734.4,
"taxes": [
{
"code": "IVACL",
"name": "IVA",
"rate": 0.19
}
],
"discounts": [
{
"scope": "order",
"type": "percentage",
"value": 0.05
}
]
},
"products": [
{
"product": {
"productId": "PROD004",
"internalProductId": "YOM-PROD004",
"name": "Harina de Trigo Refinada",
"image": "<https://example.com/harina-refinada.jpg>",
"description": "Harina de trigo refinada para repostería y panificación.",
"brand": "Harina YOM",
"tags": ["alimentos", "harinas", "repostería"],
"pricePerUnit": 8092,
"taxes": [
{
"code": "IVACL",
"name": "IVA",
"rate": 0.19
}
],
"constraints": {
"minUnit": 6,
"stepSize": 2
},
"formats": [
{
"displayName": "Unidad",
"key": "UN",
"baseAmountPerFormat": 1,
"base": true
},
{
"displayName": "Pack",
"key": "PACK",
"baseAmountPerFormat": 6,
"base": false
}
],
"dimensions": {
"weight": 1,
"weightUnit": "kg",
"length": 25,
"lengthUnit": "cm",
"width": 15,
"widthUnit": "cm",
"height": 10,
"heightUnit": "cm",
"volume": 3.75,
"volumeUnit": "L"
},
"group": {
"name": "Harinas",
"description": "Productos de harina para panaderías y repostería."
}
},
"quantity": 5,
"selectedFormatKey": "UN",
"pricing": {
"subtotalAmount": 40460,
"discountAmount": 2023,
"shippingAmount": 3000,
"taxAmount": 7697.4,
"totalAmount": 46734.4,
"taxes": [
{
"code": "IVACL",
"name": "IVA",
"rate": 0.19
}
],
"discounts": [
{
"scope": "product",
"type": "percentage",
"value": 0.05
}
]
},
"additionalInfo": [
{
"key": "lote",
"value": "LOTE2025B"
}
]
}
],
"shipping": {
"name": "Juan Morales",
"phone": "+56945678912",
"location": {
"address": "Calle Las Condes 123, Local 3, Las Condes",
"commune": "Las Condes",
"city": "Santiago",
"region": "Región Metropolitana",
"country": "Chile",
"coordinates": {
"latitude": "-33.4167",
"longitude": "-70.5833"
}
},
"comment": "Dejar en recepción",
"estimatedDeliveryDate": "2025-04-25T00:00:00.000Z",
"deliveryDate": "2025-04-26T00:00:00.000Z",
"pricing": {
"subtotalAmount": 3000,
"discountAmount": 0,
"taxAmount": 570,
"totalAmount": 3570,
"taxes": [
{
"code": "IVACL",
"name": "IVA",
"rate": 0.19
}
],
"discounts": []
}
},
"appliedDiscounts": [
{
"triggerProductId": "6839330db8071364ebc8cbb1",
"promotionId": "6862b762b4a4d3dc7d987bdb",
"giftedProductId": null,
"startDate": "2025-05-01T00:00:00.000Z",
"endDate": "2025-07-30T23:59:59.000Z",
"promotionType": "new-price"
}
],
"internalOrderId": "YOM-ORD004",
"selectedDistributionCenter": "1"
}
}
| Campo | Tipo | Carácter | Descripción | Ejemplos |
|---|---|---|---|---|
shippingCost |
🔢 Número | 🟢 Requerido | Costo de despacho SIN impuesto | 3500 |
La respuesta del endpoint de Costo de despacho proporciona un JSON la información del costo de despacho SIN impuesto
{
"shippingCost": 3500
}
Con esta estructura, podrás gestionar y consultar la información de Costo de despacho de los Órdenes en YOM.
Pasos anteriores
<aside> <img src="/icons/arrow-left_gray.svg" alt="/icons/arrow-left_gray.svg" width="40px" />
</aside>
Siguientes pasos
<aside> <img src="/icons/arrow-right_gray.svg" alt="/icons/arrow-right_gray.svg" width="40px" />
</aside>
Tabla de contenidos