Order Note Create
POST
{{api_url}}/shop/order/{{orderid}}/noteCreates an internal note on an order. Notes stay inside InfiPlex and are not sent to the customer or the sales channel.
Each call adds one new note to the order. To read an order's notes back, use Order Search with include_order_notes=1.
Path parameters
| Parameter | Type | Description |
|---|---|---|
orderid | integer | The InfiPlex order ID (shop_orderid), not the marketplace order number. |
Body parameters
| Parameter | Type | Description |
|---|---|---|
order_note | string | The note text. Required. |
{
"order_note": "This is a new order note"
}
Response fields
| Field | Description |
|---|---|
order_note_id | The ID of the new note, returned as a number. |
orderid | The order the note was added to, returned as a string. |
order_note | The note text as saved. |
Authorization
Bearer token, sent in the Authorization header. Inherited from the collection.
Headers
| Key | Value | Description |
|---|---|---|
Content-Type | application/json |
Body
{
"order_note": "This is a new order note"
}Example Request
curl --location --request POST '{{api_url}}/shop/order/{{orderid}}/note' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{auth_token}}' \
--data '{
"order_note": "This is a new order note"
}'Example Responses
Order Note Create
Request
curl --location --request POST 'https://example.com/api/admin/shop/order/103980/note' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"order_note": "This is a new order note"
}'Response 200 OK
{
"order_note_id": 9479,
"orderid": "103980",
"order_note": "This is a new order note"
}