Create Order Note - Kibo Documentation

{ "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 to which you want to add a note.

Query Parameters

responseFields

string

limits which fields are returned in the response body

Body

application/json

Text of the note. Maximum 256 characters.

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

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

Response

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

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