需要 read_products 权限点。
更多权限点使用信息,请参考:
GET https://{handle}.myshopline.com/admin/openapi/v20250601/products/collections/:collection_id.json
handle :店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com 的店铺,其 handleopen001
根据分类id查询分类信息,不区分手动/智能
路径参数
  • collection_id string required
    分类ID
    Example: 12257170618007271602093384
查询参数
  • fields string
    字段
    Example: created_at,title,id
请求头
  • Content-Type required
    字段值固定为application/json; charset=utf-8
  • Authorization string required
    资源的访问令牌。请参考 应用授权 获取访问令牌,然后将获取到的访问令牌以 Bearer 格式传入
    Example:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
响应
更多状态码信息请参考 HTTP 状态码

响应头
  • traceId
    traceId
响应体
  • collectionobject
    分类信息
  • bannerobject
    分类横幅图
  • alt string
    图片alt
    Example: This is a image alt
  • src string
    图片src
    Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
  • body_html string
    描述
    Example: This is a description
  • collection_type string
    分类类型:custom,smart
    Example: smart
  • created_at string
    创建时间
    Example: 2021-09-03T14:11:54+00:00
  • disjunctive boolean
    智能分类框定商品的条件之间的关系 true:商品符合任意一个条件,即可被纳入该智能分类中 false:商品必须满足所有条件必须全符合,才可被纳入该智能分类中
    Example: true
  • handle string
    分类handle
    Example: collection-handle
  • id string
    分类ID
    Example: 12257170618007271602093384
  • imageobject
    分类图片
  • alt string
    图片alt
    Example: This is a image alt
  • src string
    图片地址
    Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
  • path string
    在线商店中商品URL的相对路径,最多512个字符。
    Example: /collections/spring
  • published_at string
    发布到在线商店的时间
    Example: 2021-09-03T14:11:54+00:00
  • published_scope string
    设置发布范围,值为「web」时表示在线商店
    Example: 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
    Example: product_metafield_definition
  • condition string
    对应条件变量的值,以布尔值为例
    Example: true
  • condition_object_id long
    元字段对象的ID
    Example: 483749284
  • relation string
    判断语句, 等于:equals,不等于:not_equals,开头为:starts_with,结尾为:ends_with,包含:contains,不包含:not_contains,大于:greater_than,小于:less_than
    Example: equals
  • sort_order string
    排序方式,热销:best-selling,产品名称从A-Z:alpha-asc,产品名称从Z- A:alpha-desc,更新时间新→旧:updated-desc,更新时间旧→新:updated-asc,自定义:manual
    Example: updated-asc
  • template_path string
    主题模板
    Example: templates/sortation/detail.json
  • title string
    标题
    Example: This is a title
  • updated_at string
    更新时间
    Example: 2021-09-03T14:11:54+00:00
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

path required
header required
query

Language

curl --request GET \
--url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/products/collections/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
指定字段
Response
{
"collection": {
"created_at": "2023-06-12T14:19:35+08:00",
"id": "12259764246208273857373144",
"title": "First Custom Collection"
}
}
这篇文章对你有帮助吗?