Nhảy đến nội dung

createOrder

Tạo một đơ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 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.

Orders.createOrder( marker*, body*, 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"

body(bắt buộc): IOrderData
Đối tượng để tạo 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
}
]
}

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"

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"

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

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

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

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

products(bắt buộc): IOrderProductData[]
Mảng các sản phẩm đã đặt hà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.createOrder("my-order", body);

Ví dụ phản hồi

{
"id": 233,
"formIdentifier": "orderForm",
"paymentAccountIdentifier": "cash",
"formData": [
{
"marker": "order_name",
"value": "Ivan",
"type": "string"
}
],
"products": [
{
"productId": 2957,
"quantity": 2
}
],
"currency": "",
"totalSum": 300,
"createdDate": "2025-07-21T09:40:08.552Z"
}

Sơ đồ phản hồi

Sơ đồ: IBaseOrdersEntity

id: number
Định danh của đố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"
}
]

products: IOrderProducts[]
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
}
]

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 đối tượng 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". /