Nhảy đến nội dung

getOrderByMarker

Lấy một đối tượng lưu trữ đơn hàng theo marker. 🔐 Phương thức này yêu cầu ủy quyền.

Mô tả

Phương thức này lấy một đối tượng lưu trữ đơn hàng theo marker. Nó trả về một Promise mà khi hoàn thành sẽ trả về một đối tượng IOrdersEntity.

Orders.getOrderByMarker(

marker, langCode

);

Sơ đồ tham số

Sơ đồ

marker(bắt buộc): string
Marker của đối tượng đơn hàng
ví dụ: "order_storage_1"

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

Ví dụ

Ví dụ tối thiểu

const response = await Orders.getOrderByMarker('my-order');

Ví dụ với các thuộc tính

const response = await Orders.getOrderByMarker('my-order', 'en_US');

Ví dụ phản hồi

{
"id": 1,
"localizeInfos": {
"title": "Đơn hàng của tôi"
},
"position": 1,
"identifier": "my_order",
"formIdentifier": "orderForm",
"generalTypeId": 21,
"paymentAccountIdentifiers": [
{
"identifier": "cash"
},
{
"identifier": "stripe"
}
]
}

Sơ đồ phản hồi

Sơ đồ: IOrdersEntity

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

localizeInfos: ILocalizeInfo
Tên theo ngữ cảnh địa phương hóa.
ví dụ:

{
"title": "Tiền mặt"
}

position: number | null
Vị trí trong kho lưu trữ đơn hàng.
ví dụ: 1

identifier: string
Định danh văn bản cho trường bản ghi.
ví dụ: "order_storage_1"

formIdentifier: string
Định danh văn bản cho biểu mẫu được sử dụng bởi kho lưu trữ đơn hàng.
ví dụ: "bar-orders-form"

generalTypeId: number | null
Định danh loại.
ví dụ: 1

paymentAccountIdentifiers: IPaymentAccountIdentifiers[]
Mảng các định danh văn bản của các tài khoản thanh toán được sử dụng bởi kho lưu trữ đơn hàng.
ví dụ:

[
{
"identifier": "payment-1"
}
]