Skip to content
ShopentlyLearn

List · Comments

Read comments and moderation status

GET/api/v1/addons/shopently.blog/comments

Authentication
Bearer
Available from
BASIC
Required installed module
shopently.blog · Module contract version 1
Required permissions
addon.shopently.blog:comment_read

Code examples

Request example

cURL

: "${SHOPENTLY_SHOP_URL:?}"

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request GET \
  --header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
  --url "${SHOPENTLY_SHOP_URL%/}"'/api/v1/addons/shopently.blog/comments?limit=10&post_id=2103ba96-2713-420b-b197-8a008730c851'

PHP

<?php
declare(strict_types=1);

$baseUrl = rtrim(getenv('SHOPENTLY_SHOP_URL') ?: '', '/');
$origin = parse_url($baseUrl);
if (!$origin || ($origin['scheme'] ?? '') !== 'https' || empty($origin['host']) ||
    isset($origin['user'], $origin['pass']) || isset($origin['user']) || isset($origin['path']) ||
    isset($origin['query']) || isset($origin['fragment'])) {
    throw new RuntimeException('SHOPENTLY_SHOP_URL must be an HTTPS origin');
}
$credential = getenv('SHOPENTLY_ACCESS_TOKEN') ?: '';
if ($credential === '' || strpbrk($credential, "\r\n") !== false) {
    throw new RuntimeException('Invalid credential');
}
$headers = [];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/addons/shopently.blog/comments?limit=10&post_id=2103ba96-2713-420b-b197-8a008730c851');
curl_setopt_array($handle, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_FOLLOWLOCATION => false,
    CURLOPT_PROTOCOLS => CURLPROTO_HTTPS,
    CURLOPT_SSL_VERIFYPEER => true,
    CURLOPT_SSL_VERIFYHOST => 2,
    CURLOPT_CONNECTTIMEOUT => 5,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HEADERFUNCTION => static function ($handle, string $line) use (&$responseHeaders): int {
        if (str_contains($line, ':')) {
            [$name, $value] = explode(':', $line, 2);
            $responseHeaders[strtolower(trim($name))] = trim($value);
        }
        return strlen($line);
    },
]);
$raw = curl_exec($handle);
$status = curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
$error = curl_error($handle);
curl_close($handle);
if ($raw === false) {
    throw new RuntimeException('Transport error: ' . $error);
}
if ($status < 200 || $status >= 300) {
    throw new RuntimeException('HTTP ' . $status . '; request_id=' .
        ($responseHeaders['x-request-id'] ?? '') . '; retry_after=' . ($responseHeaders['retry-after'] ?? ''));
}
$result = $raw === '' ? null : json_decode($raw, true, 512, JSON_THROW_ON_ERROR | JSON_BIGINT_AS_STRING);
echo json_encode($result, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE), PHP_EOL;

Python

from contextlib import ExitStack
import json
import os
from urllib.parse import urlsplit

import requests  # python -m pip install requests

base_url = os.environ["SHOPENTLY_SHOP_URL"].rstrip("/")
origin = urlsplit(base_url)
if origin.scheme != "https" or not origin.hostname or origin.username or origin.password or origin.path or origin.query or origin.fragment:
    raise ValueError("SHOPENTLY_SHOP_URL must be an HTTPS origin")
credential = os.environ['SHOPENTLY_ACCESS_TOKEN']
if not credential or "\r" in credential or "\n" in credential:
    raise ValueError("Invalid credential")
headers = {}
headers["Authorization"] = 'Bearer' + " " + credential
body = None
if body is not None:
    headers["Content-Type"] = "application/json"

with ExitStack() as stack:
    session = stack.enter_context(requests.Session())
    files = None
    if False:
        image = stack.enter_context(open(os.environ["SHOPENTLY_IMAGE_FILE"], "rb"))
        if os.fstat(image.fileno()).st_size > 5242880:
            raise ValueError("Image exceeds 5 MiB")
        files = {"file": ("article.png", image, "image/png")}
    response = session.request(
        'GET', base_url + '/api/v1/addons/shopently.blog/comments?limit=10&post_id=2103ba96-2713-420b-b197-8a008730c851', headers=headers,
        data=body.encode("utf-8") if body is not None else None, files=files,
        timeout=(5, 30), allow_redirects=False,
    )
    if not 200 <= response.status_code < 300:
        raise RuntimeError(f"HTTP {response.status_code}; request_id={response.headers.get('X-Request-ID', '')}; retry_after={response.headers.get('Retry-After', '')}")
    if False:
        if response.headers.get("Content-Type") != "image/webp" or len(response.content) > 5242880:
            raise ValueError("Unexpected image response")
        with open(os.environ["SHOPENTLY_OUTPUT_FILE"], "xb") as output:
            output.write(response.content)
    else:
        result = response.json() if response.content else None
        print(json.dumps(result, ensure_ascii=False, indent=2))

