getAllDiscounts

Obtenir toutes les remises.

Description

Récupère les remises avec pagination et un filtre type facultatif. Renvoie un IDiscountsResponse : les remises sont dans items, leur nombre dans total.

.getAllDiscounts(

, , ,

);

Schéma des paramètres

Schéma

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

offset: number
Nombre d'enregistrements à ignorer. Par défaut : 0. offset + limit ne doit pas dépasser 200 ; une fenêtre plus grande est rejetée avec 400.
exemple : 0

limit: number
Nombre maximal d'enregistrements à renvoyer. Par défaut : 30.
exemple : 30

type: IDiscountType
Type de réduction à filtrer : DISCOUNT, BONUS ou PERSONAL_DISCOUNT.

Limite d’enregistrements. Si la permission du groupe d’utilisateurs pour cette méthode n’autorise qu’une lecture restreinte, l’API renvoie au plus le nombre d’enregistrements défini dans les paramètres du projet (10 par défaut), quelle que soit la valeur de limit. Avec un accès complet en lecture, limit fonctionne normalement. Voir Module permissions (ouvre dans un nouvel onglet).

Exemples

Exemple minimal

const response = await Discounts.getAllDiscounts();

Exemple avec des paramètres facultatifs

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

Exemple de réponse

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

Schéma de réponse

Schéma : IDiscountsResponse

items: IDiscountsEntity[]
Remises de cette réponse.

items.id: number
ID de la remise.

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

items.localizeInfos: ILocalizeInfo
Nom localisé de la remise.

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

items.identifier: string
Marqueur de la remise.

items.type: IDiscountType
Le type de la réduction.

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

items.endDate: string
Date de fin de la remise.

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

items.conditionLogic: string
Combinaison des conditions : AND ou OR.

items.conditions: IDiscountCondition[]
Conditions de la remise.

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

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

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

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

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

items.attributeValues: IAttributeValues
Valeurs d'attributs de la remise.

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

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

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

items.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"

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

total: number
Nombre total de réductions.

---