docs/apis/rest-api/v1/order-notes.mdx
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
The order notes API allows you to create, view, and delete individual order notes.
Order notes are added by administrators and programmatically to store data about an order, or order events.
| Attribute | Type | Description |
|---|---|---|
id | integer | Unique identifier for the resource. READ-ONLY |
date_created | date-time | The date the order note was created, in the site's timezone. READ-ONLY |
note | string | Order note. REQUIRED |
customer_note | boolean | Shows/define if the note is only for reference or for the customer (the user will be notified). Default is false. |
This API helps you to create a new note for an order.
POST /wp-json/wc/v1/orders/<id>/notes
curl -X POST https://example.com/wp-json/wc/v1/orders/645/notes \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"note": "Order ok!!!"
}'
const data = {
note: "Order ok!!!"
};
WooCommerce.post("orders/645/notes", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'note' => 'Order ok!!!'
];
print_r($woocommerce->post('orders/645/notes', $data));
?>
data = {
"note": "Order ok!!!"
}
print(wcapi.post("orders/645/notes", data).json())
data = {
note: "Order ok!!!"
}
woocommerce.post("orders/645/notes", data).parsed_response
{
"id": 51,
"date_created": "2016-05-13T20:51:55",
"note": "Order ok!!!",
"customer_note": false,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v1/orders/118/notes/51"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v1/orders/118/notes"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v1/orders/118"
}
]
}
}
This API lets you retrieve and view a specific note from an order.
GET /wp-json/wc/v1/orders/<id>/notes/<note_id>
curl https://example.com/wp-json/wc/v1/orders/645/notes/51 \
-u consumer_key:consumer_secret
WooCommerce.get("orders/645/notes/51")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('orders/645/notes/51')); ?>
print(wcapi.get("orders/645/notes/51").json())
woocommerce.get("orders/645/notes/51").parsed_response
{
"id": 51,
"date_created": "2016-05-13T20:51:55",
"note": "Order ok!!!",
"customer_note": false,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v1/orders/118/notes/51"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v1/orders/118/notes"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v1/orders/118"
}
]
}
}
This API helps you to view all the notes from an order.
GET /wp-json/wc/v1/orders/<id>/notes
curl https://example.com/wp-json/wc/v1/orders/645/notes \
-u consumer_key:consumer_secret
WooCommerce.get("orders/645/notes")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('orders/645/notes')); ?>
print(wcapi.get("orders/645/notes").json())
woocommerce.get("orders/645/notes").parsed_response
[
{
"id": 51,
"date_created": "2016-05-13T20:51:55",
"note": "Order ok!!!",
"customer_note": false,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v1/orders/118/notes/51"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v1/orders/118/notes"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v1/orders/118"
}
]
}
},
{
"id": 46,
"date_created": "2016-05-03T18:10:43",
"note": "Order status changed from Pending Payment to Processing.",
"customer_note": false,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v1/orders/118/notes/46"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v1/orders/118/notes"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v1/orders/118"
}
]
}
}
]
This API helps you delete an order note.
DELETE /wp-json/wc/v1/orders/<id>/notes/<note_id>
curl -X DELETE https://example.com/wp-json/wc/v1/orders/645/notes/51?force=true \
-u consumer_key:consumer_secret
WooCommerce.delete("orders/645/notes/51", {
force: true
})
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->delete('orders/645/notes/51', ['force' => true])); ?>
print(wcapi.delete("orders/645/notes/51", params={"force": True}).json())
woocommerce.delete("orders/645/notes/51", force: true).parsed_response
{
"id": 51,
"date_created": "2016-05-13T20:51:55",
"note": "Order ok!!!",
"customer_note": false,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v1/orders/118/notes/51"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v1/orders/118/notes"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v1/orders/118"
}
]
}
}