getAllDiscounts

Mengambil semua objek diskon.

Deskripsi

Metode ini mengambil objek diskon dengan paginasi dan filter tipe opsional. Ini mengembalikan Promise yang menyelesaikan menjadi objek IDiscountsResponse yang berisi item dan total jumlah.

Diskon.getAllDiscounts(

langCode, offset, limit, type

);

Skema parameter

Skema

langCode: string
Kode bahasa. Default: "en_US"
contoh: "en_US"

offset: number
Parameter opsional untuk paginasi. Default: 0
contoh: 0

limit: number
Parameter opsional untuk paginasi. Default: 30
contoh: 30

type: IDiscountType
Parameter opsional untuk memfilter diskon berdasarkan tipe

Secara default, Anda dapat mengambil 10 objek. Ini disebabkan oleh batasan jumlah catatan dalam pengaturan izin modul.
Agar paginasi berfungsi dengan benar, Anda perlu mengonfigurasi Izin Modul sesuai kebutuhan Anda di bagian yang sesuai.

Contoh

Contoh minimal

const response = await Discounts.getAllDiscounts();

Contoh dengan atribut

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

Contoh respons

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

Skema respons

Skema: IDiscountEntity[]

items: IDiscountsEntity[]
Array dari entitas diskon.

items.id: number
Pengidentifikasi unik dari diskon.

items.attributeSetId: number
Pengidentifikasi dari diskon.

items.localizeInfos: ILocalizeInfo
Nama dari diskon.

items.version: number
Versi dari diskon.

items.identifier: string
Pengidentifikasi dari diskon.

items.type: IDiscountType
Tipe dari diskon.

items.startDate: string
Tanggal mulai dari diskon.

items.endDate: string
Tanggal akhir dari diskon.

items.discountValue: IDiscountValue
Nilai dari diskon, termasuk tipe dan batas jumlahnya.

items.conditionLogic: string
Logika dari diskon. Nilai yang mungkin adalah "AND" | "OR".

items.conditions: IDiscountCondition[]
Kondisi dari diskon.

items.exclusions: Record<string, unknown> | null
Pengecualian dari diskon.

items.gifts: Record<string, unknown> | null
Hadiah dari diskon.

items.giftsReplaceCartItems: boolean
Apakah hadiah menggantikan item keranjang.

items.userGroups: Record<string, unknown> | null
Grup pengguna dari diskon.

items.userExclusions: Record<string, unknown> | null
Pengecualian pengguna dari diskon.

items.attributeValues: IAttributeValues
Nilai atribut dari diskon.

items.attributeSetIdentifier: string
Pengidentifikasi dari set atribut.

items.bonusEvent: Record<string, unknown>
Konfigurasi acara bonus.

items.position: number
Nomor posisi untuk pengurutan.
contoh: 1

items.total: number | string
Total jumlah entri terkait.
contoh: "1"

total: number
Total jumlah diskon.

---