Get Return Notes - Kibo Documentation

Error

A valid request URL is required to generate request examples

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

GET

commerce

returns

{returnId}

notes

Error

A valid request URL is required to generate request examples

[
  {
    "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

returnId

string

required

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

Query Parameters

responseFields

string

limits which fields are returned in the response body

Response

auditInfo

object

Show child attributes

string | null

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

text

string

Text of the note. Maximum 250 characters.

Maximum string length: 500

Delete Return Note

Create Return Note