Récupérer les données sur les tentatives de facturation d’abonnement

Dans les flux de travail qui nécessitent des données sur les tentatives de facturation d’abonnement, vous pouvez utiliser l’action Récupérer les données sur les tentatives de facturation d’abonnement pour récupérer les informations sur les commandes de votre boutique.

Configuration

Champs

L’action Récupérer les données sur les tentatives de facturation d’abonnement contient les champs suivants, qui sont utilisés pour créer la requête :

Champs utilisés dans les actions Récupérer les données.
ChampDescription
Trier les données parRequis. Les paramètres selon lesquels les données renvoyées par la requête de recherche sont triées.
Nombre maximal de résultatsRequis. Le nombre maximal de résultats pouvant être renvoyés par la requête de recherche que vous sélectionnez. Vous pouvez en renvoyer jusqu’à 100 à la fois.
RequêteRequis. Choisissez parmi les requêtes courantes ou sélectionnez Avancé pour créer la vôtre.

Chaîne de requête

Voici un exemple de requête pour obtenir les tentatives de facturation d’abonnement qui ont été créées au cours des trois derniers jours :

created_at:>'{{ createdAt | date_minus: "3 day" }}'

La variable created_at est un filtre disponible sur la requête de tentative de facturation d’abonnement et peut être utilisée pour sélectionner des messages d’erreur spécifiques pour les tentatives de facturation d’abonnement.

Lorsque vous interrogez des données, il est utile de savoir :

  • Liste des filtres de tentatives de facturation d’abonnement disponibles
  • Les requêtes doivent respecter une certaine syntaxe
  • Les valeurs des champs de requête ne sont pas toujours documentées. Dans certains cas, vous pouvez trouver les valeurs en consultant la documentation de l’API. Autrement, vous pouvez souvent trouver les valeurs des champs dans les URL de l’interface administrateur lorsque vous appliquez un filtre. Par exemple, pour trouver certaines valeurs de requête de commande, filtrez la page Commandes dans l’interface administrateur, puis vérifiez l’URL.
  • Vous pouvez exécuter ou tester une requête dans votre boutique à l’aide de l’application Shopify GraphiQL.
  • Faites attention à ce qui se passe si votre requête échoue. Souvent, l’API renvoie tous les résultats (au lieu d’aucun).

Données renvoyées

Toutes les actions Récupérer les données renvoient une liste de 0 à 100 ressources. En fonction de votre cas d’utilisation, vous pouvez utiliser ces données de plusieurs manières :

  • Si vous devez traiter chaque article de la liste individuellement, par exemple pour ajouter une balise à chacun, vous pouvez utiliser l’action Pour chaque.
  • Si vous devez agréger des données, par exemple pour compter le nombre de résultats renvoyés, vous pouvez utiliser les actions Compter ou Somme.
  • Si vous devez utiliser la liste en sortie, par exemple pour envoyer un e-mail contenant tous les articles, vous pouvez utiliser les données renvoyées directement dans les actions ultérieures.

Pour accéder aux données renvoyées dans les étapes qui suivent cette action, utilisez la variable nommée Récupérer les données des tentatives de facturation d’abonnement, qui est une liste de tentatives de facturation d’abonnement. Vous pouvez utiliser cette variable dans les conditions comme dans les actions. Par exemple, vous pouvez envoyer la liste des tentatives de facturation d’abonnement dans une action Envoyer un e-mail interne comme ceci :

{% for getSubscriptionBillingAttemptData_item in getSubscriptionBillingAttemptData %}
  {{getSubscriptionBillingAttemptData_item.errorMessage}}
{% endfor %}

Exemple

Par exemple, un flux de travail est programmé pour s’exécuter tous les dimanches à 9 h. L’action Récupérer les données des tentatives de facturation d’abonnement est utilisée pour collecter les données relatives aux tentatives de facturation d’abonnement créées au cours de la semaine précédente. Si elles contiennent un message d’erreur, envoyez les tentatives de facturation par e-mail.

Référence d’API