收集
收集资源将产品连接到自定义集合。
收集用于管理产品和自定义收集之间的关系。对于自定义集合中的每个产品,都有一个集合,该集合可跟踪产品和自定义集合的ID。一个产品可以在多个集合中,并且将有一个集合将其连接到每个集合。与许多Shopify资源不同,店主看不到货款。
收集仅用于将产品放入自定义收集中。智能馆藏使用规则来确定哪些产品是其成员。创建将产品链接到智能收藏夹的收藏夹会导致403禁止错误。
有关自定义集合的更多信息,请参见CustomCollection资源。
使用Collect可以做什么
Shopify API使您可以使用“收集”资源执行以下操作。这些常规操作的更详细的版本可能可用:
- POST /admin/api/2021-01/collects.json将产品添加到自定义集合
- 删除/admin/api/2021-01/collects/{collect_id}.json从集合中删除产品
- GET /admin/api/2021-01/collects.json检索收集清单
- GET /admin/api/2021-01/collects/count.json检索收集数
- GET /admin/api/2021-01/collects/{collect_id}.json通过其ID检索特定的收集
收集属性
collection_id | plain "collection_id": 841564295 包含产品的自定义集合的ID。 |
---|---|
created_at | plain "created_at": "2018-04-25T13:51:12-04:00" 创建收集的日期和时间(ISO 8601格式)。 |
ID | plain "id": 841564295 收集的唯一数字标识符。 |
位置 | plain "position": 2 该产品在手动排序的自定义集合中的位置。第一个位置是1。仅当手动对自定义集合进行排序时,才应用此值。 |
product_id | plain "product_id": 632910392 定制集合中产品的唯一数字标识符。 |
排序值 | plain "sort_value": "0000000002" 该值与相同,position 但用前导零填充以使其可进行字母数字排序。仅当手动对自定义集合进行排序时,才应用此值。 |
Updated_at | plain "updated_at": "2018-04-25T13:51:12-04:00" 上次更新收集的日期和时间(ISO 8601格式)。 |
终点
邮政/admin/api/2021-01/collects.json 将产品添加到自定义集合。在现有产品和现有馆藏之间创建新链接
POST /admin/api/2021-01/collects.json
{
“收集” : {
“ product_id” :921728736,
“ collection_id” :841564295
}
}
创建没有产品或馆藏ID的馆藏失败并返回错误
POST /admin/api/2021-01/collects.json
{
“收集” : {
“ body” :“ foobar”
}
}
删除/admin/api/2021-01/collects/{collect_id}.json 从集合中删除产品。删除产品与馆藏之间的链接
删除/admin/api/2021-01/collects/455204334.json
得到/admin/api/2021-01/collects.json 检索收集列表。注意:从2019-07版本开始,此端点通过使用响应标头中提供的链接来实现分页。发送<font style="background-color:#F4F6F8;">page</font>
参数将返回错误。要了解更多信息,请参阅向分页的REST Admin API端点发出请求。
限制 | 要显示的最大结果数。 (默认值: 50 最大: 250 ) |
---|---|
since_id | 将结果限制为指定的ID之后。 |
领域 | 仅显示某些字段,这些字段由逗号分隔的字段名称列表指定。 |
检索商店的所有货款
GET /admin/api/2021-01/collects.json
检索仅针对特定产品收集
GET /admin/api/2021-01/collects.json?product_id=632910392
检索仅针对特定集合的集合
GET /admin/api/2021-01/collects.json?collection_id=841564295
得到/admin/api/2021-01/collects/count.json 检索收集的计数。计算商店的所有款项
GET /admin/api/2021-01/collects/count.json
计数仅针对特定产品收集
GET /admin/api/2021-01/collects/count.json?product_id=632910392
计数仅针对特定集合
GET /admin/api/2021-01/collects/count.json?collection_id=841564295
得到/admin/api/2021-01/collects/{collect_id}.json 通过其ID检索特定的收集。领域 | 仅显示某些字段,这些字段由逗号分隔的字段名称列表指定。 |
---|---|
检索具有特定ID的收集
GET /admin/api/2021-01/collects/455204334.json