Hent data om abonnementskontrakt

I arbeidsflyter som bruker data om abonnementskontrakter, kan du bruke handlingen Hent data om abonnementskontrakt for å hente informasjon om abonnementskontrakter fra butikken.

Konfigurasjon

Felt

Handlingen Hent data om abonnementskontrakt inneholder følgende felt, som brukes til å bygge spørringen:

Felt som brukes i Hent data-handlingene.
FeltBeskrivelse
Sorter data etterObligatorisk. Parametrene som dataene som returneres av søket sorteres etter.
Maksimalt antall resultaterObligatorisk. Det maksimale antallet resultater som kan returneres av søket du velger. Du kan returnere opptil 100 om gangen.
SpørringObligatorisk. Velg fra vanlige spørringer, eller velg Avansert for å opprette din egen.

Spørringsstreng

Dette er et eksempel på en spørring for å hente abonnementskontrakter med statusen ACTIVE:

status: ACTIVE

status-variabelen er et filter som er tilgjengelig i spørringen for abonnementskontrakter, og kan brukes flere ganger.

Når du spør etter data, er det nyttig å vite:

  • Liste over tilgjengelige filtre
  • Spørringer må følge en bestemt syntaks
  • Spørringsfeltverdier er ikke alltid dokumentert. I noen tilfeller kan verdiene finnes ved å se i API-dokumentasjonen. Alternativt kan du ofte finne feltverdiene i URL-adressene i administratorpanelet når du filtrerer. For å finne noen spørringsverdier for bestillinger, kan du for eksempel filtrere Ordre-siden i administratorpanelet og deretter sjekke URL-adressen.
  • Du kan kjøre eller teste en spørring i butikken ved hjelp av Shopify GraphiQL-appen.
  • Vær oppmerksom på hva som skjer hvis spørringen mislykkes. Ofte vil API-et returnere alle resultater (i stedet for ingen).

Returnerte data

Alle Hent data-handlinger returnerer en liste med alt fra 0 til 100 ressurser. Avhengig av bruksområdet ditt, kan det hende du vil bruke disse dataene på ulike måter:

  • Hvis du må håndtere hvert listeelement individuelt, for eksempel for å legge til en tagg for hvert av dem, kan du bruke For hver-handlingen.
  • Hvis du må aggregere data, for eksempel for å telle hvor mange resultater som ble returnert, kan du bruke handlingene Tell eller Summer.
  • Hvis du trenger å sende listen som utdata, for eksempel i en e-post med alle varene, kan du bruke de returnerte dataene direkte i påfølgende handlinger.

For å få tilgang til de returnerte dataene i trinn som følger denne handlingen, kan du bruke variabelen Hent data om abonnementskontakt, som er en liste over abonnementskontrakter. Du kan bruke denne variabelen i både betingelser og handlinger. Du kan for eksempel sende listen over bestillinger i en Send intern e-post-handling slik som dette:

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

Utløsere

Du kan bruke denne handlingen i alle arbeidsflyter, inkludert utløseren Planlagt tidspunkt. I en arbeidsflyt som bruker utløseren Planlagt tidspunkt, starter arbeidsflyten på et tidspunkt du har angitt, i stedet for som et resultat av en hendelse. Fordi det ikke er noen spesifikk hendelse i butikken eller fra en app som starter arbeidsflyten, inkluderes ingen data automatisk.

API-referanse