JS Buy SDK 自 2025 年 1 月起已弃用。 更多信息请参阅README。

类：ProductResource

ProductResource()

JS Buy SDK 产品资源

构造函数

new ProductResource()

源代码

方法

fetch(id) → {Promise|GraphModel}

通过 ID 从商店获取单个产品。

参数
名称 类型 描述
id 字符串

要获取的产品的 ID。
源代码
返回

一个 Promise，解析为产品的 GraphModel。

类型
Promise | GraphModel
示例
client.product.fetch('Xk9lM2JkNzFmNzIQ4NTIY4ZDFi9DaGVja291dC9lM2JkN==').then((product) => {
  // Do something with the product
});

fetchAll(pageSize可选) → {Promise|Array.<GraphModel>}

获取商店中的所有产品。

参数
名称 类型 属性 描述
pageSize 整数 <可选>

每页要获取的产品数量
源代码
返回

一个 Promise，解析为产品 GraphModel 数组。

类型
Promise | Array.<GraphModel>
示例
client.product.fetchAll().then((products) => {
  // Do something with the products
});

fetchByHandle(handle) → {Promise|GraphModel}

通过 Handle 从商店获取单个产品。

参数
名称 类型 描述
handle 字符串

要获取的产品的 Handle。
源代码
返回

一个 Promise，解析为产品的 GraphModel。

类型
Promise | GraphModel
示例
client.product.fetchByHandle('my-product').then((product) => {
  // Do something with the product
});

fetchMultiple(ids) → {Promise|Array.<GraphModel>}

通过 ID 从商店获取多个产品。

参数
名称 类型 描述
ids Array.<String>

要获取的产品的 ID
源代码
返回

一个 Promise，解析为产品的 GraphModel。

类型
Promise | Array.<GraphModel>
示例
const ids = ['Xk9lM2JkNzFmNzIQ4NTIY4ZDFi9DaGVja291dC9lM2JkN==', 'Z2lkOi8vc2hvcGlmeS9Qcm9kdWN0Lzc4NTc5ODkzODQ='];
client.product.fetchMultiple(ids).then((products) => {
  // Do something with the products
});

fetchQuery(args可选) → {Promise|Array.<GraphModel>}

获取商店中与查询匹配的所有产品。

参数
名称 类型 属性 描述
args 对象 <可选>

一个指定查询数据的对象，包含零个或多个

属性
名称 类型 属性 默认值 描述
first 整数 <可选>
 20

Relay first 参数。这指定了页面大小。
sortKey 字符串 <可选>
 ID

用于对结果进行排序的键。可用值记录为 产品排序键。
query 字符串 <可选>

查询字符串。请参阅完整文档 此处
reverse 布尔值 <可选>

是否反转结果的排序顺序
源代码
返回

一个 Promise，解析为产品 GraphModel 数组。

类型
Promise | Array.<GraphModel>
示例
client.product.fetchQuery({first: 20, sortKey: 'CREATED_AT', reverse: true}).then((products) => {
  // Do something with the first 10 products sorted by title in ascending order
});

fetchRecommendations(productId) → {Promise|Array.<GraphModel>}

查找与给定 productId 相关的推荐产品。要了解有关如何生成推荐的更多信息，请参阅 https://shopify.dev/themes/product-merchandising/recommendations。

参数
名称 类型 描述
productId 字符串

要获取的产品的 ID。
源代码
返回

一个 Promise，解析为产品 GraphModel 数组。

类型
Promise | Array.<GraphModel>
示例
const productId 'Xk9lM2JkNzFmNzIQ4NTIY4ZDFi9DaGVja291dC9lM2JkN==';
client.product.fetchProductRecommendations(productId).then((products) => {
  // Do something with the products
});