Hent data om faktureringsforsøg for abonnementer

I workflows, der kræver data om faktureringsforsøg for abonnementer, kan du bruge handlingen Hent data om faktureringsforsøg for abonnementer til at hente ordreoplysninger fra din butik.

Konfiguration

Felter

Handlingen Hent data om faktureringsforsøg for abonnementer indeholder følgende felter, som bruges til at opbygge forespørgslen:

Felter, der bruges i handlingerne “Hent data”.
FeltBeskrivelse
Sortér data efterKræves. De parametre, som dataene fra søgeforespørgslen sorteres efter.
Maksimalt antal resultaterKræves. Det maksimale antal resultater, der kan returneres af den søgeforespørgsel, du vælger. Du kan returnere op til 100 ad gangen.
ForespørgselKræves. Vælg mellem almindelige forespørgsler, eller vælg Avanceret for at oprette din egen.

Forespørgselsstreng

Dette er et eksempel på en forespørgsel til at hente faktureringsforsøg for abonnementer, der er blevet oprettet inden for de seneste tre dage:

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

Variablen created_at er et filter, der er tilgængeligt for forespørgslen om faktureringsforsøg for abonnementer, og den kan bruges til at vælge bestemte fejlmeddelelser for faktureringsforsøg for abonnementer.

Når du forespørger om data, er det en hjælp at vide:

  • Liste over tilgængelige filtre for faktureringsforsøg for abonnementer
  • Forespørgsler skal følge en bestemt syntaks
  • Værdier for forespørgselsfelter er ikke altid dokumenteret. I nogle tilfælde kan værdierne findes ved at se i API-dokumentationen. Alternativt kan du ofte finde feltværdierne i webadresserne i din administrator, når du filtrerer. Hvis du f.eks. vil finde nogle forespørgselsværdier for Ordrer, kan du filtrere siden Ordrer i administratoren og derefter tjekke webadressen.
  • Du kan køre eller teste en forespørgsel i din butik ved at bruge Shopify GraphiQL-appen.
  • Vær opmærksom på, hvad der sker, hvis din forespørgsel mislykkes. API'en returnerer ofte alle resultater (i stedet for ingen).

Returnerede data

Alle handlinger af typen Hent data returnerer en liste med mellem 0 og 100 ressourcer. Afhængigt af dit anvendelsesformål kan du bruge disse data på forskellige måder:

  • Hvis du har brug for at håndtere hver enkelt vare på listen individuelt, f.eks. for at tilføje et tag til hver, kan du bruge handlingen For hver.
  • Hvis du har brug for at aggregere data, f.eks. tælle, hvor mange resultater der blev returneret, kan du bruge handlingerne Tæl eller Sum.
  • Hvis du har brug for at udsende listen, f.eks. sende en mail med alle varerne, kan du bruge de returnerede data direkte i efterfølgende handlinger.

Hvis du vil have adgang til de returnerede data i de trin, der følger efter denne handling, skal du bruge variablen med navnet Hent data om faktureringsforsøg for abonnement, som er en liste over faktureringsforsøg for abonnementer. Du kan bruge denne variabel i både betingelser og handlinger. Du kan f.eks. sende listen over faktureringsforsøg for abonnementer i en Send intern mail-handling som denne:

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

Eksempel

Et workflow er f.eks. planlagt til at køre hver søndag kl. 9.00. Handlingen Hent data om faktureringsforsøg for abonnement bruges til at indsamle data for faktureringsforsøg for abonnementer, der er oprettet i løbet af den seneste uge. Hvis de indeholder en fejlmeddelelse, mailes faktureringsforsøgene.

API-reference