Backend API: Retrieve order comments

Last updated:
Edit on GitHub

The order-comments resource of the Backend API lets Back Office integrations read the comment thread of a placed order—the same comments shown on the order screens. This document describes how to retrieve an order’s comments.

Installation

The endpoints are provided by the OrderExperienceManagement module. For details on installing it, see Install the Orders Backend API feature.

Retrieve order comments

To retrieve the comments of an order, send the request:

GET /orders/{{orderReference}}/comments

PATH PARAMETER DESCRIPTION
{{orderReference}} Reference of the order to retrieve comments of. To get it, retrieve orders.

Request

HEADER KEY HEADER VALUE REQUIRED DESCRIPTION
Authorization string ✓ Alphanumeric string that authorizes the Back Office user to send requests to protected resources. Get it by authenticating as a Back Office user.

Request sample: retrieve an order’s comments

GET https://glue-backend.mysprykershop.com/orders/DE--1234/comments

Response

Comments are returned oldest first. The thread is small enough that the resource is not paginated. An order with no comments yet returns an empty data array rather than a 404.

Response sample: retrieve order comments 
{
    "data": [
        {
            "id": "DE--1234",
            "type": "order-comments",
            "attributes": {
                "orderReference": "DE--1234",
                "message": "Customer asked to hold the shipment until Friday.",
                "username": "Admin Spryker",
                "createdAt": "2026-08-27 15:12:03.000000",
                "updatedAt": "2026-08-27 15:12:03.000000"
            }
        },
        {
            "id": "DE--1234",
            "type": "order-comments",
            "attributes": {
                "orderReference": "DE--1234",
                "message": "Shipment released.",
                "username": "Admin Spryker",
                "createdAt": "2026-08-28 08:30:11.000000",
                "updatedAt": "2026-08-28 08:30:11.000000"
            }
        }
    ]
}
ATTRIBUTE TYPE DESCRIPTION
orderReference String Order the comment belongs to.
message String The comment body.
username String Display name of the operator who wrote the comment. May be absent on some existing comments.
createdAt String Timestamp the comment was created at.
updatedAt String Timestamp the comment was last updated at.
No single-comment endpoint

There is no endpoint to retrieve, update, or delete one comment: comments have no addressable identifier and no reliable authorship reference, so per-comment access or edit and delete cannot be enforced correctly. Always retrieve the full thread.

Possible errors

STATUS CODE REASON
404 N/A No order with the specified orderReference.
401 N/A The Authorization header is missing, or the access token is invalid or expired.
403 N/A The authenticated Back Office user is not allowed to access the order-comments resource.

To view generic errors and status codes of the Backend API, see Backend API request and response reference.