Get Order Notes

Retrieves a list of all notes for an order.

GET /commerce/orders/{orderId}/notes

Error

A valid request URL is required to generate request examples

200

[
  {
    "auditInfo": {
      "createBy": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "updateBy": "<string>",
      "updateDate": "2023-11-07T05:31:56Z"
    },
    "id": "<string>",
    "text": "<string>"
  }
]

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

orderId · string · required

Unique identifier of the order whose notes you want to get.

Query Parameters

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

Success

auditInfo · object

Show child attributes

id · string | null

Unique identifier of the note. System-supplied and read-only.

text · string | null

Text of the note. Maximum 250 characters.