---
title: "products"
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/products'
  md: 'https://developer.shopline.com/zh-hans-cn/docs/admin-graph-ql-api/products-and-collections/queries/products.md'
---
# products

返回商品列表

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

## Type Signature

`ProductConnection`

## Arguments

* `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)

  对查询应用一个或多个过滤器。
  
  | 参数 | 描述 |
  | --- | --- |
  | created_at | 创建产品时的日期和时间 |
  | updated_at | 产品最后修改的日期和时间 |
  | title | 产品标题 |
  | tag | 产品标签 |
  | id | 产品ID |
  | barcode | 与产品关联的条形码的值 |
  | gift_card | 是否礼品卡（传入布尔值） |
  | inventory_total | 产品的可售库存数 |
  | out_of_stock_somewhere | 是否部分缺货（传入布尔值） |
  | price | 产品变体的价格，小数格式 |
  | product_type | 产品的自定义类型 |
  | published_status | 在线商店发布状态 |
  | status | 产品状态 |
  | sku | 产品变体的 SKU，区分大小写的字符串 |
  | vendor | 厂商 |
  | spu | 产品的SPU码 |
  
  :::tip{title="tip"}
  当前最多支持30个参数，后续将会持续优化。
  :::
  
  #### 语法参考
  
  ```js
  title:'test' AND inventory_total:>=1000
  
  ```

* `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` 参数。

## Returns

* `edges`

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

  边缘节点列表

* `nodes`

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

  ProductEdge 中包含的节点列表

* `pageInfo`

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

  帮助分页的信息

## Code Example

```graphql
 {
	products(first, last, reverse, query, after, before ) 
		 {
			# ProductConnection 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)。