需要 read_products 权限点。
更多权限点使用信息,请参考:
GET https://{handle}.myshopline.com/admin/openapi/v20260301/products/smart_collections.json
handle :店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com 的店铺,其 handleopen001
批量查询店铺中智能分类的信息。
查询参数
  • ids string
    指定查询的分类 ID,多个 ID 用英文逗号分隔。
    例子: 12257170618007271602093384,12257170618007271602083384
  • title string
    分类的标题。
    最大长度限制:255
    例子: This is a title
  • updated_at_max string
    指定要查询分类的最晚更新时间。在此日期之前更新的数据会被返回。格式:ISO 8601
    例子: 2021-09-03T14:11:54+00:00
  • updated_at_min string
    指定要查询分类的最早更新时间。在此日期和此日期之后更新的数据会被返回。格式:ISO 8601
    例子: 2021-09-04T14:11:54+00:00
  • fields string
    指明需要返回的字段,多个字段用英文逗号分隔。可指定的字段范围参考响应体中 smart_collections 对象下的一级子字段。
    例子: title,handle
  • limit string
    要查询的分类的数量限制。
    取值范围:1-250
    默认值:50
  • page_info string
    分页查询的唯一标识,用于定位特定页面。
    该字段值需要在你已经查询完分页信息后,在该接口响应头中的 link 字段值中获取。例如,你获取到的 link 的值为 <https://{handle}.myshopline.com/admin/openapi/{version}/products/smart_collections.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next" ,那么 page_info 的值为 eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9
    关于更多如何使用分页信息,请参考 分页机制
  • since_id string
    分类的 ID。传入该值后,会从指定的分类 ID 开始查询分类。
    例子: 12257170618007271602093384
  • handle string
    分类的语义化的唯一标识,默认基于 title 生成。
    最大长度限制:255
    例子: collection-handle
请求头
  • Content-Type string required
    字段值固定为 application/json; charset=utf-8
  • Authorization string required
    资源的访问令牌。参考 应用授权 获取访问令牌,然后将获取到的访问令牌以 Bearer 格式传入。
    例子:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
状态码
更多状态码信息,参考 HTTP 状态码

响应头
  • link
    提供分页数据的 URL 链接。你可以获取该字段值中的 page_info 信息用于下一次分页请求中。
    当你请求的页面存在上一页或下一页的时候,该字段会被返回。关于更多如何使用分页信息,请参考 分页机制
  • traceId
    请求的全局唯一标识符。用于追踪请求在系统中的流转,以便于问题发生时进行定位和调试。
响应体
  • smart_collectionsobject[]
    分类信息。
  • bannerobject
    分类的封面图。
  • alt string
    图片的替代文本描述,通常是具有图片特征或内容的单词或短语。
    例子: This is an image alt
  • src string
    图片的链接,以 URL 形式展示。
    例子: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
  • body_html string
    分类的描述。
    例子: This is a description
  • created_at string
    分类的创建时间。格式:ISO 8601
    例子: 2021-09-03T14:11:54+00:00
  • disjunctive boolean
    用来设置智能分类中商品筛选条件之间的逻辑关系。
    • true:商品符合任意一个条件,即可被纳入该智能分类中。
    • false:商品必须满足所有条件且全部符合,才可被纳入该智能分类中。
  • handle string
    分类的语义化的唯一标识,默认基于 title 生成。
    例子: collection-handle
  • id string
    分类的唯一标识 ID。
    例子: 12257170618007271602093384
  • imageobject
    分类的图片。
  • alt string
    图片的替代文本描述,通常是具有图片特征或内容的单词或短语。
    例子: This is an image alt
  • src string
    图片的链接,以 URL 形式展示。
    例子: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
  • path string
    分类的相对路径。
    例子: /collections/spring
  • published_at string
    分类发布到在线商店的时间。格式:ISO 8601
    例子: 2021-09-03T14:11:54+00:00
  • published_scope string
    分类的销售渠道发布范围。有效值固定为web,代表在线商城。
  • rulesobject[]
    表示智能分类的筛选规则,是一个规则的数组,每个规则定义商品筛选的条件。
  • column string
    指定筛选的字段,例如 tag 表示商品标签,sale_price 表示商品销售价格。
    例子: product_metafield_definition
  • condition string
    指定筛选的值,例如 T shirt 表示标签匹配的值,10.00 表示价格的具体数值。
    例子: `true`
  • condition_object_id long
    元字段对象的 ID。
    例子: 483749284
  • relation string
    指定筛选条件的关系,例如 equals 表示相等,greater_than 表示大于。
    例子: `equals`
  • sort_order string
    表明分类的排序方式:
    • best-selling:按热销排序。
    • alpha-asc:按产品名称从 A 到 Z 排序。
    • alpha-desc:按产品名称从 Z 到 A 排序。
    • updated-desc:按更新时间从新到旧排序。
    • updated-asc:按更新时间从旧到新排序。
    • manual:按自定义排序。
  • template_path string
    主题模板。
    例子: templates/collection.collection_name.json
  • title string
    分类的标题。
    例子: This is a title
  • updated_at string
    分类最近一次更新的时间。格式:ISO 8601
    例子: 2021-09-03T14:11:54+00:00
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

header required
query
query
query
query
query
query
query
query
query

Language

curl --request GET \
--url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/products/smart_collections.json \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
--header 'Content-Type: application/json; charset=utf-8' \
--header 'accept: application/json'
Examples
指定Handle查询智能分类
Response
{
"smart_collections": [
{
"banner": {
"alt": "This is an image alt",
"src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/e46e6189dd5641a3b179444cacdcdd2a_15.png?w=1024&h=1024"
},
"body_html": "This is a description",
"created_at": "2023-06-12T14:21:25+08:00",
"disjunctive": true,
"handle": "first-zn",
"id": "12259764264680491895113144",
"image": {
"alt": "This is an image alt",
"src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/e46e6189dd5641a3b179444cacdcdd2a_15.png?w=1024&h=1024"
},
"published_at": "2023-06-12T14:21:25+08:00",
"published_scope": "web",
"rules": [
{
"column": "tag",
"condition": "T shirt",
"relation": "equals"
}
],
"sort_order": "updated-asc",
"template_path": "templates/collection.html",
"title": "First Smart Collection",
"updated_at": "2023-08-29T16:14:56+08:00"
}
]
}
这篇文章对你有帮助吗?