Get Account Note

Retrieves the contents of a particular note attached to a specified customer account.

GET /commerce/customer/accounts/{accountId}/notes/{noteId}

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"
  },
  "content": "<string>",
  "id": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

accountId · integer<int32> · required

Unique identifier of the customer account that contains the note to retrieve.

noteId · integer<int32> · required

Unique identifier of a particular note that you want to retrieve.

Query Parameters

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

Success

Note added to the customer account. Merchants can add internal notes, for example, to keep track of a customer's interests or complaints.

auditInfo · object

Show child attributes

content · string | null

Content of the note that the merchant added.

id · integer<int32>

Unique identifier of the note.