Aller au contenu principal

getAllSubscriptions

Cette méthode renvoie toutes les abonnements aux produits. 🔐 Cette méthode nécessite une autorisation.

Description​

Elle renvoie une promesse qui se résout en un objet ISubscriptions.

.getAllSubscriptions(

,

);

Schéma des paramètres​

Schéma

offset: number
Paramètre de pagination, par défaut 0
exemple : 0

limit: number
Paramètre de pagination, par défaut 30
exemple : 30

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 (ouvre dans un nouvel onglet) selon vos besoins dans la section correspondante.*

Exemples​

Exemple minimal​

const response = await Events.getAllSubscriptions();

Exemple avec des attributs​

const response = await Events.getAllSubscriptions(0, 30);

Exemple de réponse​

{
  "total": 100,
  "items": [
    {
      "eventMarker": "string",
      "productId": 0
    }
  ]
}

Schéma de réponse​

Schéma : ISubscriptions

total: number
Nombre total d'enregistrements trouvés

items: ISubscriptionItem[]
Marqueur d'événement

items.eventMarker: string
Marqueur d'événement

items.productId number
Identifiant du produit