Dohvati podatke o ugovoru o pretplati

U tijekovima rada koji upotrebljavaju podatke o ugovoru o pretplati možete upotrijebiti radnju Dohvati podatke o ugovoru o pretplati za dohvaćanje informacija o ugovorima o pretplati iz svoje trgovine.

Konfiguracija

Polja

Radnja Dohvati podatke o ugovoru o pretplati sadrži sljedeća polja koja se upotrebljavaju za kreiranje upita:

Polja koja se upotrebljavaju u radnjama za dohvaćanje podataka.
PoljeOpis
Sortiraj podatke poObavezno. Parametri prema kojima se sortiraju podaci vraćeni upitom za pretraživanje.
Maksimalan broj rezultataObavezno. Maksimalan broj rezultata koji odabrani upit za pretraživanje može vratiti. Možete vratiti do 100 rezultata odjednom.
UpitObavezno. Odaberite jedan od uobičajenih upita ili odaberite Napredno da biste izradili vlastiti.

Niz upita

Ovo je primjer upita za dohvaćanje ugovora o pretplati sa statusom ACTIVE:

status: ACTIVE

Varijabla status filtar je dostupan u Upitu o ugovorima o pretplati i može se upotrijebiti više puta.

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

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

Vraćeni podaci

Sve radnje Dohvati podatke vraćaju popis od 0 do 100 resursa. Ovisno o vašem slučaju upotrebe te podatke možda želite 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 ugovoru o pretplati, koja predstavlja popis ugovora o pretplati. Ovu varijablu možete upotrijebiti u uvjetima i u radnjama. Na primjer, možete poslati popis narudžbi u radnji Pošalji internu e-poruku ovako:

{% for single_contract in GetSubscriptionContractData %}
* {{ single_contract.name }}
{% endfor %}

Pokretači

Ovu radnju možete upotrijebiti u svakom tijeku rada, uključujući pokretač Zakazano vrijeme. U tijeku rada koji upotrebljava pokretač Zakazano vrijeme tijek rada pokreće se u vremenu koje ste naveli, a ne kao rezultat nekog događaja. Budući da nema određenog događaja u vašoj trgovini ili iz aplikacije koji bi pokrenuo tijek rada, nikakvi podaci nisu automatski uključeni.

Referenca za API