Lewati ke konten utama

getAllStatusesByStorageMarker

Mengambil semua status pesanan yang tersedia untuk penyimpanan pesanan tertentu berdasarkan penandanya.

Deskripsi

Metode ini mengambil semua objek status pesanan yang terkait dengan penyimpanan pesanan tertentu, yang diidentifikasi oleh penanda tekstualnya. Ini mengembalikan sebuah Promise yang menyelesaikan menjadi array objek IOrderStatusEntity.

Pesanan.getAllStatusesByStorageMarker(

marker*, langCode, offset, limit

);

Skema parameter

Skema

marker(required): string
Pengidentifikasi tekstual dari objek penyimpanan pesanan
contoh: "order_storage_1"

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

offset: number
Parameter offset. Default: 0
contoh: 0

limit: number
Parameter limit. Default: 30
contoh: 30

Contoh

Contoh minimal

const response = await Orders.getAllStatusesByStorageMarker('my_order');

Contoh dengan atribut

const response = await Orders.getAllStatusesByStorageMarker('my_order', 'en_US');

Contoh respons

[
{
"id": 4,
"identifier": "waiting",
"localizeInfos": {
"title": "Waiting"
},
"isDefault": false,
"position": 1,
"isUsed": false
},
{
"id": 2,
"identifier": "inProgress",
"localizeInfos": {
"title": "In progress"
},
"isDefault": true,
"position": 2,
"isUsed": true
},
{
"id": 1,
"identifier": "completed",
"localizeInfos": {
"title": "Completed"
},
"isDefault": false,
"position": 3,
"isUsed": false
},
"..."
]

Skema respons

Skema: IOrderStatusEntity[]

id: number
Pengidentifikasi status.
contoh: 1

localizeInfos: ILocalizeInfo
Informasi terlokalisasi untuk status.

identifier: string
Pengidentifikasi tekstual dari status.
contoh: "inProgress"

position: number
Posisi dari status.
contoh: 1

isUsed: boolean
Apakah status sedang digunakan.
contoh: true

isDefault: boolean
Apakah status adalah status default.
contoh: true