Obtenir les données des tentatives de facturation d’abonnement

Dans les flux de travail qui nécessitent les données des tentatives de facturation d’abonnement, vous pouvez utiliser l’action Get subscription billing attempt data (Obtenir les données des tentatives de facturation d’abonnement) pour récupérer les informations des commandes de votre boutique.

Configuration

Champs

L’action Get subscription billing attempt data (Obtenir les données des 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 « Obtenir des données ».
ChampDescription
Trier les données parObligatoire. Paramètres selon lesquels les données renvoyées par la requête de recherche sont triées.
Nombre maximum de résultatsObligatoire. La quantité maximale de résultats qui peut être renvoyée par la requête de recherche que vous sélectionnez. Vous pouvez en retourner jusqu’à 100 à la fois.
RequêteObligatoire. Choisissez parmi les requêtes courantes ou sélectionnez Avancée pour créer les vôtres.

Chaîne de requête

Il s’agit d’un exemple de requête permettant d’obtenir les tentatives de facturation d’abonnement créées au cours des trois jours précédents :

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

La variable created_at est un filtre disponible sur la requête des tentatives de facturation d’abonnement. Vous pouvez l’utiliser pour sélectionner un message d’erreur spécifique relatif aux tentatives de facturation d’abonnement.

Lorsque vous requerrez des données, il est utile de connaître ce qui suit :

  • Liste des filtres de tentatives de facturation d’abonnement disponibles - Les requêtes doivent suivre une certaine syntaxe
  • Les noms de champs pour toutes les requêtes se trouvent dans les documents des développeurs pour l’objet QueryRoot.
  • Les valeurs des champs de requête ne sont pas toujours documentées. Dans certains cas, les valeurs peuvent être trouvées en regardant les documents de l’API. Vous pouvez aussi souvent trouver les valeurs de champ dans les URL de l’interface administrateur lorsque vous filtrez. Par exemple, pour trouver des 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 GraphiQL de Shopify.
  • Sachez ce qui se produira si votre requête échoue. Souvent, l’API retournera tous les résultats (au lieu d’aucun).

Données renvoyées

Toutes les actions Obtenir des données renvoient une liste entre 0 et 100 ressource. Selon l’usage que vous en faites, vous voudrez peut-être utiliser ces données de différentes manières :

  • Si vous devez gérer chaque article de la liste individuellement, par exemple pour ajouter une balise à chacun, vous pouvez utiliser l’action Pour chacun.
  • Si vous devez agréger les données, telles que le nombre de résultats retournés, vous pouvez utiliser les actions Quantité ou Somme.
  • Si vous avez besoin d’une liste de sorties, comme envoyer un e-mail avec tous les articles, vous pouvez utiliser les données renvoyées directement dans les actions suivantes.

Pour accéder aux données renvoyées dans les étapes qui suivent cette action, utilisez la variable appelée Get subscription billing attempt data (Obtenir les données des tentatives de facturation d’abonnement), qui est une liste de tentatives de facturation d’abonnement. Vous pouvez utiliser cette variable à la fois dans les conditions et dans les actions. Par exemple, vous pouvez envoyer la liste des tentatives de facturation d’abonnement dans une action Send internal email (Envoyer un e-mail interne) comme celle-ci :

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

Exemple

Par exemple, l’exécution d’un flux de travail est programmée pour avoir lieu tous les dimanches à 9 heures. L’action Get subscription billing attempt data (Obtenir les données des tentatives de facturation d’abonnement) est utilisée pour recueillir les données des tentatives de facturation d’abonnement créées au cours de la semaine précédente. Si celles-ci comportent un message d’erreur, envoyez un e-mail aux tentatives de facturation.

Référence de l’API

Vous ne trouvez pas les réponses que vous recherchez ? Nous sommes là pour vous aider.