Skip to content

List Order Comments

Cursor-paginated list of one order's comments, newest first — the comment thread shown on the admin Sales → Orders → View screen.

Operation

OperationType
adminOrderCommentsQueryCollection (cursor)

Details

  • Requires an admin Bearer token in the Authorization header.
  • orderId is required — it scopes the list to a single order. Omitting it returns an "order not found" error.
  • Cursor pagination — pass first for the page size and after (the endCursor from the previous page) to advance; pageInfo.hasNextPage tells you when to stop, totalCount is the total for that order.
  • Comments are returned newest first.

Node fields

FieldNotes
idAlways null — comments have no standalone endpoint. Use _id.
_idThe comment's integer id.
orderIdThe order the comment belongs to.
commentThe comment text.
customerNotifiedtrue if the customer was emailed when the comment was added.
createdAt, updatedAtTimestamps.

The REST equivalent (GET /api/admin/orders/{orderId}/comments) returns the same fields in a { data, meta } envelope instead of a cursor connection.

Released under the MIT License.