getAllStatusesByStorageMarker

الحصول على جميع حالات الطلب المتاحة لتخزين طلب معين بواسطة علامته.

الوصف

تسترجع هذه الطريقة جميع كائنات حالة الطلب المرتبطة بتخزين طلب معين، يتم تحديده بواسطة علامته النصية. تعيد وعدًا (Promise) يتم حله إلى مصفوفة من كائنات IOrderStatusEntity.

Orders.getAllStatusesByStorageMarker(

marker*, langCode, offset, limit

);

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

المخطط

marker(required): string
المعرف النصي لكائن تخزين الطلب
مثال: "order_storage_1"

langCode: string
رمز اللغة. الافتراضي: "en_US"
مثال: "en_US"

offset: number
معامل الإزاحة. الافتراضي: 0
مثال: 0

limit: number
معامل الحد. الافتراضي: 30
مثال: 30

أمثلة

مثال بسيط

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

مثال مع السمات

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
  },
  "..."
]

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

المخطط: IOrderStatusEntity[]

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

---