Aller au contenu principal

previewOrder

Aperçu d'un calcul de commande sans la créer. 🔐 Cette méthode nécessite l'autorisation.

Description​

Cette méthode calcule et prévisualise une commande - y compris les totaux des produits, les remises appliquées et le montant final - sans réellement créer la commande dans le système. Elle renvoie une promesse qui se résout en un objet IPreviewOrderEntity.

Orders.previewOrder(

body*, langCode

);

Schéma des paramètres​

Schéma

body(obligatoire): ICreateOrderPreview
Corps de l'aperçu de la commande

body.products: IPreviewOrderProduct[]
Tableau de produits à prévisualiser.

products.productId: number
Identifiant du produit.
exemple : 1

products.quantity: number
Quantité du produit.
exemple : 2

body.couponCode: string
Code de coupon à appliquer.

body.additionalDiscountsMarkers: string[]
Tableau de marqueurs de remises supplémentaires.

body.bonusAmount: number
Montant du bonus à appliquer.

langCode: string
Code de langue. Par défaut : "en_US"
exemple : "en_US"

Exemples​

Exemple minimal​


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

Exemple de réponse​

{
  "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
    }
  ]
}

Schéma de réponse​

Schéma : IOrderPreviewResponse

totalSum: number
Montant total de la commande avant remises.
exemple : 300

totalSumWithDiscount: number
Montant total de la commande après remises.
exemple : 250

discountConfig: IOrderDiscountConfig
Configuration des remises appliquées à la commande.

discountConfig.bonus: IOrderDiscountBonus | null
Résultat du calcul du bonus, null lorsque les bonus ne sont pas utilisés, ou omis entièrement lorsque la commande n'a pas de contexte de bonus.

discountConfig.coupon: unknown | null
Coupon résolu, ou null lorsque aucun coupon n'est appliqué.

discountConfig.orderDiscounts: unknown[]
Remises au niveau de la commande qui ont été trouvées et appliquées.

discountConfig.productDiscounts: unknown[]
Remises au niveau du produit qui ont été trouvées et appliquées.

discountConfig.settings: IOrderDiscountSettings
Paramètres d'accumulation et de plafond utilisés lors du calcul.

discountConfig.additionalDiscountsMarkers: string[]
Marqueurs de remises supplémentaires demandées par le client (omis dans les réponses d'aperçu).

discountConfig.bonusApplied: number
Montant du bonus appliqué à la commande (omis dans les réponses d'aperçu).
exemple : 0

discountConfig.excludedGiftProductIds: string[]
Identifiants des produits exclus de la sélection de cadeaux (omis dans les réponses d'aperçu).

discountConfig.totalDue: number
Montant total dû après remises et bonus (omis dans les réponses d'aperçu).
exemple : 300

discountConfig.totalRaw: number
Montant total avant remises (omis dans les réponses d'aperçu).
exemple : 300

discountConfig.totalSumWithDiscount: number
Montant total après remises mais avant bonus (omis dans les réponses d'aperçu).
exemple : 300

currency: string
Devise de la commande.
exemple : "USD"

orderPreview: IOrderPreviewItem[]
Tableau d'éléments d'aperçu de commande.

orderPreview.id: number
Identifiant du produit.
exemple : 2954

orderPreview.price: number
Prix unitaire du produit avant remises.
exemple : 51

orderPreview.quantity: number
Quantité du produit.
exemple : 1

orderPreview.discountPrice: number | null
Prix unitaire après remises, ou null lorsque aucune remise ne s'applique.
exemple : null

orderPreview.isGift: boolean
Indique si le produit est livré en tant que cadeau.
exemple : false

bonusApplied: number
Bonus appliqué à la commande.

totalDue: number
Total dû après bonus.