Ana içeriğe geç

getAllDiscounts

Tüm indirim nesnelerini alma.

Açıklama

Bu yöntem, tüm indirim nesnelerini alır. Yöntem, isteğin gövdesine varsayılan dili ekleyecektir. Dili değiştirmek isterseniz, sadece ilk argüman olarak geçirin. Bir dizi IDiscountEntity nesnesine çözülen bir Promise döner.

İndirimler.getAllDiscounts(

langCode, offset, limit, type

);

Parametreler şeması

Şema

langCode: string
Dil kodu. Varsayılan: "en_US"
örnek: "en_US"

offset: number
Sayfalandırma için isteğe bağlı parametre. Varsayılan: 0
örnek: 0

limit: number
Sayfalandırma için isteğe bağlı parametre. Varsayılan: 30
örnek: 30

type: IDiscountType
İndirimleri türüne göre filtrelemek için isteğe bağlı parametre

Varsayılan olarak, 10 nesne alabilirsiniz. Bu, modülün izin ayarlarındaki kayıt limitinden kaynaklanmaktadır.
Sayfalandırmanın doğru çalışması için, ihtiyaçlarınıza göre Modül izinlerini ilgili bölümde yapılandırmanız gerekir.

Örnekler

Minimal örnek

const response = await Discounts.getAllDiscounts();

Özelliklerle örnek

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

Örnek yanıt

{
"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
}

Yanıt şeması

Şema: IDiscountEntity[]

items: IDiscountsEntity[]
İndirim varlıkları dizisi.

items.id: number
İndirimin benzersiz tanımlayıcısı.

items.attributeSetId: number
İndirimin tanımlayıcısı.

items.localizeInfos: ILocalizeInfo
İndirimin adı.

items.version: number
İndirimin versiyonu.

items.identifier: string
İndirimin tanımlayıcısı.

items.type: IDiscountType
İndirimin türü.

items.startDate: string
İndirimin başlangıç tarihi.

items.endDate: string
İndirimin bitiş tarihi.

items.discountValue: IDiscountValue
İndirimin değeri, türü ve miktar limitleri dahil.

discountValue.applicability: 'TO_PRODUCT' | 'TO_ORDER'
İndirimin hangi şeye uygulandığı.
örnek: "TO_PRODUCT"

discountValue.discountType: 'FIXED_AMOUNT' | 'PERCENT'
İndirim değerinin nasıl yorumlandığı.
örnek: "FIXED_AMOUNT"

discountValue.value: number
İndirim miktarı (FIXED_AMOUNT için para birimi birimleri, PERCENT için yüzde noktaları).
örnek: 10

discountValue.maxAmount: number
Uygulanan mutlak indirim için isteğe bağlı üst sınır.
örnek: 5

items.conditionLogic: string
İndirimin mantığı. Olası değerler "AND" | "OR".

items.conditions: IDiscountCondition[]
İndirimin koşulları.

conditions.type: string
İndirim koşulunun türü.

conditions.value: string
İndirim koşuluyla ilişkili değer.

items.exclusions: Record<string, unknown> | null
İndirimin hariç tutmaları.

items.gifts: Record<string, unknown> | null
İndirimin hediyeleri.

items.giftsReplaceCartItems: boolean
Hediyelerin sepet öğelerini değiştirip değiştirmediği.

items.userGroups: Record<string, unknown> | null
İndirimin kullanıcı grupları.

items.userExclusions: Record<string, unknown> | null
İndirimin kullanıcı hariç tutmaları.

items.attributeValues: IAttributeValues
İndirimin özellik değerleri.

items.attributeSetIdentifier: string
Özellik setinin tanımlayıcısı.

items.bonusEvent: Record<string, unknown>
Bonus etkinlik yapılandırması.

items.position: number
Sıralama için pozisyon numarası.
örnek: 1

items.total: number | string
İlgili girişlerin toplam sayısı.
örnek: "1"

total: number
İndirimlerin toplam sayısı.