updateOrderByMarkerAndId

Sửa đổi đơn hàng trong kho đơn hàng. 🔐 Phương thức này yêu cầu ủy quyền.

Mô tả

Phương thức này cập nhật một đối tượng kho đơn hàng theo marker. Phương thức sẽ thêm ngôn ngữ mặc định vào thân yêu cầu. Nếu bạn muốn thay đổi ngôn ngữ, chỉ cần truyền nó với tham số thứ hai. Nó trả về một Promise mà khi hoàn thành sẽ trả về một đối tượng IBaseOrdersEntity.

Orders.updateOrderByMarkerAndId(

marker*, id*, body*, body.formIdentifier*, body.paymentAccountIdentifier*, body.formData*, formData.marker*, formData.type*, formData.value*, body.products*, products.productId*, products.quantity*, body.couponCode, body.additionalDiscountsMarkers, body.bonusAmount, langCode

);

Sơ đồ tham số

Sơ đồ

marker(bắt buộc): string
Định danh văn bản của đối tượng kho đơn hàng
ví dụ: "order_storage_1"

id(bắt buộc): number
ID của đối tượng đơn hàng
ví dụ: 12345

body(bắt buộc): IOrderData
Đối tượng để cập nhật một đơn hàng
ví dụ:

{
  "formIdentifier": "bar-orders-form",
  "paymentAccountIdentifier": "usd-payment",
  "formData": {
    "marker": "name_1",
    "value": "Name",
    "type": "string"
  },
  "products": [
    {
      "productId": 1,
      "quantity": 2
    }
  ],
  "currency": "USD"
}

body.formIdentifier(bắt buộc): string
Định danh văn bản của đối tượng biểu mẫu liên kết với kho đơn hàng.
ví dụ: "bar-orders-form"

body.paymentAccountIdentifier(bắt buộc): string
Định danh văn bản của đối tượng thanh toán liên kết với kho đơn hàng.
ví dụ: "payment-1"

body.formData(bắt buộc): IOrdersFormData | IOrdersFormData[]
Dữ liệu biểu mẫu liên kết với kho đơn hàng.
ví dụ:

[
  {
    "marker": "name_1",
    "value": "Name",
    "type": "string"
  }
]

formData.marker(bắt buộc): string
Marker của trường biểu mẫu.
ví dụ: "name_1"

formData.type(bắt buộc): string
Loại giá trị.
ví dụ: "string"

formData.value(bắt buộc): string
Giá trị.
ví dụ: "Name"

body.products(bắt buộc): IOrderProductData[]
Một mảng các sản phẩm đã đặt hàng.
ví dụ: []

products.productId(bắt buộc): number
Định danh sản phẩm.
ví dụ: 1

products.quantity(bắt buộc): number
Số lượng sản phẩm.
ví dụ: 2

body.couponCode: string
Mã coupon.

body.additionalDiscountsMarkers: string[]
Mảng các marker giảm giá bổ sung.

body.bonusAmount: number
Số tiền thưởng để áp dụng.

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": 2,
      "quantity": 2
    }
  ]
};
const response = await Orders.updateOrderByMarkerAndId("my-order", 1, body);

Ví dụ phản hồi

{
  "id": 55,
  "formIdentifier": "orderForm",
  "paymentAccountIdentifier": "cash",
  "formData": [
    {
      "marker": "order_name",
      "value": "Ivan",
      "type": "string"
    }
  ],
  "products": [
    {
      "productId": 2957,
      "quantity": 2
    }
  ],
  "currency": "",
  "totalSum": 300,
  "bonusApplied": 0,
  "totalDue": 300,
  "discountConfig": {
    "orderDiscounts": [],
    "productDiscounts": [],
    "coupon": null,
    "settings": {
      "allowStacking": false,
      "maxDiscountValue": null,
      "allowGiftStacking": false,
      "maxBonusPaymentPercent": null,
      "minBonusAmount": null,
      "minOrderAmountForBonus": null,
      "giftRefundPolicy": "KEEP_GIFT"
    },
    "additionalDiscountsMarkers": [],
    "totalRaw": 300,
    "totalSumWithDiscount": 300,
    "excludedGiftProductIds": [],
    "bonus": null,
    "bonusApplied": 0,
    "totalDue": 300
  }
}

Sơ đồ phản hồi

Sơ đồ: IBaseOrdersEntity

id: number
Định danh đối tượng.
ví dụ: 1

formIdentifier: string
Định danh văn bản của biểu mẫu.
ví dụ: "bar-orders-form"

paymentAccountIdentifier: string
Định danh văn bản của thanh toán đơn hàng.
ví dụ: "payment-1"

