Comment - admin-graphql - OBJECT

Version: 2025-01

Description:

A comment on an article.

Access Scopes

`read_content` access scope or `read_online_store_pages` access scope.

Fields

• article: Article - The article associated with the comment.
• author: CommentAuthor! - The comment’s author.
• body: String! - The content of the comment.
• bodyHtml: HTML! - The content of the comment, complete with HTML formatting.
• createdAt: DateTime! - The date and time when the comment was created.
• id: ID! - A globally-unique ID.
• ip: String - The IP address of the commenter.
• isPublished: Boolean! - Whether or not the comment is published.
• publishedAt: DateTime - The date and time when the comment was published.
• status: CommentStatus! - The status of the comment.
• updatedAt: DateTime - The date and time when the comment was last updated.
• userAgent: String - The user agent of the commenter.

Connections

• events: EventConnection!

Related queries

• comment Returns a Comment resource by ID.
• comments List of the shop's comments.

Related mutations

• commentApprove Approves a comment.
• commentNotSpam Marks a comment as not spam.
• commentSpam Marks a comment as spam.

Related Unions

Examples

• Retrieves a single comment by its ID

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query CommentShow($id: ID!) { comment(id: $id) { id body bodyHtml author { name } ip publishedAt status userAgent } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Comment/9450891\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query CommentShow($id: ID!) {\n      comment(id: $id) {\n        id\n        body\n        bodyHtml\n        author {\n          name\n        }\n        ip\n        publishedAt\n        status\n        userAgent\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/Comment/9450891\"\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query CommentShow($id: ID!) {\n    comment(id: $id) {\n      id\n      body\n      bodyHtml\n      author {\n        name\n      }\n      ip\n      publishedAt\n      status\n      userAgent\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/Comment/9450891\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query CommentShow($id: ID!) {\n    comment(id: $id) {\n      id\n      body\n      bodyHtml\n      author {\n        name\n      }\n      ip\n      publishedAt\n      status\n      userAgent\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/Comment/9450891\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query CommentShow($id: ID!) {\n    comment(id: $id) {\n      id\n      body\n      bodyHtml\n      author {\n        name\n      }\n      ip\n      publishedAt\n      status\n      userAgent\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/Comment/9450891\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query CommentShow($id: ID!) {\n  comment(id: $id) {\n    id\n    body\n    bodyHtml\n    author {\n      name\n    }\n    ip\n    publishedAt\n    status\n    userAgent\n  }\n}"
        

  input: {
    "id": "gid://shopify/Comment/9450891"
  }

  response: {
    "data": {
      "comment": {
        "id": "gid://shopify/Comment/9450891",
        "body": "Check my casino at ... This will be marked as spam by akismet, because of the author name.",
        "bodyHtml": "<p>Check my casino at ... This will be marked as spam by akismet, because of the author name.</p>",
        "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"
      }
    }
  }