انتقل إلى المحتوى الرئيسي

getAllStatusesByStorageMarker

احصل على جميع حالات الطلبات المتاحة في مخزن الطلبات. 🔐 تتطلب هذه الطريقة التفويض.

الوصف​

يجلب حالات الطلبات المعرَّفة في المخزن ذي العلامة المحددة. يُعيد مصفوفة من كائنات IOrderStatus.

.getAllStatusesByStorageMarker(

, , ,

);

مخطط المعلمات​

المخطط

marker(required): string
علامة مخزن الطلبات.
مثال: "order_storage_1"

langCode: string
رمز اللغة. الافتراضي: langCode المُمرَّر إلى defineOneEntry ("en_US" إذا لم يُمرَّر).
مثال: "en_US"

offset: number
عدد السجلات المراد تخطيها. الافتراضي: 0. يجب ألا يتجاوز offset + limit القيمة 200؛ وتُرفض النافذة الأكبر بالخطأ 400.
مثال: 0

limit: number
الحد الأقصى لعدد السجلات المراد إرجاعها. الافتراضي: 30.
مثال: 30

أمثلة​

مثال بسيط​

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

مثال مع langCode​

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

مثال على الاستجابة​

[
  {
    "id": 9,
    "identifier": "completed-payment",
    "localizeInfos": {
      "title": "Completed"
    },
    "isDefault": false,
    "isCancelFinal": false,
    "isFinalSuccess": true,
    "axis": "payment",
    "position": 1,
    "isUsed": false,
    "isMapped": true
  },
  {
    "id": 7,
    "identifier": "inProgress-payment",
    "localizeInfos": {
      "title": "In progress"
    },
    "isDefault": true,
    "isCancelFinal": false,
    "isFinalSuccess": false,
    "axis": "payment",
    "position": 2,
    "isUsed": true,
    "isMapped": true
  },
  {
    "id": 11,
    "identifier": "expired-payment",
    "localizeInfos": {
      "title": "Expired"
    },
    "isDefault": false,
    "isCancelFinal": false,
    "isFinalSuccess": false,
    "axis": "payment",
    "position": 3,
    "isUsed": false,
    "isMapped": true
  }
]

مخطط الاستجابة​

Schema: IOrderStatus[]

id: number
معرّف الحالة.
مثال: 1

localizeInfos: ILocalizeInfo
البيانات المترجمة للحالة.

identifier: string
علامة الحالة.
مثال: "inProgress-payment"

position: number
موضع الحالة، يُستخدم للفرز.
مثال: 1

isUsed: boolean
ما إذا كانت الحالة قيد الاستخدام.
مثال: true

isDefault: boolean
هل هذه هي الحالة الافتراضية.
مثال: true

axis: string
محور الحالة (خط الأنابيب) الذي تنتمي إليه الحالة.
مثال: "payment"

isCancelFinal: boolean
ما إذا كانت الحالة هي حالة إلغاء نهائية.
مثال: false

isFinalSuccess: boolean
ما إذا كانت الحالة هي حالة نجاح نهائية.
مثال: true

isMapped: boolean
ما إذا كانت الحالة مرتبطة بمحورها.
مثال: true