Get subscription billing attempt data

U tijekovima rada koji zahtijevaju podatke o pokušajima naplate pretplate možete upotrijebiti radnju Get subscription billing attempt data za dohvaćanje informacija o narudžbama iz svoje trgovine.

Konfiguracija

Polja

Radnja Get subscription billing attempt data sadrži sljedeća polja koja se upotrebljavaju za izradu upita:

Polja koja se upotrebljavaju u radnjama Get data.
PoljeOpis
Poredaj podatke premaObavezno. Parametri prema kojima se sortiraju podaci koje vraća upit za pretraživanje.
Maksimalan broj rezultataObavezno. Maksimalan broj rezultata koje može vratiti odabrani upit za pretraživanje. Odjednom se može vratiti najviše 100 rezultata.
UpitObavezno. Odaberite jedan od uobičajenih upita ili opciju Napredno da biste izradili vlastiti.

Niz upita

Ovo je primjer upita za dohvaćanje pokušaja naplate pretplate koji su izrađeni u zadnja tri dana:

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

Varijabla created_at predstavlja filtar dostupan u upitu za pokušaj naplate pretplate i može se upotrijebiti za odabir određene poruke o pogrešci kod pokušaja naplate pretplate.

Prilikom slanja upita za podatke korisno je znati sljedeće:

  • Popis dostupnih filtara pokušaja naplate pretplate
  • Upiti moraju slijediti određenu sintaksu
  • Vrijednosti polja upita nisu uvijek dokumentirane. U nekim se slučajevima vrijednosti mogu pronaći pregledom dokumentacije za API. Vrijednosti polja često možete pronaći i u URL-ovima na administratorskoj ploči prilikom filtriranja. Na primjer, da biste pronašli neke vrijednosti upita za narudžbe, filtrirajte stranicu Narudžbe na administratorskoj ploči i zatim provjerite URL.
  • Upit u svojoj trgovini možete pokrenuti ili testirati s pomoću aplikacije Shopify GraphiQL.
  • Pazite na to što se događa ako upit ne uspije. API će često vratiti sve rezultate (umjesto nijednog).

Vraćeni podaci

Sve radnje Get data vraćaju popis od 0 do 100 resursa. Ovisno o slučaju upotrebe, ove podatke možete upotrijebiti na različite načine:

  • Ako svaku stavku s popisa trebate obraditi pojedinačno, primjerice dodati joj oznaku, možete upotrijebiti radnju For each.
  • Ako trebate prikupiti podatke, na primjer prebrojiti vraćene rezultate, možete upotrijebiti radnje Count ili Sum.
  • Ako želite ispisati popis, primjerice poslati e-poruku sa svim stavkama, vraćene podatke možete izravno upotrijebiti u sljedećim radnjama.

Da biste pristupili vraćenim podacima u koracima koji slijede nakon ove radnje, upotrijebite varijablu pod nazivom Dohvati podatke o pokušaju naplate pretplate, koja predstavlja popis pokušaja naplate pretplate. Ovu varijablu možete upotrijebiti u uvjetima i u radnjama. Na primjer, možete poslati popis pokušaja naplate pretplate u radnji Pošalji internu e-poruku ovako:

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

Primjer

Na primjer, zakazano je pokretanje tijeka rada svake nedjelje u 9:00. Radnja Dohvati podatke o pokušaju naplate pretplate upotrebljava se za prikupljanje podataka o pokušajima naplate pretplate izrađenima u zadnjem tjednu. Ako sadrže poruku o pogrešci, pokušaji naplate šalju se e-poštom.

Referenca za API