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*, body.products, products.productId, products.quantity, body.couponCode, body.additionalDiscountsMarkers, 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 remise supplémentaires.

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

Exemple de réponse​

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

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: unknown
Configuration de remise appliquée à la commande.

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

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