Ana içeriğe geç

getAllStatusesByStorageMarker

Belirli bir sipariş depolama alanı için mevcut olan tüm sipariş durumlarını almak.

Açıklama

Bu yöntem, belirli bir sipariş depolama alanına bağlı olan tüm sipariş durumu nesnelerini, metinsel işaretleyicisi ile tanımlanmış olarak alır. Bir Promise döndürür ve bu Promise, IOrderStatusEntity nesnelerinden oluşan bir dizi ile çözülür.

Siparişler.getAllStatusesByStorageMarker(

marker*, langCode, offset, limit

);

Parametreler şeması

Şema

marker(zorunlu): string
Sipariş depolama nesnesinin metinsel tanımlayıcısı
örnek: "order_storage_1"

langCode: string
Dil kodu. Varsayılan: "en_US"
örnek: "en_US"

offset: number
Ofset parametresi. Varsayılan: 0
örnek: 0

limit: number
Limit parametresi. Varsayılan: 30
örnek: 30

Örnekler

Minimal örnek

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

Özelliklerle örnek

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

Örnek yanıt

[
{
"id": 1,
"identifier": "paid_for",
"localizeInfos": {
"title": "Paid for"
},
"isDefault": false,
"position": 1,
"isUsed": false
},
{
"id": 2,
"identifier": "inProgress",
"localizeInfos": {
"title": "In progress"
},
"isDefault": true,
"position": 2,
"isUsed": true
}
]

Yanıt şeması

Şema: IOrderStatusEntity[]

id: number
Durum tanımlayıcısı.
örnek: 1

localizeInfos: ILocalizeInfo
Durum için yerelleştirilmiş bilgi.

identifier: string
Durumun metin tanımlayıcısı.
örnek: "inProgress"

position: number
Durumun pozisyonu.
örnek: 1

isUsed: boolean
Durumun kullanılıp kullanılmadığı.
örnek: true

isDefault: boolean
Durumun varsayılan durum olup olmadığı.
örnek: true