集合是商家可以创建的产品组合,以使商店更易于浏览。例如,商人可能为他们出售的特定类型的产品(例如Footwear)创建一个集合。商家可以通过单独选择产品或通过定义自动确定是否包含产品的规则来创建集合。
Shopify商店从称为Frontpage的单个集合开始。这是在线商店首页上显示的产品的集合。
有两种不同类型的集合:
- 自定义集合,其中包含由商家手动添加到集合中的产品。有关更多信息,请参见CustomCollection资源。
- 智能集合,其中包含根据商家选择的条件自动添加的产品。有关更多信息,请参见SmartCollection资源。
您可以用Collection做些什么
Shopify API使您可以对Collection资源执行以下操作。这些常规操作的更详细的版本可能可用:
- GET /admin/api/2021-01/collections/{collection_id}.json检索单个集合
- GET /admin/api/2021-01/collections/{collection_id}/products.json检索属于集合的产品列表
集合属性
body_html | plain "body_html": "<p>The best selling iPods ever</p>" 集合的描述,带有HTML标记。许多模板在其收藏页上显示此内容。 |
---|---|
处理 | plain "handle": "ipods" 从其标题自动生成的集合的唯一可读字符串。Liquid模板语言在主题中使用它来引用集合。(限制:255个字符) |
图像 | plain "image": { "src": "http://static.shopify.com/collections/ipod.jpg?0", "alt": "iPods", "width": 500, "height": 488, "created_at": "2018-04-19T09:34:47-04:00" } 与集合关联的图像。有效值为:+ attachment:附加到集合的图像,该图像以Base64编码的二进制数据形式返回。 + src:指定图像位置的源URL。 + alt:描述集合图像的替代文本。 + created_at:将图像添加到集合中的时间和日期(ISO 8601格式)。 + width:图像的宽度,以像素为单位。 + height:图像的高度,以像素为单位。 |
ID 只读 | plain "id": 841564295 集合的ID。 |
已发布 只读 | plain "published_at": "2008-02-01T19:00:00-05:00" 使集合可见的时间和日期(ISO 8601格式)。返回null 隐藏的集合。 |
published_scope 只读 | plain "published_scope": "global" 该收藏集是否已发布到销售点渠道。有效值:+ web :收藏集已发布到“在线商店”渠道,但未发布到“销售点”渠道。+ global :收藏集同时发布到在线商店渠道和销售点渠道。 |
排序 | plain "sort_order": "manual" 集合中产品出现的顺序。有效值:+ alpha-asc:按字母顺序,按升序(A-Z)。 + alpha-desc:按字母顺序,降序排列(Z-A)。 + 畅销:通过畅销产品。 + created:按创建日期的升序排列(从最旧到最新)。 + created-desc:按创建日期的降序排列(最新-最旧)。 + 手动:按照店主手动设置的顺序。 + price-asc:按价格升序排列(最低-最高)。 + price-desc:按价格降序排列(最高-最低)。 |
template_suffix | plain "template_suffix": "custom" 使用的液体模板的后缀。例如,如果值为custom ,则表示集合正在使用collection.custom.liquid 模板。如果值为null ,则该集合使用默认值collection.liquid 。 |
标题 必需的 | plain "title": "IPods" 集合的名称。(限制:255个字符) |
Updated_at 只读 | plain "updated_at": "2008-02-01T19:00:00-05:00" 上次修改集合的日期和时间(ISO 8601格式)。 |
终点
得到/admin/api/2021-01/collections/{collection_id}.json 检索单个集合领域 | 仅显示某些字段,这些字段由逗号分隔的字段名称列表指定。 |
---|---|
通过ID检索特定集合
GET /admin/api/2021-01/collections/841564295.json
得到/admin/api/2021-01/collections/{collection_id}/products.json 检索属于集合的产品列表。注意:从2019-10版本开始,此端点通过使用响应标头中提供的链接来实现分页。发送<font style="background-color:#F4F6F8;">page</font>
参数将返回错误。要了解更多信息,请参阅向分页的REST Admin API端点发出请求。。返回的产品按集合的排序顺序排序。
限制 | 要检索的产品数。 (默认值: 50 最大: 250 ) |
---|---|
检索属于集合的产品列表
GET /admin/api/2021-01/collections/841564295/products.json