Skip to main content
GET
/
commerce
/
returns
/
{returnId}
/
notes
/
{noteId}
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "text": "<string>",
  "auditInfo": {
    "updateDate": "2023-11-07T05:31:56Z",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "createBy": "<string>"
  }
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

returnId
string
required

Unique identifier of the return whose note you want to get.

noteId
string
required

Unique identifier of the note whose text you want to get.

Query Parameters

responseFields
string

limits which fields are returned in the response body

Response

Success

Internal notes that a merchant may add to the order. Maximum 250 characters.

id
string | null

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

text
string | null

Text of the note. Maximum 250 characters.

auditInfo
object