创建手动分类
POST https://{handle}.myshopline.com/admin/openapi/v20260901/products/custom_collections.json
handle :店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com 的店铺,其 handle 是 open001 。在店铺中创建一个新手动分类。
提示
本接口不支持直接对 SEO 信息做管理。分类的 SEO 信息通过元字段(Metafield)进行管理。具体操作方式,可参考 通过 Metafield 的 Open API 编辑资源页面 SEO 信息。
通过本接口创建手动分类时,通过
title 为 seoTitle 赋予初始值,body_html 为 seoDescription 赋予初始值。请求头
- Content-Type string required字段值固定为
application/json; charset=utf-8。 - Authorization string required资源的访问令牌。参考 应用授权 获取访问令牌,然后将获取到的访问令牌以 Bearer 格式传入。例子:
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
请求体
custom_collectionobject required
手动分类信息。bannerobject
分类的封面图。alt string图片的替代文本描述,通常是具有图片特征或内容的单词或短语。
最大长度限制:512例子:This is an image altsrc string图片的链接,以 URL 形式展示。
最大长度限制:255例子:https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.pngbody_html string分类的描述。
最大容量限制:64 KB例子:This is a descriptioncollectsobject[]
手动分类关联的商品列表,将按照传入的商品 ID 顺序进行绑定。
最大个数限制:500product_id string商品的唯一标识 ID。
最大长度限制:64例子:16049619743346320200470282handle string分类的语义化的唯一标识,默认基于title生成。
最大长度限制: 255例子:collection-handleimageobject
分类的图片。alt string分类图的替代文本描述,通常是具有图片特征或内容的单词或短语。
最大长度限制:512例子:This is an image altsrc string分类图的链接,以 URL 形式展示。
最大长度限制:255例子:https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.pngpath string分类的相对路径。
最大长度限制:512例子:/collections/springpublished_scope string分类的销售渠道发布范围。有效值固定为web,代表在线商城。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.jsontitle string required分类的标题。
最大长度限制:255例子:This is a collection title
状态码
- 200
- 401
- 429
更多状态码信息,参考 HTTP 状态码。
响应头
traceId
请求的全局唯一标识符。用于追踪请求在系统中的流转,以便于问题发生时进行定位和调试。
响应体
custom_collectionobject
手动分类信息。bannerobject
分类的封面图。alt string图片的替代文本描述,通常是具有图片特征或内容的单词或短语。例子:This is an image altsrc string图片的链接,以 URL 形式展示。例子:https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.pngbody_html string分类的描述。例子:This is a descriptionhandle string分类的语义化的唯一标识,默认基于title生成。例子:collection-handleid string分类的唯一标识 ID。例子:12257170618007271602093384imageobject
分类的图片。alt string分类图的替代文本描述,通常是具有图片特征或内容的单词或短语。例子:This is an image altsrc string分类图的链接,以 URL 形式展示。例子:https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.pngpublished_scope string分类的销售渠道发布范围。有效值固定为web,代表在线商城。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.jsontitle string分类的标题。例子:This is a collection title
API Explorer
调试台
示例代码
这篇文章对你有帮助吗?