getAllDiscounts

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

الوصف

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

Discounts.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
    },
    {
      "id": 2,
      "type": "PERSONAL_DISCOUNT",
      "attributeSetId": null,
      "conditionLogic": "AND",
      "discountValue": {
        "value": 15,
        "maxAmount": null,
        "discountType": "FIXED_AMOUNT",
        "applicability": "TO_ORDER"
      },
      "exclusions": null,
      "gifts": null,
      "giftsReplaceCartItems": false,
      "userGroups": null,
      "userExclusions": null,
      "localizeInfos": {
        "title": "Personal discount"
      },
      "version": 2,
      "identifier": "personal_discount",
      "startDate": "2026-04-21T18:26:19.815Z",
      "endDate": "2028-03-21T19:26:24.741Z",
      "attributeValues": {},
      "conditions": [],
      "bonusEvent": null,
      "position": 2
    }
  ],
  "total": 2
}

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

المخطط: 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
قيمة الخصم، بما في ذلك نوعه وحدود المبلغ.

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

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

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
العدد الإجمالي للخصومات.

---