---
title: "variant"

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

# variant


    商品款式。

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



    <div>
    
        ## 属性

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


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="barcode"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
该款式的条形码。


</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="featured_image"
    types={[<Mdx>[image](https://developer.shopline.com/zh-hans-cn/docs/sline/object/image.md)</Mdx>]}
>
<ObjectSummary>
该款式的图片。

> **提示**
>
> 此值与 `variant.image` 的值相同。
</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="featured_media"
    types={[<Mdx>array</Mdx>]}
>
<ObjectSummary>
该款式的第一个媒体对象。


</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>
该款式的图片。 

> **提示**
>
> 此值与 `variant.featured_image` 的值相同。
</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="inventory_quantity"
    types={[<Mdx>integer</Mdx>]}
>
<ObjectSummary>
该款式的库存数量。

如果未跟踪库存，则返回 `0`。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="option1"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
商品款式的第一个规格值。

如果没有第一个商品规格，则返回 `null`。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="option2"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
商品款式的第二个规格值。

如果没有第二个商品规格，则返回 `null`。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="option3"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
商品款式的第三个规格值。

如果没有第三个商品规格，则返回 `null`。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="option4"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
商品款式的第四个规格值。

如果没有第四个商品规格，则返回 `null`。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="option5"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
商品款式的第五个规格值。

如果没有第五个商品规格，则返回 `null`。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="options"
    types={[<Mdx>string</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="requires_selling_plan"
    types={[<Mdx>boolean</Mdx>]}
>
<ObjectSummary>
商品款式是否需要销售计划才可加入购物车。
- `true`: 需要
- `false`: 不需要


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="requires_shipping"
    types={[<Mdx>boolean</Mdx>]}
>
<ObjectSummary>
商品款式是否需要运输。
- `true`: 需要
- `false`: 不需要


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="selected"
    types={[<Mdx>boolean</Mdx>]}
>
<ObjectSummary>
商品款式是否被选中。
- `true`: 选中
- `false`: 未选中

> **提示**
>
> 被选中的款式是由 variant URL参数来决定。这个 URL 参数仅在商品页面的 URL 中有效。
</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="sku"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
款式的 SKU (货号)。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="store_availabilities"
    types={[<Mdx>array</Mdx>]}
>
<ObjectSummary>
商店关于该款式的可售卖情况。

该数组仅在以下情况中被定义：

- `variant.selected` 为 `true`
- 款式是商品的第一个可售卖的款式。比如，`product.first_available_variant` 或者 `product.selected_or_first_available_variant`。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="taxable"
    types={[<Mdx>boolean</Mdx>]}
>
<ObjectSummary>
商品款式是否需要征税。
- `true`：需要收税
- `false`：不需要收税


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="title"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
每个款式规格的组合，以 `/` 分隔。


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="url"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
款式的 URL。

款式 URL 使用以下的结构：`/products/[product-handle]?sku=[variant-id]`


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty
    name="weight_in_unit"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
款式的重量。


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


