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*, body.products, products.productId, products.quantity, body.couponCode, body.additionalDiscountsMarkers, langCode

);

Esquema de parámetros

Esquema

body(required): 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 descuento adicionales.

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("my_order", body);

Ejemplo de respuesta

{
  "formIdentifier": "orderForm",
  "paymentAccountIdentifier": "cash",
  "formData": [
    {
      "marker": "order_name",
      "value": "Ivan",
      "type": "string"
    }
  ],
  "products": [
    {
      "productId": 2957,
      "quantity": 2
    }
  ],
  "currency": "usd",
  "totalSum": 300
}

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: unknown
Configuración de descuento aplicada al pedido.

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

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

---