需要 read_products 权限点。
更多权限点使用信息,请参考:
GET https://{handle}.myshopline.com/admin/openapi/v20260601/products/smart_collections/:smart_collection_id.json
handle :店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com 的店铺,其 handleopen001
查询指定智能分类信息。
路径参数
  • smart_collection_id string required
    智能分类的唯一标识 ID。
    最大长度限制:64
    例子: 12257170618007271602093384
查询参数
  • fields string
    指明需要返回的字段,多个字段用英文逗号分隔。可指定的字段范围参考响应体中 smart_collection 对象下的一级子字段。
    例子: title,handle
请求头
  • Content-Type string required
    字段值固定为 application/json; charset=utf-8
  • Authorization string required
    资源的访问令牌。参考 应用授权 获取访问令牌,然后将获取到的访问令牌以 Bearer 格式传入。
    例子:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
状态码
更多状态码信息,参考 HTTP 状态码

响应头
  • traceId
    请求的全局唯一标识符。用于追踪请求在系统中的流转,以便于问题发生时进行定位和调试。
响应体
  • smart_collectionobject
    智能分类信息。
  • 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
    指定筛选的字段。
    • title:产品标题
    • sale_price:商品款式售价
    • compared_at_price:商品款式原价
    • tag:产品标签
    • inventory:商品库存
    • vendor:品牌或厂商
    • variant_weight:商品款式重量
    • variant_title:商品款式标题
    • created_at:商品创建时间
    • sales:商品销量
    • view:商品浏览量
    • add_to_cart:商品加购量
    • type:自定义商品类型
    • product_taxonomy_node_id:标准商品类型
    • product_metafield_definition:商品元字段的值
  • condition string
    指定筛选的值,例如 T shirt 表示标签匹配的值,10.00 表示价格的具体数值。
    relationis_not_setis_set 时,字段无效。
    例子: true
  • condition_object_id long
    元字段对象的 ID。
    例子: 483749284
  • relation string
    指定筛选条件的关系。
    • equals:表示等于
    • not_equals:表示等于
    • starts_with:表示前缀匹配
    • ends_with:表示后缀匹配
    • contains:表示包含关系
    • not_contains:表示不包含关系
    • greater_than:表示大于
    • less_than:表示小于
    • is_not_set:表示全为空
    • is_set:表示不为空
  • sort_order string
    表明分类页商品列表默认排序值的排序方式。
    • alpha-asc:按产品名称从 A 到 Z 排序
    • alpha-desc:按产品名称从 Z 到 A 排序
    • updated-desc:按更新时间从新到旧排序
    • updated-asc:按更新时间从旧到新排序
    • manual:按自定义排序
    • created-desc:按创建时间从新到旧排序
    • created-asc:按创建时间从旧到新排序
    • price-asc:按商品款式最低售价升序排序
    • price-desc:按商品款式最低售价降序排序
    • best-selling-last3days:按近 3 天销量降序排序
    • best-selling-last7days:按近 7 天销量降序排序
    • best-selling-last15days:按近 15 天销量降序排序
    • best-selling-last30days:按近 30 天销量降序排序
    • best-selling-last60days:按近 60 天销量降序排序
    • best-selling:按近 90 天销量降序排序
    • additional-purchase-rate-last3days:按近 3 天加购率降序排序
    • additional-purchase-rate-last7days:按近 7 天加购率降序排序
    • additional-purchase-rate-last15days:按近 15 天加购率降序排序
    • additional-purchase-rate-last30days:按近 30 天加购率降序排序
    • additional-purchase-rate-last60days:按近 60 天加购率降序排序
    • additional-purchase-rate-last90days:按近 90 天加购率降序排序
    • conversion-rate-last3days:按近 3 天转化率降序排序
    • conversion-rate-last7days:按近 7 天转化率降序排序
    • conversion-rate-last15days:按近 15 天转化率降序排序
    • conversion-rate-desc:按近 30 天转化率降序排序
    • conversion-rate-last60days:按近 60 天转化率降序排序
    • conversion-rate-last90days:按近 90 天转化率降序排序
    • additional-purchases-num-last3days:按近 3 天加购量降序排序
    • additional-purchases-num-last7days:按近 7 天加购量降序排序
    • additional-purchases-num-last15days:按近 15 天加购量降序排序
    • additional-purchases-num-last30days:按近 30 天加购量降序排序
    • additional-purchases-num-last60days:按近 60 天加购量降序排序
    • add-to-cart-desc:按近 90 天加购量降序排序
    • views-pv-last3days:按近 3 天浏览量降序排序
    • views-pv-last7days:按近 7 天浏览量降序排序
    • views-pv-last15days:按近 15 天浏览量降序排序
    • views-pv-last30days:按近 30 天浏览量降序排序
    • views-pv-last60days:按近 60 天浏览量降序排序
    • view-desc:按近 90 天浏览量降序排序
  • template_path string
    分类的主题模板。
    例子: templates/collection.collection_template_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/v20260601

ParamOptions

path required
header required
query

Language

curl --request GET \
--url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260601/products/smart_collections/smart_collection_id.json \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
--header 'Content-Type: application/json; charset=utf-8' \
--header 'accept: application/json'
Examples
根据 ID 查询智能分类属性
Response
{
"smart_collection": {
"banner": {
"alt": "This is an alt",
"src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/e46e6189dd5641a3b179444cacdcdd2a.png?w=1024&h=1024"
},
"body_html": "<p>This is a desription</p>",
"created_at": "2023-06-12T14:21:25+08:00",
"disjunctive": false,
"handle": "first-zn",
"id": "12259764264680491895113144",
"image": {
"alt": "This is an alt",
"src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/e46e6189dd5641a3b179444cacdcdd2a.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"
},
{
"column": "sale_price",
"condition": "10.00",
"relation": "greater_than"
}
],
"sort_order": "manual",
"template_path": "templates/collection.html",
"title": "First Smart Collection",
"updated_at": "2023-08-28T19:34:00+08:00"
}
}
这篇文章对你有帮助吗?