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

getAllOrdersStorage

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

الوصف​

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

.getAllOrdersStorage(

, ,

);

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

المخطط

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

offset: number
معامل اختياري للترقيم. الافتراضي: 0
مثال: 0

limit: number
معامل اختياري للترقيم. الافتراضي: 30
مثال: 30

بشكل افتراضي، يمكنك استرجاع 10 كائنات. وذلك بسبب حد السجلات في إعدادات أذونات الوحدة.
لعمل الترقيم بشكل صحيح، تحتاج إلى تكوين أذونات الوحدة وفقًا لاحتياجاتك في القسم المقابل.

أمثلة​

مثال بسيط​

const response = await Orders.getAllOrdersStorage();

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

const response = await Orders.getAllOrdersStorage('en_US', 0, 30);

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

[
{
"id": 1,
"localizeInfos": {
"title": "My order"
},
"position": 1,
"identifier": "my_order",
"formIdentifier": "orderForm",
"generalTypeId": 21,
"paymentAccountIdentifiers": [
{
"identifier": "stripe"
},
{
"identifier": "cash"
},
{
"identifier": "paypal"
}
]
}
]

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

المخطط: IOrdersEntity[]

id: number
معرف الكائن.
مثال: 1

localizeInfos: ILocalizeInfo
الاسم مع مراعاة التوطين.
مثال:

{
"title": "Cash"
}

position: number | null
الموقع في تخزين الطلبات.
مثال: 1

identifier: string
معرف نصي لحقل السجل.
مثال: "order_storage_1"

formIdentifier: string
معرف نصي للنموذج المستخدم من قبل تخزين الطلبات.
مثال: "bar-orders-form"

generalTypeId: number | null
معرف النوع.
مثال: 1

paymentAccountIdentifiers: IPaymentAccountIdentifiers[]
مصفوفة من المعرفات النصية لحسابات الدفع المستخدمة من قبل تخزين الطلبات.
مثال:

[
{
"identifier": "payment-1"
}
]

paymentAccountIdentifiers.identifier: string
معرف نصي لحساب الدفع.
مثال: "payment-1"