La entidad Limite de descuento permite gestionar los limites de descuentos que puede aplicar un vendedor por sobre los descuentos que vienen de la entidad de Promociones
GET /api/discount-limits
| Campo | Tipo | Carácter | Descripción | Ejemplos |
|---|---|---|---|---|
targetCommerceIds |
🔠 Lista de textos → Comercios | ⚪ Opcional | lista de Identificadores de Comercio al que se le aplicará el Límite de descuento. | |
*Debe corresponder al campo commerceId de la carga de Comercios . |
"12345", "67890"] |
| productId | 📝 Texto | ⚪ Opcional | Producto al que se le aplica el límite de descuento.productId de la carga de Productos.type = product para funcionar | "PROD-00" |
| enabled | 🔘 Bool | 🟢 Requerido | ¿Está activo el Límite de descuento? | true
false |
| useMixedDiscountTotal | 🔘 Bool | ⚪ Opcional | Cuando está en true se revisan todos los límites de descuento, tanto para type product y type order y se suman. Cuando este campo es false, se toma sólo el descuento del type . | true
false |
| type | 📝 Texto | 🟢 Requerido | Tipo de descuento a aplicar.
'product' → Descuento aplicado a un producto en particular
'order' → Descuento aplicado a la orden | "product" |
| blockLimit | 🔢 Número | 🟢 Requerido | Límite de descuento máximo para la creación de la orden en el sistema de YOM. Si se supera este monto, la creación de la orden falla con mensaje de error.
**** Este límite sólo aplica exclusivamente para este descuento de vendedor** | 0.2 |
| retainLimit | 🔢 Número | 🟢 Requerido | Límite de descuento máximo para la retención de la orden en el sistema de YOM. Si se supera este monto, la creación de la orden es exitosa, pero queda con un estado pendiente de aprobación de admin y no se envía al ERP del cliente.
**** Este límite sólo aplica exclusivamente para este descuento de vendedor** | 0.15 |La respuesta del endpoint de Límite de descuento proporciona un JSON que contiene la información detallada del límite de descuento que se quiere aplicar ya sea a las ordenes o a un producto en particular.
{
"enabled": true,
"targetCommerceIds": [],
"useMixedTotal": true,
"type": "order",
"blockLimit": 0.2,
"retainLimit": 0.1
}
{
"enabled": true,
"targetCommerceIds": ["12345"],
"productId": "PROD-1234"
"useMixedTotal": true,
"type": "product",
"blockLimit": 0.2,
"retainLimit": 0.1
}
Con esta estructura, podrás gestionar y consultar la información de Límite de descuento 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>