previewOrder

معاينة حساب الطلب دون إنشائه. 🔐 تتطلب هذه الطريقة التفويض.

الوصف

تحسب هذه الطريقة وتعرض معاينة لطلب - بما في ذلك إجمالي المنتجات، والخصومات المطبقة، والمجموع النهائي - دون إنشاء الطلب فعليًا في النظام. تعيد Promise التي تحل إلى كائن IPreviewOrderEntity.

Orders.previewOrder(
body*,
body.products,
products.productId,
products.quantity,
body.couponCode,
body.additionalDiscountsMarkers,
langCode
);

مخطط المعلمات

المخطط

body(required): ICreateOrderPreview
نص جسم معاينة الطلب

body.products: IPreviewOrderProduct[]
مصفوفة من المنتجات للمعاينة.

products.productId: number
معرف المنتج.
مثال: 1

products.quantity: number
كمية المنتج.
مثال: 2

body.couponCode: string
رمز القسيمة للتطبيق.

body.additionalDiscountsMarkers: string[]
مصفوفة من علامات الخصم الإضافية.

langCode: string
رمز اللغة. الافتراضي: "en_US"
مثال: "en_US"

أمثلة

مثال بسيط


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

مثال على الاستجابة

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

مخطط الاستجابة

المخطط: IOrderPreviewResponse

totalSum: number
إجمالي مبلغ الطلب قبل الخصومات.
مثال: 300

totalSumWithDiscount: number
إجمالي مبلغ الطلب بعد الخصومات.
مثال: 250

discountConfig: unknown
تكوين الخصم المطبق على الطلب.

currency: string
عملة الطلب.
مثال: "USD"

orderPreview: IOrderPreviewItem[]
مصفوفة من عناصر معاينة الطلب.

previewOrder

الوصف​

مخطط المعلمات​

أمثلة​

مثال بسيط​

مثال على الاستجابة​

مخطط الاستجابة​