Create Order Note

Adds a note to the order. This is an internal note that the merchant might want to add to an order.

POST /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 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

id · string | null

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

text · string | null

Text of the note. Maximum 250 characters.

Response

200

application/json

Success

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

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.