Súgó
Bejelentkezés

Előfizetéses számlázási próbálkozás adatainak lekérése

Azokban a munkafolyamatokban, amelyek előfizetéses számlázási próbálkozás adatait igénylik, az Előfizetéses számlázási próbálkozás adatainak lekérése művelettel kérheti le a rendelési adatokat az üzletéből.

Ezen az oldalon

Konfiguráció

Mezők

Az Előfizetéses számlázási próbálkozás adatainak lekérése művelet a következő mezőket tartalmazza, amelyek a lekérdezés összeállítására szolgálnak:

Az Adatok lekérése műveletekben használt mezők.
MezőLeírás
Adatok rendezéseKötelező. A paraméterek, amelyek alapján a keresési lekérdezés által visszaadott adatok rendezve lesznek.
Találatok maximális számaKötelező. A kiválasztott keresési lekérdezés által visszaadható találatok maximális száma. Egyszerre legfeljebb 100-at adhat vissza.
LekérdezésKötelező. Válasszon a gyakori lekérdezések közül, vagy válassza a Speciális lehetőséget saját lekérdezés létrehozásához.

Lekérdezési karakterlánc

Ez egy példa lekérdezés az elmúlt három napban létrehozott előfizetéses számlázási próbálkozások lekérésére:

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

A created_at változó egy szűrő, amely az előfizetéses számlázási próbálkozás lekérdezésén érhető el, és az előfizetéses számlázási próbálkozások adott hibaüzeneteinek kiválasztására használható.

Az adatok lekérdezésekor hasznos tudni a következőket:

  • Az elérhető előfizetéses számlázási próbálkozás szűrők listája
  • A lekérdezéseknek meghatározott szintaxist kell követniük.
  • A lekérdezési mezők értékei nem mindig vannak dokumentálva. Egyes esetekben az értékek az API-dokumentációban találhatók meg. Másik lehetőségként gyakran megtalálhatja a mezőértékeket az adminisztrációs felület URL-jeiben, amikor szűr. Például bizonyos rendelési lekérdezési értékek megkereséséhez szűrjön rá a Rendelések oldalon az adminisztrációs felületen, majd ellenőrizze az URL-t.
  • A lekérdezéseket az üzletében a Shopify GraphiQL alkalmazással futtathatja vagy tesztelheti.
  • Figyeljen arra, mi történik, ha a lekérdezés meghiúsul. Az API gyakran az összes eredményt visszaadja (ahelyett, hogy egyet sem).

Visszaadott adatok

Minden Adatok lekérése művelet egy 0 és 100 közötti erőforrást tartalmazó listát ad vissza. Felhasználási esettől függően ezeket az adatokat különféle módokon használhatja fel:

  • Ha az egyes listaelemeket egyenként kell kezelnie, például hogy mindegyikhez címkét adjon hozzá, akkor használhatja a For each műveletet.
  • Ha adatokat kell összesítenie, például meg kell számolnia a visszaadott eredmények számát, akkor a Count vagy a Sum műveletet használhatja.
  • Ha a lista kiadására van szüksége, például egy e-mailt kell küldenie az összes tétellel, akkor a visszaadott adatokat közvetlenül felhasználhatja a rákövetkező műveletekben.

A műveletet követő lépésekben a visszaadott adatok eléréséhez használja a Get subscription billing attempt data nevű változót, amely a számlázási próbálkozások listája. Ezt a változót feltételekben és műveletekben egyaránt használhatja. Például elküldheti a számlázási próbálkozások listáját egy Belső e-mail küldése műveletben az alábbiak szerint:

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

Példa

Például egy munkafolyamat futtatása minden vasárnap reggel 9:00 órára van ütemezve. Az Előfizetéshez tartozó számlázási próbálkozás adatainak lekérése művelet az elmúlt héten létrehozott számlázási próbálkozások adatait gyűjti össze. Ha ezek hibaüzenetet tartalmaznak, a rendszer e-mailben elküldi azokat.

API-referencia