跳到主要内容

产品评论 API

本 API 提供了访问产品评论数据的接口。

功能描述:

该 API 允许您:

  • 获取产品评论: 您可以根据产品 ID 获取相关的评论列表。
  • 过滤评论: 您可以根据不同的条件(例如,评分、日期)过滤评论。
  • 查看评论详情: 您可以查看单个评论的详细信息。

API 端点:

  • GET /api/v1/products/{product_id}/reviews:获取指定产品 ID 的所有评论。

请求参数:

参数名类型必填描述
product_idint产品 ID
pageint页码,默认为 1
page_sizeint每页显示的数量,默认为 20
sort_bystring排序字段,例如 rating, date
sort_orderstring排序方式,asc (升序) 或 desc (降序)

响应格式:

{
"total_count": %d,
"page": %d,
"page_size": %d,
"reviews": [
{
"id": %d,
"product_id": %d,
"user": {
"name": "%s",
"email": "%s"
},
"rating": %d,
"comment": "%s",
"date": "%s"
}
]
}

示例请求:

GET /api/v1/products/123/reviews?page=2&page_size=10&sort_by=rating&sort_order=desc

错误处理:

状态码描述
400错误的请求参数。
404未找到指定的产品或评论。
500服务器内部错误。

版本:

v1.0

注意事项:

  • 请确保您已获得访问 API 的权限。
  • API 使用速率限制,请遵守相关规定。
  • Pro 版本提供更高级的功能和更高的速率限制。

其他:

  • 您可以在 这里 找到更详细的文档。
  • 如果您有任何问题,请联系我们的技术支持团队。
  • View 更多信息。

获取产品评论

此接口返回产品评论,并且可以显示特定产品或特定分类的结果。

GET /products/reviews
GET /products/reviews?category_id=1,2,3
GET /products/reviews?product_id=1,2,3
GET /products/reviews?orderby=rating&order=desc
属性类型是否必选描述
pageinteger集合的当前页。
per_pageinteger结果集中返回的最大项目数。
offsetinteger通过指定数量的项目偏移结果集。
orderstring按照升序或降序排序属性。 允许的值:asc, desc
orderbystring按照对象属性对集合进行排序。 允许的值:date, date_gmt, id, rating, product
category_idstring将结果集限制为来自特定分类 ID 的评论。
product_idstring将结果集限制为来自特定产品 ID 的评论。
curl "https://example-store.com/wp-json/wc/store/v1/products/collection-data?calculate_price_range=true&calculate_attribute_counts=pa_size,pa_color&calculate_rating_counts=true"

示例响应:

[
{
"id": 83,
"date_created": "2022-01-12T15:42:14",
"formatted_date_created": "一月 12, 2022",
"date_created_gmt": "2022-01-12T15:42:14",
"product_id": 33,
"product_name": "带有Logo的帽子",
"product_permalink": "https://store.local/product/beanie-with-logo/",
"product_image": {
"id": 56,
"src": "https://store.local/wp-content/uploads/2021/11/beanie-with-logo-1.jpg",
"thumbnail": "https://store.local/wp-content/uploads/2021/11/beanie-with-logo-1-324x324.jpg",
"srcset": "https://store.local/wp-content/uploads/2021/11/beanie-with-logo-1.jpg 800w, https://store.local/wp-content/uploads/2021/11/beanie-with-logo-1-324x324.jpg 324w, https://store.local/wp-content/uploads/2021/11/beanie-with-logo-1-100x100.jpg 100w, https://store.local/wp-content/uploads/2021/11/beanie-with-logo-1-416x416.jpg 416w, https://store.local/wp-content/uploads/2021/11/beanie-with-logo-1-300x300.jpg 300w, https://store.local/wp-content/uploads/2021/11/beanie-with-logo-1-150x150.jpg 150w, https://store.local/wp-content/uploads/2021/11/beanie-with-logo-1-768x768.jpg 768w",
"sizes": "(max-width: 800px) 100vw, 800px",
"name": "beanie-with-logo-1.jpg",
"alt": ""
},
"reviewer": "reviewer-name",
"review": "<p>这是一个非常棒的产品。</p>\n",
"rating": 5,
"verified": true,
"reviewer_avatar_urls": {
"24": "https://secure.gravatar.com/avatar/12345?s=24&d=mm&r=g",
"48": "https://secure.gravatar.com/avatar/12345?s=48&d=mm&r=g",
"96": "https://secure.gravatar.com/avatar/12345?s=96&d=mm&r=g"
}
}
]

产品信息

本页面展示了产品信息。

字段说明

  • id: 产品ID
  • date_created: 创建日期
  • formatted_date_created: 格式化的创建日期
  • product_id: 产品ID
  • product_name: 产品名称
  • product_permalink: 固定链接
  • product_image: 产品图片信息
    • src: 图片网址
    • thumbnail: 缩略图网址
    • srcset: 图片集合
    • sizes: 图片尺寸
    • name: 图片名称
    • alt: 图片描述
  • reviewer: 评价者
  • review: 评价内容
  • rating: 评分
  • verified: 是否为已验证的评价
  • reviewer_avatar_urls: 评价者头像网址

示例

以下是一个产品评价的示例:

[
{
"id": 83,
"date_created": "2022-01-12T15:42:14",
"formatted_date_created": "January 12, 2022",
"product_id": 33,
"product_name": "Beanie with Logo",
"product_permalink": "https://store.local/product/beanie-with-logo/",
"product_image": { ... },
"reviewer": "reviewer-name",
"review": "<p>This is a fantastic product.</p>\n",
"rating": 5,
"verified": true,
"reviewer_avatar_urls": { ... }
}
]

详细信息

  • date_created: 表示产品创建的日期和时间。
  • product_name: 产品的名称。
  • product_permalink: 指向产品详情页面的固定链接。
  • product_image: 包含产品图片的各种尺寸和格式的信息。
  • review: 用户对产品的评价内容。
  • rating: 用户对产品的评分,通常是 1 到 5 之间的数字。
  • verified: 指示该评价是否已通过验证。

上传文件

您可以通过点击“上传”按钮来上传文件。上传完成后,您可以设置文件的标题、描述和固定链接。

创建新产品

要创建新产品,请点击“创建”按钮。您需要填写产品名称、描述、价格、图片等信息。

商店设置

在商店设置中,您可以配置商店的名称、地址、联系方式、支付方式、运费规则等。

日志

Log文件记录了系统的运行状态和错误信息。

宽度

Width参数用于设置图像的宽度。

头像

Avatar是用户在论坛或社交媒体上使用的个人图像。

格式

Format是指文件或数据的格式,例如文本格式、图像格式等。

链接

Link是指网页之间的连接。

内容

Content是指文章或网页的文本和媒体。

评分

Rating是指用户对产品或服务的评价。

评价

Review是指用户对产品或服务的详细评价。

For表示为了。

In表示在...里面。

产品

Product是指商店中销售的商品。

日期

Date是指年月日。

增值税

VAT是指增值税。

已创建

Created表示已经创建。

网址

Url是指网址。