getAllOrdersStorage

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

الوصف

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

Orders.getAllOrdersStorage(

langCode, offset, limit

);

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

المخطط

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": "طلبي"
    },
    "position": 1,
    "identifier": "my_order",
    "formIdentifier": "orderForm",
    "generalTypeId": 21,
    "paymentAccountIdentifiers": [
      {
        "identifier": "cash"
      },
      {
        "identifier": "stripe"
      }
    ]
  }
]

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

المخطط: IOrdersEntity[]

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

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

{
  "title": "نقدي"
}

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

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

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

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

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

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

---