Query list of comments

Requires read_content access scope.

For more info , refer to:

[]

access permission

GET https://{handle}.myshopline.com/admin/openapi/v20250601/store/comments.json

[]

handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .

[]

query comment list

Query Parameters

blog_collection_id string
[]
Comment on the blog collection id for articles belonging to
[]
Example: 639bfda0ee877c4a9bd600b6
blog_id string
[]
Comment on blog id
[]
Example: 63a2afa527797d5cedcecb52
created_at_max string
[]
Review created max time ISO 8601
[]
Example: 2022-08-03T10:45:00+08:00
created_at_min string
[]
Review create minimum time ISO 8601
[]
Example: 2022-08-03T10:45:00+08:00
fields string
[]
Limited return object fields , multiple separated by ',' are used
[]
Example: body_html,author
limit integer
[]
Query of query quantity , default 50 , can not exceed 250
[]
Example: 100
published_at_max string
[]
Post review max time ISO 8601
[]
Example: 2022-08-03T10:45:00+08:00
published_at_min string
[]
Post review min time ISO 8601
[]
Example: 2022-08-03T10:45:00+08:00
published_status string
[]
Launch status , value : published ( posted status ) ; unpublished : ( not released status ) ; any : ( all status ) ;
[]
Example: published
since_id string
[]
Show data after this id
[]
Example: 63aaacb8b0fea649647a241a
status string
[]
Status : value : unapproved ( review waiting to approve ) ; published ( posted status ) ;
updated_at_max string
[]
Update max time ISO 8601
[]
Example: 2022-08-03T10:45:00+08:00
updated_at_min string
[]
Update min time ISO 8601
[]
Example: 2022-08-03T10:45:00+08:00

Request Headers

Content-Type required
[]
The value of this field is fixed to application/json; charset=utf-8
Authorization string required
[]
The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Response

[]

For more information about status codes, see Http status code.

Response Headers

traceId
[]
traceId

Response Body

commentsobject[]
[]
Review information
author string
[]
Author of the review
[]
Example: demo-author
blog_collection_id string
[]
Comment on the blog collection id for articles belonging to
[]
Example: 639bfda0ee877c4a9bd600b6
blog_id string
[]
Comment on blog id
[]
Example: 63a2afa527797d5cedcecb52
body string
[]
Comment content
[]
Example: demo-content
body_html string
[]
Body content with html markings
[]
Example: <p>demo-content</p>
create_at string
[]
Created time for reviews ISO 8601
[]
Example: 2022-08-03T10:45:00+08:00
email string
[]
Comment on the e-mail address of the author
[]
Example: demo@qq.com
id string
[]
Comment id
[]
Example: 63aaa20f6b7b014b289c0765
ip string
[]
Ip to post a review
[]
Example: 172.28.173.136
published_at string
[]
Time to post a review ISO 8601
[]
Example: 2022-08-03T10:45:00+08:00
status string
[]
Comment status , post value : unapproved ( default state , comment waiting to be approved , c end does not show this state comment ) ; published : ( posted state , and visible to users on the end of c ) ; spam : ( garbage review , c end )Removed : ( review is marked as deleted status , not visible for users on the end of the c )
[]
Example: unapproved
updated_at string
[]
Update time ISO 8601
[]
Example: 2022-08-03T10:45:00+08:00
user_agent string
[]
User agent information

API Explorer

Debugger

Examples

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

Authorization — header required

blog_collection_id — query

blog_id — query

created_at_max — query

created_at_min — query

fields — query

limit — query

published_at_max — query

published_at_min — query

published_status — query

since_id — query

status — query

updated_at_max — query

updated_at_min — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/store/comments.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal