擷取訂閱扣款嘗試資料

在需要訂閱扣款嘗試資料的工作流程中,您可以使用 擷取訂閱扣款嘗試資料 動作,從您的商店擷取訂單資訊。

設定

欄位

擷取訂閱扣款嘗試資料 動作包含下列欄位,用於建立查詢:

「擷取資料」動作中使用的欄位。
欄位說明
資料排序依據必填。用於排序查詢傳回資料的參數。
最大結果數量必填。您選取的查詢可傳回的結果數量上限。每次最多可傳回 100 筆。
查詢必填。可從常用查詢中選取,或選擇 進階 自行建立。

查詢字串

以下範例查詢會取得過去三天內建立的訂閱扣款嘗試:

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

subscription billing attempt query 中,可使用 created_at 變數作為篩選條件,以選取訂閱扣款嘗試的特定錯誤訊息。

查詢資料時,瞭解下列事項會很有幫助:

  • List of available subscription billing attempt filters
  • 查詢必須遵循特定語法
  • 查詢欄位的可用值不一定都有文件說明。有時您可以在 API docs 中找到這些值。或者,當您在管理介面進行篩選時,也常能在網址中找到欄位值。舉例來說,若要找出部分訂單查詢值,請在管理介面的「訂單」頁面套用篩選,然後查看網址。
  • 您可以使用 Shopify GraphiQL app 在商店中執行或測試查詢。
  • 請留意查詢失敗時的情況。API 通常會傳回所有結果 (而非沒有結果)。

傳回的資料

所有 Get data 動作都會傳回 0 到 100 筆資源的清單。依您的使用情境,您可以用下列方式運用這些資料:

  • 如果需要個別處理清單中的每個項目,例如為每一項加上標籤,您可以使用 For each 動作。
  • 如果需要彙總資料,例如計算傳回的結果數量,您可以使用 CountSum 動作。
  • 如果需要輸出清單,例如寄送包含所有項目的電子郵件,則可在後續動作中直接使用這些傳回的資料。

若要在此動作後續的步驟中存取傳回的資料,請使用名為 Get subscription billing attempt data 的變數,這是一份訂閱扣款嘗試清單。此變數可用於條件與動作。例如,您可以在 Send internal email 動作中這樣寄送這份訂閱扣款嘗試清單:

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

範例

例如,有一個工作流程排程為每週星期日 上午 9:00 執行。使用 Get subscription billing attempt data 動作蒐集上週建立的訂閱扣款嘗試資料。若包含錯誤訊息,便以電子郵件寄送這些扣款嘗試。

API 參考