Get Comment List

GET 
/openapi/2022-01/comments/list

Retrieve a list of comments for a specific product or across multiple products, based on various filters.

Request

Query Parameters

product_id string

Product's ID

created_at_min string

Filter comments created at or after date, for example: 2018-10-01T16:15:47-04:00

created_at_max string

Filter comments created at or before date, for example: 2018-10-01T16:15:47-04:00

updated_at_min string

Filter comments last updated at or after date, for example: 2018-10-01T16:15:47-04:00

updated_at_max string

Filter comments last updated at or before date, for example: 2018-10-01T16:15:47-04:00

sort_by string

Specify the sort field, for example: star or created_at

sort_direction string

Specify the sort direction, for example: asc or desc

page int32

Page number

limit int32

Limit per page, 10, 20, 50, 100 allowed

status string

Comment status, 1: published, 0: unpublished

Responses

200

200

application/json

Schema

Schema

comments object[]
Array [
idstring
Example: 23532434
store_idstring
Example: 633130
usernamestring
Example: Joey
emailstring
Example:
starstring
Example: 5.0
likestring
Example: 10
contentstring
Example: Cheap but beautiful
imgstring
Example: ["0048955f731656d0e7fc8b5e03509ed7.webp?width=650&height=433"]
statusstring
Example: 1
typestring
Example: 1
product_idstring
Example: a1a88be0-a1d4-47e4-a2f2-ba6e131cf447
created_atstring
Example: 2024-04-24 14:02:39
updated_atstring
Example: 2024-04-25 08:22:59
countrystring
Example: CN
is_featuredstring
Example: 0
is_verifiedstring
Example: 0
client_id
anonymousstring
Example: 0
]
totalstring
Example: 6
pagestring
Example: 1

Example

{
  "comments": [
    {
      "id": "23532434",
      "store_id": "633130",
      "username": "Joey",
      "email": "",
      "star": "5.0",
      "like": "10",
      "content": "Cheap but beautiful",
      "img": "[\"0048955f731656d0e7fc8b5e03509ed7.webp?width=650&height=433\"]",
      "status": "1",
      "type": "1",
      "product_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
      "created_at": "2024-04-24 14:02:39",
      "updated_at": "2024-04-25 08:22:59",
      "country": "CN",
      "is_featured": "0",
      "is_verified": "0",
      "client_id": {},
      "anonymous": "0"
    }
  ],
  "total": "6",
  "page": "1"
}

Result

{
  "comments": [
    {
      "id": "23532434",
      "store_id": "633130",
      "username": "Joey",
      "email": "",
      "star": "5.0",
      "like": "10",
      "content": "Cheap but beautiful",
      "img": "[\"0048955f731656d0e7fc8b5e03509ed7.webp?width=650&height=433\"]",
      "status": "1",
      "type": "1",
      "product_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
      "created_at": "2024-04-24 14:02:39",
      "updated_at": "2024-04-25 08:22:59",
      "country": "CN",
      "is_featured": "0",
      "is_verified": "0",
      "client_id": null,
      "anonymous": "0"
    }
  ],
  "total": "6",
  "page": "1"
}

400

400

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "params is invalid"
  ]
}

Result

{
  "errors": [
    "params is invalid"
  ]
}