Create a New Note

POST

/v1/notes

Appends a new note to a specific resource (such as an Order or Shipment). Use this to log internal communication, special merchant instructions, or supplemental information required for fulfillment.

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Body Params

application/json

Examples

Responses

🟢201

application/json

Created

Body

🟠400

🟠401

🟠403

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.stg.ordermesh.io/note/v1/notes' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "content": "Customer address issue could not be fixed automatically. Manual intervention required. Merchant has been notified to reach out to the customer for confirmation.",
    "isPrivate": false,
    "resourceReference": {
        "entityType": "Order",
        "entityId": "6686def3cb6eb9b3d1740f96",
        "merchantId": "6e0a8bd9-93b1-4f60-9af0-ea9cd5c4756a",
        "vendorId": "33ba401a-28fd-4129-b335-5cd7b81c45af"
    }
}'

Response Example

201 - Success

{
    "id": "0a0d1c4d-4557-4386-bc80-e26937d08411"
}

Modified at 2026-05-27 12:49:03

Note

Search All Notes