取得訂閱合約資料

在使用訂閱合約資料的工作流程中,您可以使用 Get subscription contract data 動作,從商店擷取訂閱合約資訊。

設定

欄位

Get subscription contract data 動作包含下列欄位,這些欄位用於組成查詢:

Get data 動作使用的欄位。
欄位說明
排序依據必填。決定查詢傳回資料排序的參數。
結果的最大數量必填。您選取的查詢最多可傳回的結果數量。每次最多可傳回 100 筆。
查詢必填。可從常用查詢中選擇,或選取 Advanced 建立自訂查詢。

查詢字串

以下是取得狀態為 ACTIVE 的訂閱合約的查詢範例:

status: ACTIVE

變數 statusSubscription contracts query 可用的篩選條件,且可重複使用。

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

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

傳回的資料

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

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

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

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

觸發條件

您可以在任何工作流程中使用此動作,包括 排程時間 觸發條件。工作流程若使用 排程時間 觸發條件,系統會在您指定的時間啟動,而非因事件啟動。由於沒有來自您的商店或 app 的特定事件啟動工作流程,因此不會自動包含任何資料。

API 參考