キャッシュフロー追跡セッションのデータを取得する
キャッシュフロー追跡セッションのデータが必要なワークフローでは、「キャッシュフロー追跡セッションのデータを取得する」アクションを使用して、POS Proからキャッシュフロー追跡セッションの情報を取得できます。キャッシュフロー追跡セッションは、ストアのレジにある現金を追跡するために使用されます。
設定
フィールド
「キャッシュフロー追跡セッションのデータを取得する」アクションには、以下のフィールドが含まれています。
| フィールド | 説明 |
|---|---|
| データの並び替え順 | 必須。検索クエリによって返されるデータの並び替え基準となるパラメーターです。 |
| 最大結果数 | 必須。選択した検索クエリで返すことのできる最大結果数です。一度に最大 100件まで返すことができます。 |
| クエリ | 必須。一般的なクエリから選択するか、[高度な設定] を選択して独自のクエリを作成します。 |
クエリ文字列
以下は、過去1日間に終了したキャッシュフロー追跡セッションを取得するためのクエリの例です。
closing_time:<='{{ scheduledAt }}' AND closing_time:>'{{ scheduledAt | date_minus: "1 day" }}'closing_time変数はCashTrackingSessionsクエリで利用できるフィルターで、複数回使用したり、他の変数と組み合わせたりすることができます。scheduledAt Liquid変数は、「Scheduled time (スケジュールされた時間)」トリガーを使用したワークフローで利用できます。date_minus Liquidタグは、日付から時間を減算できるFlowの特別なタグです。
データをクエリする際には、以下を知っておくと役立ちます。
クエリは特定の構文に従う必要があります
クエリフィールドの値は、常にドキュメントに記載されているとは限りません。場合によっては、APIドキュメントで値が見つかることがあります。また、管理画面で絞り込みを行った際に、URLからフィールド値を見つけられる場合もよくあります。たとえば、注文のクエリ値を見つけるには、管理画面で注文管理ページを絞り込み、URLを確認します。
Shopify GraphiQLアプリを使用すると、ストアでクエリを実行またはテストできます。
クエリが失敗した場合に何が起こるかに注意してください。多くの場合、APIは (結果がないのではなく) すべての結果を返します。
返されるデータ
すべての「データを取得する」アクションは、0〜100個のリソースのリストを返します。ユースケースに応じて、このデータをさまざまな方法で使用することができます。
- 各リストアイテムを個別に処理する必要がある場合 (各アイテムにタグを追加するなど)、「For each (繰り返し)」アクションを使用できます。
- 返された結果の数をカウントするなど、データを集計する必要がある場合は、「Count (カウント)」または「Sum (合計)」アクションを使用できます。
- すべてのアイテムを記載したメールを送信するなど、リストを出力する必要がある場合は、後続のアクションで返されたデータを直接使用できます。
このアクションに続くステップで返されたデータにアクセスするには、キャッシュフロー追跡セッションのリストである「Get cash tracking session data (キャッシュフロー追跡セッションのデータを取得する)」という名前の変数を使用します。この変数は、条件とアクションの両方で使用できます。たとえば、次のように「Send internal email (内部メールを送信する)」アクションでキャッシュフロー追跡セッションのリストを送信できます。
{% for single_cash_tracking_session in GetCashTrackingSessionData %}
* {{ single_cash_tracking_session.id }}
{% endfor %}トリガー
このアクションは、「Scheduled time (スケジュールされた時間)」トリガーを含む、あらゆるワークフローで使用できます。「Scheduled time (スケジュールされた時間)」トリガーを使用するワークフローでは、ワークフローはイベントの結果としてではなく、指定した時間に開始されます。ストアやアプリにワークフローを開始させる特定のイベントがないため、データは自動的に含まれません。
APIリファレンス
このアクションで使用される API について詳しくは、CashTrackingSessionsクエリを参照してください。