2022 年更新记录 · 工具与应用 · Shopify API 版本发布:一月版
2022 年 1 月 API 功能概述。此版本包括通过 Storefront API 改进的产品筛选功能、改进的产品分类 API、定义集合、客户和订单的新元字段、订单发票 API、批量变更的新错误代码,以及简化检索可翻译资源、特色图像和条形码的方法。
开发者请注意!以下是 2022 年 1 月更新的 API 功能摘要。此版本包括:通过 Storefront API 改进的产品筛选功能、改进的产品分类 API、新增的集合、客户和订单元字段定义、订单发票 API、批量变更的新错误代码,以及简化的检索可翻译资源、特色图像和条形码的方法。
本文介绍 Shopify API 于 2022 年 1 月发布的版本。我们将提供相关信息,帮助您利用最新功能提升应用质量并简化开发流程。
此版本包括通过 Storefront API 改进的产品筛选功能、改进的产品分类 API、定义集合、客户和订单的新元字段、订单发票 API、批量变更的新错误代码,以及简化检索可翻译资源、特色图像和条形码的方法。
此外,本次发布将移除 2021-01 版本,请检查您的 API 健康报告以了解未来的变更并确保兼容性。有关此版本所有 API 变更的完整列表,请参阅 2022-01 版本说明(英文版)。
1. 使用 Storefront API 筛选系列中的产品
从 2022 年 1 月版本开始,您现在可以筛选系列中的产品,从而缩小向客户显示的搜索结果范围。检索到系列中的产品后,您可以按供应商、产品类型、规格选项和库存情况等条件进行筛选。
这些筛选条件还可以组合使用,让您可以根据更复杂的特征从收藏中检索商品。
例如,以下查询展示了如何检索具有以下所有属性的产品:
- 类型:衬衫和上衣
- 供应商:Bestshop
- 颜色:非常翠绿
以下是变量。
筛选商品系列中的商品是向顾客展示最相关商品的绝佳方式。如需了解更多关于使用 Storefront API 筛选商品系列的信息,请参阅此文档(英文版)。
2 产品分类 API
如果您希望优化商家店铺中的产品分类,方便顾客查找,我们推荐您使用全新的产品分类 API。标准化产品类型 (StandardizedProductType) 是一种预定义的产品类别,能够提升您店铺中产品的搜索排名。此外,它还能帮助商家更轻松地在 Facebook 等需要符合标准分类的平台上发布产品。
如果您的产品类型不属于任何预定义的类别,您可以使用产品对象上的 `customProductType` 字段。与传统的 `type` 字段一样,这是一个字符串类型。如果父类别与产品类别匹配,则此自定义产品类型还可以与父类别的 `StandardizedProductType` 一起使用。
以下查询是检索任意标准化产品类型的示例。
以下是回复。
有关产品分类的更多详细信息,请参阅开发者文档。
3. 在集合、客户和订单中定义元字段
2021 年 7 月版本发布了元字段更新,为产品启用了自定义元字段类型。此版本将此功能的支持范围扩展到了产品系列、客户和订单。这些新资源中的元字段还支持 18 种不同的数据类型,允许您存储有效数据,以便在您的应用和店铺中显示。
以下示例显示了创建存储产品参考信息的客户元字段定义的请求。
这是一个变量。
有关元字段的定义以及向改进的类型系统迁移的更多详细信息,请参阅开发者文档(英文版)。
4. 订单发票 API
应用新增了一个 mutation,允许您使用 Shopify API 发送订单发票。orderInvoiceSend mutation 提供订单 ID 和电子邮件内容,使您可以直接向客户发送电子邮件,请求支付需要付款的订单。此前,商家需要手动操作此流程,但现在可以实现自动化。
以下是一个向客户发送发票的变更示例。
以下是一些变量示例。
收到您的请求后,您将收到以下电子邮件。
这封邮件包含一个直接链接,方便您完成订单付款。
有关使用 orderInvoiceSend mutation 发送发票的详细信息,请参阅文档(英文版)。
5. 批量变更 API 的错误代码
此前,BulkMutations 只显示一个错误代码:“BULKMUTATIONUSERERRORCODE”。从这个版本开始,我们将不再显示这个通用错误代码,而是提供五个新的、更详细的错误代码,帮助您快速了解问题所在。
这些新错误代码的完整列表可以在开发者文档(英文版)中找到。
再次提醒,对于需要持续超过 10 秒的 API 请求的情况,BulkMutation API 是将数据同步到 Shopify 的最快、最高效的方式。有关如何使用 BulkMutation API 将数据同步到 Shopify 的更多信息,请参阅文档(英文版)。
6. 如何通过ID检索多个可翻译资源
以前,要检索与特定 ID 关联的一组可翻译资源,需要发出多个请求,每次获取一个资源。从 2022-01 版本开始,现在可以使用 ID 数组检索指定的一组可翻译资源。这样就无需检索特定类型的所有资源,也无需为每个 ID 单独发出请求。
以下示例显示了两种变体:检索特定产品的可翻译资源的请求和单个请求。
您可以在本文档(英文版)中找到有关 translatableResourcesByIds 查询的更多详细信息。
7. 新的店铺 API 产品字段
从 2022-01 版本开始,Storefront API 将支持两个新的产品字段:featuredImage 字段,用于快速高效地检索任何产品的特色图片;以及 ProductVariant 条形码字段,用于检索变体的条形码。
以下是一个获取这两个新字段的示例查询。
以下是回复:
我们来看看最新的变化。
原文作者:Shayne Parmelee,译者:Nozomi Fukatsu
分享这篇文章
- 在 Facebook 上分享
- 分享至 X
- 在领英上分享





