getAllDiscounts

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

Description

Cette méthode récupère tous les objets de réduction. La méthode ajoutera la langue par défaut au corps de la requête. Si vous souhaitez changer la langue, il vous suffit de la passer en premier argument. Elle renvoie une promesse qui se résout en un tableau d'objets IDiscountEntity.

Réductions.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 : string
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 les 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": [],
      "position": 1
    }
  ],
  "total": 1
}

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 : object
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 : string
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 : Record<string, unknown>
La valeur de la réduction.

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

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

items.exclusions : object
Les exclusions de la réduction.

items.gifts : object
Les cadeaux de la réduction.

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

items.userGroups : object
Les groupes d'utilisateurs de la réduction.

items.userExclusions : object
Les exclusions d'utilisateurs de la réduction.

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

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

total : number
Nombre total de réductions.

---