Aller au contenu principal

getDiscountByMarker

Obtenir une remise par son marqueur.

Description​

Récupère une remise par son marqueur et renvoie un IDiscountsEntity.

.getDiscountByMarker(

,

);

Schéma des paramètres​

Schema

marker(required): string
Marqueur de la réduction.
exemple : "discount_storage"

langCode: string
Code de langue. Par défaut : le langCode passé à defineOneEntry ("en_US" s'il n'y en a pas).
exemple : "en_US"

Exemples​

Exemple minimal​

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

Exemple avec les paramètres facultatifs​

const response = await Discounts.getDiscountByMarker('example_discount', '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
ID de la remise.

attributeSetId: number | null
ID de l'ensemble d'attributs lié à la remise, ou null si aucun ensemble n'est lié.

localizeInfos: ILocalizeInfo
Nom localisé de la remise.

version: number
Numéro de version de la remise.

identifier: string
Marqueur de la remise.

type: IDiscountType
Le type de la remise.

startDate: string
La date de début de la remise.

endDate: string
Date de fin de la remise.

discountValue: IDiscountValue
Valeur de la remise avec son type et ses limites de montant.

discountValue.applicability: 'TO_PRODUCT' | 'TO_ORDER'
Ce à quoi s'applique la remise.
exemple : "TO_PRODUCT"

discountValue.discountType: 'FIXED_AMOUNT' | 'PERCENT'
Mode d'application de la valeur de la remise.
exemple : "FIXED_AMOUNT"

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

discountValue.maxAmount: number | null
Plafond de la remise absolue appliquée, ou null s'il n'y a pas de plafond.
exemple : 5

conditionLogic: string
Combinaison des conditions : AND ou OR.

conditions: IDiscountCondition[]
Conditions de la remise.

conditions.type: string
Le type de condition de la remise.

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

exclusions: Record<string, unknown> | null
Exclusions de la remise.

gifts: Record<string, unknown> | null
Cadeaux de la remise.

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

userGroups: Record<string, unknown> | null
Groupes d'utilisateurs auxquels s'applique la remise.

userExclusions: Record<string, unknown> | null
Utilisateurs exclus de la remise.

attributeValues: IAttributeValues
Valeurs d'attributs de la remise.

attributeSetIdentifier: string
Marqueur de l'ensemble d'attributs.

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

position: number
Position utilisée pour le tri.
exemple : 1

total: number | string
Compteur de lignes interne que l'API renvoie par erreur ("1" pour une réduction unique). Ne vous y fiez pas.
exemple : "1"

distance: number
Distance cosinus à la requête. Renvoyée sur chaque élément par l'endpoint de recherche sémantique (vectorielle).
exemple : 0.12