comments

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default • string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to id • id: Filter by id range.
Anchor to published_status • string: Filter by published status
Anchor to status • string

reverse

•

BooleanDefault:false

Reverse the order of the underlying list.

sortKey

•

CommentSortKeysDefault:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges • [CommentEdge!]!non-null: The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
Anchor to nodesnodes • [Comment!]!non-null: A list of nodes that are contained in CommentEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
Anchor to pageInfopageInfo • PageInfo!non-null: An object that’s used to retrieve cursor information about the current page.

Was this section helpful?

Retrieves a list of comments

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query CommentList {

comments(first: 50) {

nodes {

body

bodyHtml

author {

name

}

publishedAt

status

userAgent

}

}`,

);

const data = await response.json();

query CommentList {
  comments(first: 50) {
    nodes {
      id
      body
      bodyHtml
      author {
        name
      }
      ip
      publishedAt
      status
      userAgent
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query CommentList { comments(first: 50) { nodes { id body bodyHtml author { name } ip publishedAt status userAgent } } }"
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  query CommentList {
    comments(first: 50) {
      nodes {
        id
        body
        bodyHtml
        author {
          name
        }
        ip
        publishedAt
        status
        userAgent
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query CommentList {
    comments(first: 50) {
      nodes {
        id
        body
        bodyHtml
        author {
          name
        }
        ip
        publishedAt
        status
        userAgent
      }
    }
  }`,
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query CommentList {
    comments(first: 50) {
      nodes {
        id
        body
        bodyHtml
        author {
          name
        }
        ip
        publishedAt
        status
        userAgent
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"comments": {

"nodes": [

{

"id": "gid://shopify/Comment/9450891",

"body": "Check my casino at ... This will be marked as spam by akismet, because of the author name.",

"bodyHtml": "Check my casino at ... This will be marked as spam by akismet, because of the author name.",

"author": {

"name": "viagra-test-123"

"ip": "127.0.0.1",

"publishedAt": null,

"status": "SPAM",

"userAgent": "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_5_4; en-us) AppleWebKit/525.18 (KHTML, like Gecko) Version/3.1.2 Safari/525.20.1"

{

"id": "gid://shopify/Comment/52127930",

"body": "Hi author, I really _like_ what you're doing there.",

"bodyHtml": "Hi author, I really like what you're doing there.",