getDiscountByMarker

Obtenir un objet de réduction unique par son identifiant textuel (marqueur).

Description

Cette méthode récupère un objet de réduction unique par son identifiant textuel (marqueur). Elle renvoie une promesse qui se résout en un objet IDiscountEntity.

Réductions.getDiscountByMarker(

marker*, langCode

);

Schéma des paramètres

Schéma

marker(obligatoire): string
Identifiant textuel de l'objet de stockage de réduction
exemple : "discount_storage"

langCode: string
Code de langue. Par défaut : "en_US"
exemple : "en_US"

Exemples

Exemple minimal

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

Exemple avec des attributs

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

Exemple de réponse

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

Schéma de réponse

Schéma : IDiscountsEntity

id: number
L'identifiant unique de la réduction.

attributeSetId: number
L'identifiant de la réduction.

localizeInfos: ILocalizeInfo
Le nom de la réduction.

version: number
La version de la réduction.

identifier: string
L'identifiant de la réduction.

type: IDiscountType
Le type de la réduction.

startDate: string
La date de début de la réduction.

endDate: string
La date de fin de la réduction.

discountValue: IDiscountValue
La valeur de la réduction, y compris son type et ses limites de montant.

discountValue.applicability: 'TO_PRODUCT' | 'TO_ORDER'
À quoi s'applique la réduction.
exemple : "TO_PRODUCT"

discountValue.discountType: 'FIXED_AMOUNT' | 'PERCENT'
Comment la valeur de la réduction est interprétée.
exemple : "FIXED_AMOUNT"

discountValue.value: number
Montant de la réduction (unités monétaires pour FIXED_AMOUNT, points de pourcentage pour PERCENT).
exemple : 10

discountValue.maxAmount: number
Plafond optionnel sur la réduction absolue appliquée.
exemple : 5

conditionLogic: string
La logique de la réduction. Les valeurs possibles sont "AND" | "OR".

conditions: IDiscountCondition[]
Les conditions de la réduction.

conditions.type: string
Le type de condition de réduction.

conditions.value: string
La valeur associée à la condition de réduction.

exclusions: Record<string, unknown> | null
Les exclusions de la réduction.

gifts: Record<string, unknown> | null
Les cadeaux de la réduction.

giftsReplaceCartItems: boolean
Indique si les cadeaux remplacent les articles du panier.

userGroups: Record<string, unknown> | null
Les groupes d'utilisateurs de la réduction.

userExclusions: Record<string, unknown> | null
Les exclusions d'utilisateurs de la réduction.

attributeValues: IAttributeValues
Les valeurs d'attribut de la réduction.

attributeSetIdentifier: string
L'identifiant de l'ensemble d'attributs.

bonusEvent: Record<string, unknown>
Configuration de l'événement bonus.

position: number
Numéro de position pour le tri.
exemple : 1

total: number | string
Nombre total d'entrées associées.
exemple : "1"

---