previewOrder

Previsualiza un cálculo de pedido sin crearlo. 🔐 Este método requiere autorización.

Descripción

Este método calcula y previsualiza un pedido, incluyendo totales de productos, descuentos aplicados y la suma final, sin crear realmente el pedido en el sistema. Devuelve una Promesa que se resuelve en un objeto IPreviewOrderEntity.

Orders.previewOrder(

body*, langCode

);

Esquema de parámetros

Esquema

body(requerido): ICreateOrderPreview
Cuerpo de la previsualización del pedido

body.products: IPreviewOrderProduct[]
Array de productos a previsualizar.

products.productId: number
Identificador del producto.
ejemplo: 1

products.quantity: number
Cantidad del producto.
ejemplo: 2

body.couponCode: string
Código de cupón a aplicar.

body.additionalDiscountsMarkers: string[]
Array de marcadores de descuentos adicionales.

body.bonusAmount: number
Cantidad de bonificación a aplicar.

langCode: string
Código de idioma. Predeterminado: "en_US"
ejemplo: "en_US"

Ejemplos

Ejemplo mínimo

const body = {
  "formIdentifier": "orderForm",
  "paymentAccountIdentifier": "cash",
  "formData": {
    {
      "marker": "order_name",
      "type": "string",
      "value": "Ivan"
    }
  },
  "products": [
    {
      "productId": 2957,
      "quantity": 2
    }
  ]
};
const response = await Orders.previewOrder(body);

Ejemplo de respuesta

{
  "totalSum": 300,
  "totalSumWithDiscount": 285,
  "bonusApplied": 0,
  "totalDue": 285,
  "discountConfig": {
    "orderDiscounts": [
      {
        "id": 2,
        "identifier": "personal_discount",
        "type": "PERSONAL_DISCOUNT",
        "localizeInfos": {
          "title": "Personal discount"
        },
        "startDate": "2026-04-21T18:26:19.815Z",
        "endDate": "2028-03-21T19:26:24.741Z",
        "discountValue": {
          "value": 15,
          "maxAmount": null,
          "discountType": "FIXED_AMOUNT",
          "applicability": "TO_ORDER"
        },
        "exclusions": null,
        "position": 1,
        "conditionLogic": "AND",
        "gifts": [],
        "userGroups": null,
        "userExclusions": null,
        "conditions": [],
        "coupon": null
      }
    ],
    "productDiscounts": [],
    "coupon": null,
    "settings": {
      "allowStacking": true,
      "maxDiscountValue": 50,
      "allowGiftStacking": false,
      "maxBonusPaymentPercent": null,
      "minBonusAmount": null,
      "minOrderAmountForBonus": null,
      "giftRefundPolicy": "KEEP_GIFT"
    },
    "bonus": {
      "availableBalance": 0,
      "maxBonusDiscount": 0,
      "minBonusAmount": null,
      "minOrderAmountForBonus": null,
      "bonusApplied": 0
    }
  },
  "currency": "USD",
  "orderPreview": [
    {
      "id": 2957,
      "isGift": false,
      "price": 150,
      "discountPrice": null,
      "quantity": 2
    }
  ]
}

Esquema de respuesta

Esquema: IOrderPreviewResponse

totalSum: number
Monto total del pedido antes de descuentos.
ejemplo: 300

totalSumWithDiscount: number
Monto total del pedido después de descuentos.
ejemplo: 250

discountConfig: IOrderDiscountConfig
Configuración de descuentos aplicada al pedido.

discountConfig.bonus: IOrderDiscountBonus | null
Resultado del cálculo de bonificación, null cuando no se utilizan bonificaciones, o omitido por completo cuando el pedido no tiene contexto de bonificación.

discountConfig.coupon: unknown | null
Cupón resuelto, o null cuando no se aplica ningún cupón.

discountConfig.orderDiscounts: unknown[]
Descuentos a nivel de pedido que fueron coincidentes y aplicados.

discountConfig.productDiscounts: unknown[]
Descuentos a nivel de producto que fueron coincidentes y aplicados.

discountConfig.settings: IOrderDiscountSettings
Configuraciones de apilamiento y límite utilizadas durante el cálculo.

discountConfig.additionalDiscountsMarkers: string[]
Marcadores de descuentos extra solicitados por el cliente (omitidos en las respuestas de previsualización).

discountConfig.bonusApplied: number
Cantidad de bonificación aplicada al pedido (omitida en las respuestas de previsualización).
ejemplo: 0

discountConfig.excludedGiftProductIds: string[]
IDs de productos excluidos de la selección de regalos (omitidos en las respuestas de previsualización).

discountConfig.totalDue: number
Monto total a pagar después de descuentos y bonificaciones (omitido en las respuestas de previsualización).
ejemplo: 300

discountConfig.totalRaw: number
Monto total antes de descuentos (omitido en las respuestas de previsualización).
ejemplo: 300

discountConfig.totalSumWithDiscount: number
Monto total después de descuentos pero antes de bonificaciones (omitido en las respuestas de previsualización).
ejemplo: 300

currency: string
Moneda del pedido.
ejemplo: "USD"

orderPreview: IOrderPreviewItem[]
Array de elementos de previsualización del pedido.

orderPreview.id: number
Identificador del producto.
ejemplo: 2954

orderPreview.price: number
Precio unitario del producto antes de descuentos.
ejemplo: 51

orderPreview.quantity: number
Cantidad del producto.
ejemplo: 1

orderPreview.discountPrice: number | null
Precio unitario después de descuentos, o null cuando no se aplica ningún descuento.
ejemplo: null

orderPreview.isGift: boolean
Si el producto se entrega como un regalo.
ejemplo: false

bonusApplied: number
Bonificación aplicada al pedido.

totalDue: number
Total a pagar después de bonificaciones.

---