previewOrder

Visualize o cálculo de um pedido sem criá-lo. 🔐 Este método requer autorização.

Descrição

Este método calcula e visualiza um pedido - incluindo totais de produtos, descontos aplicados e a soma final - sem realmente criar o pedido no sistema. Ele retorna uma Promise que resolve para um objeto IPreviewOrderEntity.

Orders.previewOrder(

body*, body.products, products.productId, products.quantity, body.couponCode, body.additionalDiscountsMarkers, langCode

);

Esquema de parâmetros

Esquema

body(obrigatório): ICreateOrderPreview
Corpo da visualização do pedido

body.products: IPreviewOrderProduct[]
Array de produtos para visualizar.

products.productId: number
Identificador do produto.
exemplo: 1

products.quantity: number
Quantidade do produto.
exemplo: 2

body.couponCode: string
Códigodo cupom a ser aplicado.

body.additionalDiscountsMarkers: string[]
Array de marcadores de desconto adicionais.

langCode: string
Código do idioma. Padrão: "en_US"
exemplo: "en_US"

Exemplos

Exemplo 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);

Exemplo de resposta

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

Esquema de resposta

Esquema: IOrderPreviewResponse

totalSum: number
Valor total do pedido antes dos descontos.
exemplo: 300

totalSumWithDiscount: number
Valor total do pedido após os descontos.
exemplo: 250

discountConfig: unknown
Configuração de desconto aplicada ao pedido.

currency: string
Moeda do pedido.
exemplo: "USD"

orderPreview: IOrderPreviewItem[]
Array de itens da visualização do pedido.

---