previewOrder

Visualize um cálculo de 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*, langCode

);

Esquema de parâmetros

Esquema

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

body.products: IPreviewOrderProduct[]
Array de produtos a serem visualizados.

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

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

body.couponCode: string
Códigos de cupom a serem aplicados.

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

body.bonusAmount: number
Valor do bônus a ser aplicado.

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

Exemplo de resposta

{
  "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 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: IOrderDiscountConfig
Configuração de desconto aplicada ao pedido.

discountConfig.bonus: IOrderDiscountBonus | null
Resultado do cálculo do bônus, nulo quando os bônus não são utilizados, ou omitido completamente quando o pedido não tem contexto de bônus.

discountConfig.coupon: unknown | null
Cupom resolvido, ou nulo quando nenhum cupom é aplicado.

discountConfig.orderDiscounts: unknown[]
Descontos em nível de pedido que foram correspondidos e aplicados.

discountConfig.productDiscounts: unknown[]
Descontos em nível de produto que foram correspondidos e aplicados.

discountConfig.settings: IOrderDiscountSettings
Configurações de empilhamento e limite usadas durante o cálculo.

discountConfig.additionalDiscountsMarkers: string[]
Marcadores de descontos extras solicitados pelo cliente (omitidos nas respostas de visualização).

discountConfig.bonusApplied: number
Valor do bônus aplicado ao pedido (omitido nas respostas de visualização).
exemplo: 0

discountConfig.excludedGiftProductIds: string[]
IDs de produtos excluídos da seleção de presentes (omitidos nas respostas de visualização).

discountConfig.totalDue: number
Valor total devido após descontos e bônus (omitido nas respostas de visualização).
exemplo: 300

discountConfig.totalRaw: number
Valor total antes dos descontos (omitido nas respostas de visualização).
exemplo: 300

discountConfig.totalSumWithDiscount: number
Valor total após descontos, mas antes dos bônus (omitido nas respostas de visualização).
exemplo: 300

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

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

orderPreview.id: number
Identificador do produto.
exemplo: 2954

orderPreview.price: number
Preço unitário do produto antes dos descontos.
exemplo: 51

orderPreview.quantity: number
Quantidade do produto.
exemplo: 1

orderPreview.discountPrice: number | null
Preço unitário após descontos, ou nulo quando nenhum desconto se aplica.
exemplo: null

orderPreview.isGift: boolean
Se o produto é entregue como presente.
exemplo: false

bonusApplied: number
Bônus aplicado ao pedido.

totalDue: number
Total devido após bônus.

---