Response example 200

JSON
{
  "data": [
    {
      "actor_kind": "api",
      "body_preview": "Zapraszamy do zadawania pytań.",
      "created_at": "2026-10-07T23:17:44.892022Z",
      "display_name": "Redakcja",
      "edited_at": null,
      "id": "2247b58d-1521-4fc0-9eec-6c47c259c181",
      "locale": "pl",
      "post_id": "2103ba96-2713-420b-b197-8a008730c851",
      "status": "approved",
      "version": 1
    }
  ],
  "meta": {
    "pagination": {
      "has_more": false,
      "limit": 10,
      "next_cursor": null
    },
    "request_id": "a27f02dc-4061-4716-9766-a1eec23ac186"
  }
}

Overview

Run your store’s blog with HTML articles, photos, authors and search metadata. Save drafts, prepare translations and publish immediately or at a chosen time in a specific time zone. Manage comments and moderation in the panel; an external generator can use the API with the permissions you grant.

BASIC · api.enabled · addons.use(shopently.blog) · addon.shopently.blog:comment_read

Parameters

Query parameters

limitIntegerOptional

Maximum number of records on this page.

minimum: 1maximum: 100
Default: 50Example: 10
cursorString nullOptional

Opaque continuation value returned by the previous page.

String:maxLength: 512
post_idString nullOptional

Article

String:format: "uuid"
Example: "2103ba96-2713-420b-b197-8a008730c851"
statusString nullOptional

Status accepted by this specific operation.

Constraints · String 1
enum
["pending", "approved", "rejected", "spam"]

This operation does not accept a JSON body.

Responses

Response 200

dataArray <ObjectAdditional fields: No> Required

Successful response payload.

maxItems: 100
Fields · data

ObjectAdditional fields: No

actor_kindStringRequired

Actor type

Constraints
enum
["administrator", "customer", "api"]
body_previewStringRequired

Comment

minLength: 1maxLength: 250
created_atStringRequired

Creation time.

format: "date-time"
display_nameStringRequired

Name

minLength: 1maxLength: 160
edited_atString nullRequired

Edited

String:format: "date-time"
idStringRequired

Resource identifier; preserve it as returned.

format: "uuid"
localeStringRequired

Language selected for this request.

minLength: 2maxLength: 35
Constraints
pattern
"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$"
post_idStringRequired

Article

format: "uuid"
statusStringRequired

Status accepted by this specific operation.

Constraints
enum
["pending", "approved", "rejected", "spam"]
versionIntegerRequired

Resource version used for concurrency control.

minimum: 1maximum: 9223372036854775807
metaObjectAdditional fields: NoRequired

Response metadata.

Fields · meta
paginationObjectAdditional fields: NoRequired

Cursor pagination metadata.

Fields · pagination
has_moreBooleanRequired

Whether another page is available.

limitIntegerRequired

Maximum number of records on this page.

minimum: 1maximum: 100
next_cursorString nullRequired

Continuation value for the next page, or null.

String:maxLength: 512
request_idStringRequired

Request identifier; in response metadata this identifies the HTTP request.

minLength: 1maxLength: 100
Response example

HTTP status

200
Successful response Schema
400
Invalid request
401
Authentication required
403
Permission denied
404
Resource not found
409
Version conflict
422
Validation failed
429
Rate limit exceeded
Other HTTP statuses (7)
405
Method not allowed
413
Request too large
415
Unsupported media type
500
Server error
502
API gateway error
503
Service unavailable
504
Gateway timeout

Error catalog: ErrorResponse

Headers

401

WWW-AuthenticateStringOptional

Authentication scheme required by the server.

405

AllowStringOptional

HTTP methods supported by this resource.

429, 503

Retry-AfterIntegerOptional

Minimum delay before retrying, in seconds.

minimum: 0