getAllDiscounts

الحصول على جميع كائنات الخصم.

الوصف

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

الخصومات.getAllDiscounts(

langCode, offset, limit, type

);

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

المخطط

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

offset: number
وسيط اختياري للتصفح. الافتراضي: 0
مثال: 0

limit: number
وسيط اختياري للتصفح. الافتراضي: 30
مثال: 30

type: IDiscountType
وسيط اختياري لتصفية الخصومات حسب النوع

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

أمثلة

مثال بسيط

const response = await Discounts.getAllDiscounts();

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

const response = await Discounts.getAllDiscounts('en_US', 0, 30);

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

{
  "items": [
    {
      "id": 1,
      "type": "DISCOUNT",
      "attributeSetId": 31,
      "conditionLogic": "AND",
      "discountValue": {
        "value": 10,
        "maxAmount": 5,
        "discountType": "FIXED_AMOUNT",
        "applicability": "TO_PRODUCT"
      },
      "exclusions": null,
      "gifts": null,
      "giftsReplaceCartItems": false,
      "userGroups": null,
      "userExclusions": null,
      "localizeInfos": {
        "title": "Example discount"
      },
      "version": 0,
      "identifier": "example_discount",
      "startDate": "2026-03-14T14:55:19.928Z",
      "endDate": "2026-07-31T13:55:24.647Z",
      "attributeValues": {
        "example_discount": {
          "type": "string",
          "value": "test value",
          "isIcon": false,
          "position": 0,
          "additionalFields": {},
          "isProductPreview": false
        }
      },
      "conditions": [],
      "bonusEvent": null,
      "position": 1
    }
  ],
  "total": 1
}

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

المخطط: IDiscountEntity[]

items: IDiscountsEntity[]
مصفوفة من كائنات الخصم.

items.id: number
المعرف الفريد للخصم.

items.attributeSetId: number
معرف الخصم.

items.localizeInfos: ILocalizeInfo
اسم الخصم.

items.version: number
إصدار الخصم.

items.identifier: string
معرف الخصم.

items.type: IDiscountType
نوع الخصم.

items.startDate: string
تاريخ بدء الخصم.

items.endDate: string
تاريخ انتهاء الخصم.

items.discountValue: IDiscountValue
قيمة الخصم، بما في ذلك نوعه وحدود المبلغ.

discountValue.applicability: 'TO_PRODUCT' | 'TO_ORDER'
ما ينطبق عليه الخصم.
مثال: "TO_PRODUCT"

discountValue.discountType: 'FIXED_AMOUNT' | 'PERCENT'
كيف يتم تفسير قيمة الخصم.
مثال: "FIXED_AMOUNT"

discountValue.value: number
مبلغ الخصم (وحدات العملة لـ FIXED_AMOUNT، نقاط النسبة المئوية لـ PERCENT).
مثال: 10

discountValue.maxAmount: number
حد اختياري على الخصم المطلق المطبق.
مثال: 5

items.conditionLogic: string
منطق الخصم. القيم الممكنة هي "AND" | "OR".

items.conditions: IDiscountCondition[]
شروط الخصم.

conditions.type: string
نوع شرط الخصم.

conditions.value: string
القيمة المرتبطة بشرط الخصم.

items.exclusions: Record<string, unknown> | null
استثناءات الخصم.

items.gifts: Record<string, unknown> | null
الهدايا المرتبطة بالخصم.

items.giftsReplaceCartItems: boolean
ما إذا كانت الهدايا تحل محل عناصر السلة.

items.userGroups: Record<string, unknown> | null
مجموعات المستخدمين المرتبطة بالخصم.

items.userExclusions: Record<string, unknown> | null
استثناءات المستخدمين المرتبطة بالخصم.

items.attributeValues: IAttributeValues
قيم السمات المرتبطة بالخصم.

items.attributeSetIdentifier: string
معرف مجموعة السمات.

items.bonusEvent: Record<string, unknown>
تكوين حدث المكافأة.

items.position: number
رقم الموضع للفرز.
مثال: 1

items.total: number | string
إجمالي عدد الإدخالات ذات الصلة.
مثال: "1"

total: number
إجمالي عدد الخصومات.

---