---
title: "product"

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

# product


    商店里面的一件商品。

    > **提示**
>
> 如需获取其它关联数据，可调用以下 filter：
> - 元字段：[get_metafields](https://developer.shopline.com/zh-hans-cn/docs/sline/filter/get-metafields.md)。
> - 款式信息：[get_variants](https://developer.shopline.com/zh-hans-cn/docs/sline/filter/get-variants.md)。
> - 分类信息： [get_collection_pagination](https://developer.shopline.com/zh-hans-cn/docs/sline/filter/get-collection-pagination.md)。



    <div>
    
## 属性

        
<ObjectProperty
    name="available"
    types={[<Mdx>boolean</Mdx>]}
>
<ObjectSummary>
商品是否可售卖。
- `true`: 可售卖
- `false`: 不可售卖


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="compare_at_price"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
该商品所有款式中，数值最低的原始价格。

该值以客户的本地货币输出。

> **提示**
>
> 使用 [money filter](https://developer.shopline.com/zh-hans-cn/docs/sline/filter/money.md) 输出格式化的金额。
</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="compare_at_price_max"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
该商品所有款式中，数值最高的原始价格。

该值以客户的本地货币输出。

> **提示**
>
> 使用 [money filter](https://developer.shopline.com/zh-hans-cn/docs/sline/filter/money.md) 输出格式化的金额。
</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="compare_at_price_min"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
该商品的任意款式的最低原始价格，与 `product.compare_at_price` 取值一致。

该值以客户的本地货币输出。

> **提示**
>
> 使用 [money filter](https://developer.shopline.com/zh-hans-cn/docs/sline/filter/money.md) 输出格式化的金额。
</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="compare_at_price_varies"
    types={[<Mdx>boolean</Mdx>]}
>
<ObjectSummary>
商品售价与原始价格是否存在差异。
- `true`: 存在差异
- `false`: 无差异


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="created_at"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
商品的创建时间。

> **提示**
>
> 使用 [date filter](https://developer.shopline.com/zh-hans-cn/docs/sline/filter/date.md) 格式化时间。
</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>
该商品的封面图片。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="featured_media"
    types={[<Mdx>array</Mdx>]}
>
<ObjectSummary>
该商品的第一个媒体。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="first_available_variant"
    types={[<Mdx>[variant](https://developer.shopline.com/zh-hans-cn/docs/sline/object/variant.md)</Mdx>]}
>
<ObjectSummary>
该商品第一个可售卖的款式。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="gift_card"
    types={[<Mdx>boolean</Mdx>]}
>
<ObjectSummary>
商品是否为礼品卡。
- `true`: 是礼品卡
- `false`: 非礼品卡


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


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="has_only_default_variant"
    types={[<Mdx>boolean</Mdx>]}
>
<ObjectSummary>
商品是否仅含默认款式。
- `true`: 仅含默认款式
- `false`: 包含非默认款式


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


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="images"
    types={[<Mdx>array</Mdx>]}
>
<ObjectSummary>
该商品的图片列表。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="media"
    types={[<Mdx>array</Mdx>]}
>
<ObjectSummary>
该商品的媒体列表，根据添加时间来进行排序。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="options"
    types={[<Mdx>array</Mdx>]}
>
<ObjectSummary>
该商品规格的名字列表。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="options_by_name"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
根据规格的名字获取一个指定的商品规格。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="options_with_values"
    types={[<Mdx>array</Mdx>]}
>
<ObjectSummary>
该商品下包含规格值的规格列表。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="price"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
该商品所有款式的价格中，最低的价格。

该值以客户的本地货币输出。

> **提示**
>
> 使用 [money filter](https://developer.shopline.com/zh-hans-cn/docs/sline/filter/money.md) 输出格式化的金额。
</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="price_max"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
该商品所有款式的价格中，最高的价格。

该值以客户的本地货币输出。

> **提示**
>
> 使用 [money filter](https://developer.shopline.com/zh-hans-cn/docs/sline/filter/money.md) 输出格式化的金额。
</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="price_min"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
该商品所有款式的价格中，最低的价格，与 `product.price` 取值一致。

该值以客户的本地货币输出。

> **提示**
>
> 使用 [money filter](https://developer.shopline.com/zh-hans-cn/docs/sline/filter/money.md) 输出格式化的金额。
</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="requires_selling_plan"
    types={[<Mdx>boolean</Mdx>]}
>
<ObjectSummary>
商品的所有的款式是否需要绑定销售计划。
- `true`: 需要
- `false`: 不需要


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="selected_or_first_available_variant"
    types={[<Mdx>[variant](https://developer.shopline.com/zh-hans-cn/docs/sline/object/variant.md)</Mdx>]}
>
<ObjectSummary>
当前选择的或者第一个可售卖的商品的款式。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="selected_variant"
    types={[<Mdx>[variant](https://developer.shopline.com/zh-hans-cn/docs/sline/object/variant.md)</Mdx>]}
>
<ObjectSummary>
当前选择的商品的款式。

如果没有款式被选中，返回 `null`。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="selling_plan_groups"
    types={[<Mdx>array</Mdx>]}
>
<ObjectSummary>
包含了商品的款式的销售计划。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="tags"
    types={[<Mdx>array</Mdx>]}
>
<ObjectSummary>
该商品的标签。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="template_suffix"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
该商品的自定义模板的名字。

名字中不会包含 `product.`前缀，或者文件的后缀(`.json` or `.html`)。

如果商品没有被分配自定义模板，会返回 `null`。


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


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="subtitle"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
商品的摘要。


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


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="url"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
该商品的相对 URL 地址。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="vendor"
    types={[<Mdx>array</Mdx>]}
>
<ObjectSummary>
该商品的供应商。


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