formData: IOrdersFormData[]
Dữ liệu được gửi bởi biểu mẫu liên kết với kho đơn hàng.
ví dụ:

[
  {
    "marker": "name_1",
    "value": "Name",
    "type": "string"
  }
]

formData.marker: string
Marker của trường biểu mẫu.
ví dụ: "name_1"

formData.type: string
Loại giá trị.
ví dụ: "string"

formData.value: string
Giá trị.
ví dụ: "Name"

products: IOrderProductsData[]
Mảng các sản phẩm đã được thêm vào đơn hàng.
ví dụ:

[
  {
    "id": 2957,
    "title": "Cosmo",
    "sku": null,
    "previewImage": null,
    "price": 150,
    "quantity": 2
  }
]

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

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

currency: string
Tiền tệ được sử dụng để thanh toán cho đơn hàng.
ví dụ: "USD"

totalSum: number
Tổng số tiền của đơn hàng.
ví dụ: NaN

createdDate: string
Ngày tạo đơn hàng.
ví dụ: "2023-10-01T12:00:00Z"

statusIdentifier: string
Định danh văn bản của trạng thái đơn hàng (nếu không được thiết lập, trạng thái mặc định sẽ được gán).
ví dụ: "status-1"

couponCode: string
**

discountConfig: IOrderDiscountConfig
Cấu hình giảm giá đã được áp dụng cho đơn hàng.

discountConfig.bonus: IOrderDiscountBonus | null
Kết quả tính toán bonus, hoặc null khi không sử dụng bonus.

bonus.availableBalance: number
Số dư bonus của người dùng có sẵn tại thời điểm tính toán.
ví dụ: 0

bonus.bonusApplied: number
Số tiền bonus thực tế đã được áp dụng cho đơn hàng này.
ví dụ: 0

bonus.maxBonusDiscount: number
Số tiền bonus tối đa được phép chi cho đơn hàng này.
ví dụ: 0

bonus.minBonusAmount: number | null
Số dư bonus tối thiểu cần thiết để sử dụng bonus, hoặc null nếu không có ngưỡng.
ví dụ: null

bonus.minOrderAmountForBonus: number | null
Tổng đơn hàng tối thiểu cần thiết để áp dụng bonus, hoặc null nếu không có ngưỡng.
ví dụ: null

discountConfig.coupon: unknown | null
Coupon đã được giải quyết, hoặc null khi không có coupon nào được áp dụng.

discountConfig.orderDiscounts: unknown[]
Giảm giá cấp đơn hàng đã được khớp và áp dụng.

discountConfig.productDiscounts: unknown[]
Giảm giá cấp sản phẩm đã được khớp và áp dụng.

discountConfig.settings: IOrderDiscountSettings
Cài đặt xếp chồng và giới hạn được sử dụng trong quá trình tính toán.

settings.allowGiftStacking: boolean
Liệu có thể kết hợp nhiều giảm giá quà tặng hay không.
ví dụ: false

settings.allowStacking: boolean
Liệu có thể kết hợp nhiều giảm giá không phải quà tặng hay không.
ví dụ: false

settings.maxDiscountValue: number | null
Giới hạn cứng về tổng giá trị giảm giá, hoặc null nếu không có giới hạn.
ví dụ: null

discountConfig.additionalDiscountsMarkers: string[]
Các marker của giảm giá bổ sung được yêu cầu bởi khách hàng (bị bỏ qua trong các phản hồi xem trước).

discountConfig.bonusApplied: number
Số tiền bonus đã được áp dụng cho đơn hàng (bị bỏ qua trong các phản hồi xem trước).
ví dụ: 0

discountConfig.excludedGiftProductIds: string[]
ID sản phẩm bị loại trừ khỏi lựa chọn quà tặng (bị bỏ qua trong các phản hồi xem trước).

discountConfig.totalDue: number
Tổng số tiền phải trả sau khi giảm giá và bonus (bị bỏ qua trong các phản hồi xem trước).
ví dụ: 300

discountConfig.totalRaw: number
Tổng số tiền trước khi giảm giá (bị bỏ qua trong các phản hồi xem trước).
ví dụ: 300

discountConfig.totalSumWithDiscount: number
Tổng số tiền sau khi giảm giá nhưng trước khi áp dụng bonus (bị bỏ qua trong các phản hồi xem trước).
ví dụ: 300

bonusAmount: number
Số tiền bonus đã được áp dụng cho đơn hàng.

bonusApplied: number
Số tiền bonus đã được áp dụng cho đơn hàng.

totalDue: number
Tổng số tiền phải trả sau khi áp dụng bonus.

---