サブスクリプションの請求試行データを取得する

サブスクリプションの請求試行データを必要とするワークフローでは、「サブスクリプションの請求試行データを取得」アクションを使用して、ストアから注文情報を取得できます。

構成

フィールド

「サブスクリプションの請求試行データを取得」アクションには、クエリを構築するために使用される以下のフィールドが含まれています。

クエリ文字列

これは、過去 3 日間に作成されたサブスクリプションの請求試行を取得するためのクエリの例です。

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

created_at 変数は、サブスクリプションの請求試行クエリで利用できるフィルターで、サブスクリプションの請求試行に関する特定のエラーメッセージを選択するために使用できます。

データをクエリする際に、以下を知っておくと役立ちます。

• 利用可能なサブスクリプションの請求試行フィルターのリスト
• クエリは特定の構文に従う必要があります。
• クエリフィールドの値は、必ずしもマニュアルに記載されているとは限りません。値は、API ドキュメントで確認できる場合があります。また、管理画面で絞り込みを実行した際に、URL にフィールド値が表示されることもよくあります。たとえば、注文クエリの値をいくつか見つけるには、管理画面の [注文管理] ページで絞り込みを行ってから URL を確認します。
• Shopify GraphiQL アプリを使用すると、ストアでクエリを実行またはテストできます。
• クエリが失敗した場合の挙動にご注意ください。APIは、結果を返さないのではなく、すべての結果を返すことがよくあります。

返されるデータ

すべての「データを取得」アクションは、0～100個のリソースのリストを返します。ユースケースに応じて、このデータをさまざまな方法で使用できます。

• 各アイテムにタグ付けする場合など、リストの各アイテムを個別に処理する必要がある場合は、「For each」アクションを使用できます。
• 返された結果の数をカウントするなど、データを集計する必要がある場合は、「Count」アクションまたは「Sum」アクションを使用できます。
• すべてのアイテムを記載したメールを送信するなど、リストを出力する必要がある場合は、後続のアクションで返されたデータを直接使用できます。

このアクションに続くステップで返されたデータにアクセスするには、「サブスクリプションの請求試行データを取得する」という名前の変数を使用します。これはサブスクリプションの請求試行のリストです。この変数は、条件とアクションの両方で使用できます。たとえば、次のように「内部メールを送信する」アクションでサブスクリプションの請求試行のリストを送信できます。

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

例

たとえば、ワークフローが毎週日曜日の午前9時に実行されるようにスケジュールされているとします。「サブスクリプションの請求試行データを取得する」アクションを使用して、過去1週間に作成されたサブスクリプションの請求試行のデータを収集します。エラーメッセージがある場合は、その請求試行に関する情報をメールで送信します。

APIリファレンス

• サブスクリプションの請求試行リソース
• サブスクリプションの請求試行クエリフィルター