---
title: "collection"

doc_type: static
doc_category: static
doc_version: v20270301
source_url:
  html: 'https://developer.shopline.com/zh-hans-cn/docs/sline/object/collection'
  md: 'https://developer.shopline.com/zh-hans-cn/docs/sline/object/collection.md'
---

# collection


    店铺的商品分类。

    > **提示**
>
> 使用 [get_metafields](https://developer.shopline.com/zh-hans-cn/docs/sline/filter/get-metafields.md)获取分类的元字段。



    <div>
    
        #### 属性

        
<ObjectProperty
    name="all_products_count"
    types={[<Mdx>integer</Mdx>]}
>
<ObjectSummary>
表示该商品分类下的所有产品总数，该总数统计包含已被当前筛选条件过滤掉的产品。

> **提示**
>
> 如果需要获取当前页面上显示的产品数量，即经过筛选后实际可见的产品数量，使用 `collection.products_count`。
</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="all_tags"
    types={[<Mdx>array of string</Mdx>]}
>
<ObjectSummary>
应用于商品分类中商品的所有标签。

这包括已从当前视图中过滤掉的产品标签。最多可返回 1,000 个标签。

> **提示**
>
> 要显示当前应用的标签，请使用 `collection.tags`。
</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="all_types"
    types={[<Mdx>array of string</Mdx>]}
>
<ObjectSummary>
商品分类中的所有产品类型。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="all_vendors"
    types={[<Mdx>array of string</Mdx>]}
>
<ObjectSummary>
商品分类中的所有产品供应商。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="current_type"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
当前商品分类页展示的商品类型。

你可以在 `/collections/types` URL添加 `?q=[type]` 参数查询特定类型的产品，其中 `[type]` 是你想要的商品类型。

> **提示**
>
> 参数值大小写不敏感，因此 `shirts` 等同于 `Shirts` 或 `SHIRTS`。
</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="current_vendor"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
当前商品分类页的供应商。

你可以在 `/collections/vendors` URL添加 `?q=[vendor]` 参数查询特定类型的产品，其中 `[vendor] `是你想要的产品供应商。

> **提示**
>
> 参数值大小写不敏感，因此 `apparelco` 等同于 `ApparelCo` 或 `APPARELCO`。
</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="default_sort_by"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
商品分类的默认排序顺序。

这是在 SHOPLINE 商家后台的商品分类页面上设置的。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="description"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
商品分类的描述。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="featured_image"
    types={[<Mdx>[image](https://developer.shopline.com/zh-hans-cn/docs/sline/object/image.md)</Mdx>]}
>
<ObjectSummary>
分类的封面图。

默认使用分类封面图。如果此图片不可用，使用分类中第一个产品的封面图。如果分类中的第一个产品没有封面图，则返回 `null`。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="filters"
    types={[<Mdx>array of [filter](https://developer.shopline.com/zh-hans-cn/docs/sline/object/filter.md)</Mdx>]}
>
<ObjectSummary>
已在商品分类上设置好的店铺前端过滤器。

仅会返回与当前商品分类相关的过滤器。对于包含超过 5000 件商品的商品分类，不返回过滤器数据。 


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="handle"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
商品分类的 handle。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="id"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
商品分类的 ID。



</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="image"
    types={[<Mdx>[image](https://developer.shopline.com/zh-hans-cn/docs/sline/object/image.md)</Mdx>]}
>
<ObjectSummary>
商品分类的封面图片。

这是在 SHOPLINE 商家后台的商品分类页面上设置的。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="products_count"
    types={[<Mdx>integer</Mdx>]}
>
<ObjectSummary>
当前商品分类视图中的产品总数。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="published_at"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
商品分类发布时间。

> **提示**
>
> 使用 [date filter](https://developer.shopline.com/zh-hans-cn/docs/sline/filter/date.md) 格式化时间。
</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="sort_by"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>

通过 URL 中的 `sort_by` 参数，为商品分类设置的排序方式。

若 URL 中未携带 `sort_by` 参数，此字段的值为 `null`。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="sort_options"
    types={[<Mdx>array of string</Mdx>]}
>
<ObjectSummary>
商品分类可用排序选项。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="tags"
    types={[<Mdx>array of string</Mdx>]}
>
<ObjectSummary>
当前商品分类视图下生效的标签，仅包含未被过滤的产品标签。 若未应用任何标签，或当前视图下所有带标签的产品均被过滤，则返回空数组。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="title"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
商品分类的标题。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="url"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
商品分类页面的相对 URL。


</ObjectSummary>
</ObjectProperty>
        
    
    </div>


