Get Comment by Id

Get Started
Functionality
Learning
Extension
Dev Tooling
APIs
Releases

Essential knowledge

Intended Audience:

Technical User

Author:

Kirill Gaiduk

Changed on:

20 Feb 2025

Overview

The `commentById` Query retrieves a Comment based on a provided Id.
Prerequisites

`COMMENT_VIEW` Permission is required for retrieving a Comment

Key points

Use the `commentById` Query to retrieve an existing Comment
Manage the Comment Permissions at the Account or Retailer level
Apply the "Retailer-specific Comment Permission Check" validation logic with the `fc.graphql.comment.access` Setting (`retailer` value)

GraphQL Reference documentation

The GraphQL Reference should be treated as the source of truth for documentation.

Inputs

The Input arguments for retrieving a single Comment:

Argument	Type	Description
`id`	ID!	Id of the Comment

Validation

Comment Permissions could be managed at the Account or Retailer level, which is controlled via the `fc.graphql.comment.access` Setting. The `retailer` Setting value enables the Retailer-specific access management, so the validation logic is applied to verify that your User has the correct rights to execute the `commentById` Query - "Retailer-specific Comment Permission Check":

A target Comment is found by its Id (input)
A Comment Entity `retailerId` field stores a Retailer of the associated Entity
The Comment `retailerId` is compared to the querying User `retailerId` (defined with the User Role Context Id)
The Comment is retrieved upon the mentioned (User and Comment) `retailerId`'s match

Warning

Otherwise, `null` is returned.Therefore, you should:

Fix your Get Comment Payload (e.g., reconsider the input Comment Id)
Ask your Admin for the required Permission(s) provisioning

Reminder

The "Retailer-specific Comment Permission Check" is not applied when:

The `fc.graphql.comment.access` Setting is set with the `account` value
The Comment has an empty `retailerId`

Response

The response consists of the details of the Comment:

Field	Type	Description	Notes
`id`	ID!	Id of the Comment
`entityType`	String!	Type of the Entity	For example: `ORDER` `FULFILMENT` `ORDER_ITEM` `PRODUCT_CATALOGUE`
`entityId`	ID	Id of the Entity
`entityRef`	String	Reference of the Entity
`text`	String!	Comment text	Max character limit: 200
`createdOn`	DateTime	Time of the Comment creation
`updatedOn`	DateTime	Time of the Comment last update
`user`	User	The author of the Comment	Filled in upon the Comment creation Updated upon the Comment update `USER_VIEW` Permission is required

Sample Payload

1query commentById ($id: ID!) {
2    commentById (id: $id) {
3        id
4        entityType
5        entityId
6        entityRef
7        text
8        createdOn
9        updatedOn
10        user {
11           username
12           id
13           ref
14           primaryEmail
15           firstName
16           lastName
17           timezone
18        }
19    }
20}

1{
2  "id": 123
3}

The response consists of the details of the Comment:

Field	Type	Description	Notes
`id`	ID!	Id of the Comment
`entityType`	String!	Type of the Entity	For example: `ORDER` `FULFILMENT` `ORDER_ITEM` `PRODUCT_CATALOGUE`
`entityId`	ID	Id of the Entity
`entityRef`	String	Reference of the Entity
`text`	String!	Comment text	Max character limit: 200
`createdOn`	DateTime	Time of the Comment creation
`updatedOn`	DateTime	Time of the Comment last update
`user`	User	The author of the Comment	Filled in upon the Comment creation Updated upon the Comment update `USER_VIEW` Permission is required

Get Comment by Id

Overview

Key points

Inputs

Validation

Response

Sample Payload

Kirill Gaiduk

Building Blocks

By Type

Helpful Resources

Quick Links