getAllDiscounts

Récupérer tous les objets de réduction.

Description

Cette méthode récupère des objets de réduction avec pagination et un filtre de type optionnel. Elle renvoie une Promesse qui se résout en un objet IDiscountsResponse contenant des éléments et un total.

Discounts.getAllDiscounts(

langCode, offset, limit, type

);

Schéma des paramètres

Schéma

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

offset: number
Paramètre optionnel pour la pagination. Par défaut : 0
exemple : 0

limit: number
Paramètre optionnel pour la pagination. Par défaut : 30
exemple : 30

type: IDiscountType
Paramètre optionnel pour filtrer les réductions par type

Par défaut, vous pouvez récupérer 10 objets. Cela est dû à la limite d'enregistrement dans les paramètres de permissions du module.
Pour que la pagination fonctionne correctement, vous devez configurer Permissions du module selon vos besoins dans la section correspondante.

Exemples

Exemple minimal

const response = await Discounts.getAllDiscounts();

Exemple avec des attributs

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 : IDiscountEntity[]

items: IDiscountsEntity[]
Tableau des entités de réduction.

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

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

items.localizeInfos: ILocalizeInfo
Le nom de la réduction.

items.version: number
La version de la réduction.

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

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

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

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

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

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

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

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

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

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

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

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

items.attributeValues: IAttributeValues
Les valeurs des attributs de la réduction.

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

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

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

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

total: number
Nombre total de réductions.

---