getDiscountByMarker

Mendapatkan objek diskon tunggal berdasarkan pengidentifikasi tekstualnya (marker).

Deskripsi

Metode ini mengambil objek diskon tunggal berdasarkan pengidentifikasi tekstualnya (marker). Ini mengembalikan sebuah Promise yang menyelesaikan menjadi objek IDiscountsEntity.

Diskon.getDiscountByMarker(

marker*, langCode

);

Skema parameter

Skema

marker(diperlukan): string
Pengidentifikasi tekstual dari objek penyimpanan diskon
contoh: "discount_storage"

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

Contoh

Contoh minimal

const response = await Discounts.getDiscountByMarker('summer_sale');

Contoh dengan atribut

const response = await Discounts.getDiscountByMarker('summer_sale', 'en_US');

Contoh respons

{
  "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,
  "total": "1",
  "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
}

Skema respons

Skema: IDiscountsEntity

id: number
Pengidentifikasi unik dari diskon.

attributeSetId: number | null
Pengidentifikasi dari set atribut yang terhubung dengan diskon, atau null ketika tidak ada set yang terhubung.

localizeInfos: ILocalizeInfo
Nama dari diskon.

version: number
Versi dari diskon.

identifier: string
Pengidentifikasi dari diskon.

type: IDiscountType
Tipe dari diskon.

startDate: string
Tanggal mulai dari diskon.

endDate: string
Tanggal akhir dari diskon.

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

discountValue.applicability: 'TO_PRODUCT' | 'TO_ORDER'
Apa yang diterapkan diskon tersebut.
contoh: "TO_PRODUCT"

discountValue.discountType: 'FIXED_AMOUNT' | 'PERCENT'
Bagaimana nilai diskon diinterpretasikan.
contoh: "FIXED_AMOUNT"

discountValue.value: number
Jumlah diskon (unit mata uang untuk FIXED_AMOUNT, poin persentase untuk PERCENT).
contoh: 10

discountValue.maxAmount: number | null
Batas maksimum diskon yang diterapkan, atau null ketika tidak ada batas.
contoh: 5

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

conditions: IDiscountCondition[]
Kondisi dari diskon.

conditions.type: string
Tipe kondisi diskon.

conditions.value: string
Nilai yang terkait dengan kondisi diskon.

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

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

giftsReplaceCartItems: boolean
Apakah hadiah menggantikan item keranjang.

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

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

attributeValues: IAttributeValues
Nilai atribut dari diskon.

attributeSetIdentifier: string
Pengidentifikasi dari set atribut.

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

position: number
Nomor posisi untuk pengurutan.
contoh: 1

total: number | string
Jumlah total entri terkait.
contoh: "1"

distance: number
Jarak kosinus ke kueri. Hanya dikembalikan oleh endpoint pencarian semantik (vektor) ketika debug: true diteruskan dalam body pencarian.
contoh: 0.12

---