---
title: "productVariants"
description: "商品变体列表查询"
doc_type: graphql
doc_category: adminGraphQL
doc_version: v20270301
source_url:
  html: 'https://developer.shopline.com/zh-hans-cn/docs/admin-graph-ql-api/products-and-collections/queries/product-variants'
  md: 'https://developer.shopline.com/zh-hans-cn/docs/admin-graph-ql-api/products-and-collections/queries/product-variants.md'
---
# productVariants

商品变体列表查询

- **API Version:** v20270301
- **API Type:** Admin
- **API Protocol:** GraphQL
- **Operation Type:** Query

## Type Signature

`ProductVariantConnection`

## Arguments

* `sortKey`

  [ProductVariantSortKeys](https://developer.shopline.com/zh-hans-cn/docs/admin-graph-ql-api/products-and-collections/enums/product-variant-sort-keys.md)

  使用指定的排序键以升序方式对基本列表进行排序

* `after`

  [String](https://developer.shopline.com/zh-hans-cn/docs/admin-graph-ql-api/common/scalars/string.md)

  返回指定游标之后的元素。如果指定了该参数，也必须要指定 `first` 参数。

* `before`

  [String](https://developer.shopline.com/zh-hans-cn/docs/admin-graph-ql-api/common/scalars/string.md)

  返回指定游标之前的元素。如果指定了该参数，也必须要指定 `last` 参数。

* `first`

  [Int](https://developer.shopline.com/zh-hans-cn/docs/admin-graph-ql-api/common/scalars/int.md)

  返回列表中的前 n 个元素。

* `last`

  [Int](https://developer.shopline.com/zh-hans-cn/docs/admin-graph-ql-api/common/scalars/int.md)

  返回列表中的最后 n 个元素。

* `reverse`

  [Boolean](https://developer.shopline.com/zh-hans-cn/docs/admin-graph-ql-api/common/scalars/boolean.md)

  是否反转列表的顺序。
  
  ● true：反转
  
  ● false：不反转
  
  默认值：false

* `query`

  [String](https://developer.shopline.com/zh-hans-cn/docs/admin-graph-ql-api/common/scalars/string.md)

  对查询应用一个或多个过滤器。
  
  | 参数 | 描述 |
  | --- | --- |
  | barcode | 与产品关联的条形码的值 |
  | collection | 分类的ID |
  | gift_card | 是否礼品卡（传入布尔值） |
  | inventory_quantity | 产品变体的可售库存数 |
  | location_id | 位置的ID |
  | option1 | 产品变体的第1个选项值 |
  | option2 | 产品变体的第2个选项值 |
  | option3 | 产品变体的第3个选项值 |
  | option4 | 产品变体的第4个选项值 |
  | option5 | 产品变体的第5个选项值 |
  | product_ids | 商品的ID（暂不支持传入多个ID） |
  | product_status | 产品状态 |
  | product_type | 产品的自定义类型 |
  | sku | 产品变体的 SKU，区分大小写的字符串 |
  | tag | 产品标签 |
  | taxable | 变体在出售时是否需征税（传入布尔值） |
  | title | 产品标题 |
  | updated_at | 变体最后修改的日期和时间 |
  | vendor | 厂商 |
  | spu | 产品的SPU码 |
  
  :::tip{title="tip"}
  当前最多支持5个参数，后续将会持续优化。
  :::
  
  #### 语法参考
  
  ```js
  title:'test' AND inventory_quantity:>=1000
  
  ```
  

## Returns

* `edges`

  [[ProductVariantEdge!]](https://developer.shopline.com/zh-hans-cn/docs/admin-graph-ql-api/products-and-collections/objects/product-variant-edge.md)

  边缘节点列表

* `pageInfo`

  [PageInfo!](https://developer.shopline.com/zh-hans-cn/docs/admin-graph-ql-api/common-objects/objects/page-info.md)

  用于帮助分页的信息

## Code Example

```graphql
 {
	productVariants(sortKey, after, before, first, last, reverse, query ) 
		 {
			# ProductVariantConnection fields
		}
}
```

## Error Handling

关于更多通用错误码说明，参考：[状态码和错误码](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/graph-ql-admin-api/overview.md#status-and-error-codes)。