previewOrder

Xem trước một phép tính đơn hàng mà không cần tạo nó. 🔐 Phương pháp này yêu cầu ủy quyền.

Mô tả

Phương pháp này tính toán và xem trước một đơn hàng - bao gồm tổng sản phẩm, các khoản giảm giá đã áp dụng và tổng số cuối cùng - mà không thực sự tạo đơn hàng trong hệ thống. Nó trả về một Promise mà khi hoàn thành sẽ trả về một đối tượng IPreviewOrderEntity.

Orders.previewOrder(

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

);

Sơ đồ tham số

Sơ đồ

body(bắt buộc): ICreateOrderPreview
Nội dung xem trước đơn hàng

body.products: IPreviewOrderProduct[]
Mảng sản phẩm để xem trước.

products.productId: number
Mã định danh sản phẩm.
ví dụ: 1

products.quantity: number
Số lượng sản phẩm.
ví dụ: 2

body.couponCode: string
Mã coupon để áp dụng.

body.additionalDiscountsMarkers: string[]
Mảng các dấu hiệu giảm giá bổ sung.

langCode: string
Mã ngôn ngữ. Mặc định: "en_US"
ví dụ: "en_US"

Ví dụ

Ví dụ tối thiểu

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

Ví dụ phản hồi

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

Sơ đồ phản hồi

Sơ đồ: IOrderPreviewResponse

totalSum: number
Tổng số tiền đơn hàng trước khi giảm giá.
ví dụ: 300

totalSumWithDiscount: number
Tổng số tiền đơn hàng sau khi giảm giá.
ví dụ: 250

discountConfig: unknown
Cấu hình giảm giá áp dụng cho đơn hàng.

currency: string
Tiền tệ của đơn hàng.
ví dụ: "USD"

orderPreview: IOrderPreviewItem[]
Mảng các mục xem trước đơn hàng.

---