Skip to content

Add Order Comment

Adds a comment to an order. When customerNotified=true, the customer is sent a notification email with the comment.

No permission gate — any authenticated admin can add a comment.

Endpoint

EndpointMethod
/api/admin/orders/{orderId}/commentsPOST

Request body

FieldTypeRequiredNotes
commentstringyesFree-form comment body.
customerNotifiedbooleannoWhen true, the customer is emailed the comment. Defaults to false.

Errors

HTTPLang keyMessage
422bagistoapi::app.admin.order.actions.comment.emptyComment is required.

Sample 422 response

json
{
    "type": "/errors/422",
    "title": "Bad Request",
    "status": 422,
    "detail": "Comment is required."
}

Released under the MIT License.