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

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": 1,
"identifier": "inProgress",
"localizeInfos": {
"title": "In Progress"
},
"isDefault": true,
"position": 1
},
{
"id": 2,
"identifier": "completed",
"localizeInfos": {
"title": "Completed"
},
"isDefault": false,
"position": 2
},
{
"id": 3,
"identifier": "cancelled",
"localizeInfos": {
"title": "Cancelled"
},
"isDefault": false,
"position": 3
}
]

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

المخطط: IOrderStatusEntity[]

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

localizeInfos: object
معلومات محلية للحالة.

identifier: string
معرف نصي للحالة.
مثال: "inProgress"

position: Record<string, unknown>
موضع الحالة.

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