createOrder

Tạo một đơn hàng trong kho đơn hàng 🔐 Phương thức này yêu cầu xác thực.

Orders.createOrder(marker, body, langCode)

 const body = {
    "formIdentifier": "orderForm",
    "paymentAccountIdentifier": "cash",
    "formData": {
        "marker": "order_name",
        "value": "Ivan",
        "type": "string"
    },
    "products": [
        {
            "productId": 2,
            "quantity": 2
        }
    ]
}

const value = await Orders.createOrder('my-order', body)

Schema

marker:* string
Định danh văn bản của đối tượng kho đơn hàng
ví dụ: my-order

body:* IOrderData
Đối tượng để tạo một đơn hàng
ví dụ:

langCode: String
Trường ngôn ngữ tùy chọn
ví dụ: en_US

Schema (body)

formIdentifier: 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ụ: bars

paymentAccountIdentifier: 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ụ: payment1

statusIdentifier: string
định danh văn bản của đối tượng trạng thái đơn hàng (nếu không chỉ định, trạng thái mặc định sẽ được gán)
ví dụ: inprogress

formData: FormDataType
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"
  }
]

products Record<string, string | any>[]
mảng các sản phẩm được thêm vào đơn hàng

productId: number
định danh sản phẩm
ví dụ: 12

quantity: number
số lượng sản phẩm
ví dụ: 1

Phương thức này lấy một đối tượng kho đơn hàng theo định danh. 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.

Ví dụ trả về:

{
  "formIdentifier": "bars",
  "paymentAccountIdentifier": "payment1",
  "statusIdentifier": "inprogress",
  "formData": [
      {
        "marker": "marker_1",
        "type": "string",
        "value": "Name"
      }
  ],
  "products": [
    {
      "productId": 1,
      "quantity": 2
    },
    {
      "productId": 2,
      "quantity": 3
    }
  ],
  "createdDate": "2024-06-21T09:42:54.848Z",
  "currency": "USD",
  "totalSum": 345
}

Schema

statusIdentifier: string
định danh văn bản của trạng thái đơn hàng
ví dụ: inprogress

formIdentifier: string
định danh văn bản của trạng thái biểu mẫu
ví dụ: order-form

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

formData FormDataType
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"
  }
]

products Record<string, string | any>[]
mảng các sản phẩm được thêm vào đơn hàng

totalSum string
tổng số tiền của đơn hàng
ví dụ: 12.00

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

createdDate string
ngày khi đơn hàng được tạo
ví dụ: 2023-01-01 12:12