Lewati ke konten utama

getOrdersStorageByMarker

Dapatkan satu objek penyimpanan pesanan berdasarkan penanda. 🔐 Metode ini memerlukan otorisasi.

Deskripsi

Metode ini mengambil satu objek penyimpanan pesanan berdasarkan penanda. Ini mengembalikan sebuah Promise yang menyelesaikan menjadi objek IOrdersEntity.

Pesanan.getOrdersStorageByMarker(

marker*, langCode

);

Skema parameter

Skema

marker(diperlukan): string
Penanda objek pesanan
contoh: "order_storage_1"

langCode: string
Kode bahasa. Default: "en_US"
contoh: "en_US"

Contoh

Contoh minimal

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

Contoh dengan atribut

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

Contoh respons

{
"id": 1,
"localizeInfos": {
"title": "My order"
},
"position": 1,
"identifier": "my_order",
"formIdentifier": "orderForm",
"generalTypeId": 21,
"paymentAccountIdentifiers": [
{
"identifier": "stripe"
},
{
"identifier": "cash"
},
{
"identifier": "paypal"
}
]
}

Skema respons

Skema: IOrdersEntity

id: number
Identifikasi objek.
contoh: 1

localizeInfos: ILocalizeInfo
Nama yang mempertimbangkan lokalisasi.
contoh:

{
"title": "Cash"
}

position: number | null
Posisi dalam penyimpanan pesanan.
contoh: 1

identifier: string
Identifikasi tekstual untuk bidang catatan.
contoh: "order_storage_1"

formIdentifier: string
Identifikasi tekstual untuk formulir yang digunakan oleh penyimpanan pesanan.
contoh: "bar-orders-form"

generalTypeId: number | null
Identifikasi tipe.
contoh: 1

paymentAccountIdentifiers: IPaymentAccountIdentifiers[]
Array identifikasi tekstual dari akun pembayaran yang digunakan oleh penyimpanan pesanan.
contoh:

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

paymentAccountIdentifiers.identifier: string
Identifikasi tekstual dari akun pembayaran.
contoh: "payment-1"