获取订阅合同数据

在使用订阅合同数据的工作流中,您可以使用获取订阅合同数据操作来从您的商店中检索订阅合同信息。

配置

字段

获取订阅合同数据操作包含以下用于构建查询的字段:

“获取数据”操作中使用的字段。
字段描述
数据排序依据必填。搜索查询返回的数据所依据的排序参数。
最大结果数必填。您选择的搜索查询可返回的最大结果数。一次最多可返回 100 个。
查询必填。从常用查询中进行选择,或选择高级以创建您自己的查询。

查询字符串

以下是获取状态为 ACTIVE 的订阅合同的示例查询:

status: ACTIVE

status 变量是订阅合同查询上可用的一个筛选条件,并且可以多次使用。

查询数据时,了解以下内容会很有帮助:

  • 可用筛选条件列表
  • 查询必须遵循特定语法
  • 查询字段值并非总有文档记录。在某些情况下,您可以通过查看 API 文档来查找这些值。或者,您通常可以在后台中进行筛选时,在 URL 中找到字段值。例如,要查找一些订单查询值,请在后台中筛选“订单”页面,然后检查 URL。
  • 您可以使用 Shopify GraphiQL 应用在您的商店中运行或测试查询。
  • 请注意查询失败时会发生什么。API 通常会返回所有结果(而不是不返回任何结果)。

返回的数据

所有“**获取数据**”操作都会返回一个包含 0 到 100 个资源的列表。根据您的用例,您可能希望通过各种方式使用这些数据:

  • 如果您需要单独处理每个列表项(例如为每个列表项添加标记),则可以使用 For each 操作。
  • 如果您需要聚合数据(例如统计返回了多少结果),则可以使用 计数求和操作。
  • 如果您需要输出列表(例如发送包含所有商品的电子邮件),则可以在后续操作中直接使用返回的数据。

要在此操作之后的步骤中访问返回的数据,请使用名为获取订阅合同数据的变量,该变量是订阅合同的列表。您可以在条件和操作中均使用此变量。例如,您可以像下面这样在发送内部电子邮件操作中发送订单列表:

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

触发器

您可以在任何工作流中使用此操作,包括 Scheduled time 触发器。在使用 Scheduled time 触发器的工作流中,工作流将在您指定的时间(而不是因某个事件)启动。由于没有来自您商店或应用的特定事件来启动该工作流,因此不会自动包含任何数据。

API 参考