WooCommerce REST API 文档 文档中心 › WooCommerce REST API 文档

title: "订单 - 备注 #" post_status: publish comment_status: open taxonomy: category: - woocommerce-rest-api post_tag: - V3 - Includes - Source

订单 - 备注

本节列出了所有可用于创建、编辑或以其他方式操作订单备注的 API 端点。

订单备注属性

属性 类型 描述
id integer 订单备注 ID 只读
created_at string 订单备注创建时的 UTC 日期时间 只读
note string 订单备注 必需
customer_note boolean 显示/定义备注是仅供参考还是面向客户（用户将收到通知）。默认值为 false

为订单创建备注

此 API 可帮助您为订单创建新备注。

HTTP 请求

POST
/wc-api/v3/orders/<id>/notes
curl -X POST https://example.com/wc-api/v3/orders/645/notes \
    -u consumer_key:consumer_secret \
    -H "Content-Type: application/json" \
    -d '{
  "order_note": {
    "note": "Order ok!!!"
  }
}'

var data = {
  order_note: {
    note: 'Order ok!!!'
  }
};

WooCommerce.post('orders/645/notes', data, function(err, data, res) {
  console.log(res);
});

<?php
$data = [
    'order_note' => [
        'note' => 'Order ok!!!'
    ]
];

print_r($woocommerce->post('orders/645/notes', $data));
?>

data = {
    "order_note": {
        "note": "Order ok!!!"
    }
}

print(wcapi.post("orders/645/notes", data).json())

data = {
  order_note: {
    note: "Order ok!!!"
  }
}

woocommerce.post("orders/645/notes", data).parsed_response

JSON 响应示例：

{
  "order_note": {
    "id": "416",
    "created_at": "2015-01-26T20:56:44Z",
    "note": "Order ok!!!",
    "customer_note": false
  }
}

查看订单备注

此 API 允许您检索并查看订单中的特定备注。

HTTP 请求

GET
/wc-api/v3/orders/<id>/notes/<note_id>
curl https://example.com/wc-api/v3/orders/645/notes/416 \
    -u consumer_key:consumer_secret

WooCommerce.get('orders/645/notes/416', function(err, data, res) {
  console.log(res);
});

<?php print_r($woocommerce->get('orders/645/notes/416')); ?>

print(wcapi.get("orders/645/notes/416").json())

woocommerce.get("orders/645/notes/416").parsed_response

JSON 响应示例：

{
  "order_note": {
    "id": "416",
    "created_at": "2015-01-26T20:56:44Z",
    "note": "Order ok!!!",
    "customer_note": false
  }
}

View List of Notes From an Order

This API helps you to view all the notes from an order.

HTTP Request

GET
/wc-api/v3/orders/<id>/notes
curl https://example.com/wc-api/v3/orders/645/notes \
    -u consumer_key:consumer_secret

WooCommerce.get('orders/645/notes', function(err, data, res) {
  console.log(res);
});

<?php print_r($woocommerce->get('orders/645/notes')); ?>

print(wcapi.get("orders/645/notes").json())

woocommerce.get("orders/645/notes").parsed_response

JSON response example:

{
  "order_notes": [
    {
      "id": "416",
      "created_at": "2015-01-26T20:56:44Z",
      "note": "Order ok!!!",
      "customer_note": false
    },
    {
      "id": "415",
      "created_at": "2015-01-26T20:16:14Z",
      "note": "Order status changed from Processing to Completed.",
      "customer_note": false
    },
    {
      "id": "412",
      "created_at": "2015-01-26T20:00:21Z",
      "note": "Order item stock reduced successfully.",
      "customer_note": false
    },
    {
      "id": "411",
      "created_at": "2015-01-26T20:00:09Z",
      "note": "Order status changed from Pending Payment to Processing.",
      "customer_note": false
    }
  ]
}

更新订单备注

此 API 允许您修改订单备注。

HTTP 请求

PUT
/wc-api/v3/orders/<id>/notes/<note_id>
curl -X PUT https://example.com/wc-api/v3/orders/645/notes/416 \
    -u consumer_key:consumer_secret \
    -H "Content-Type: application/json" \
    -d '{
  "order_note": {
    "note": "Ok!"
  }
}'

var data = {
  order_note: {
    note: 'Ok!'
  }
};

WooCommerce.put('orders/645/notes/416', data, function(err, data, res) {
  console.log(res);
});

<?php
$data = [
    'order_note' => [
        'note' => 'Ok!'
    ]
];

print_r($woocommerce->put('orders/645/notes/416', $data));
?>

data = {
    "order_note": {
        "note": "Ok!"
    }
}

print(wcapi.put("orders/645/notes/416", data).json())

data = {
  order_note: {
    note: "Ok!"
  }
}

woocommerce.put("orders/645/notes/416", data).parsed_response

JSON 响应示例：

{
  "order_note": {
    "id": "416",
    "created_at": "2015-01-26T20:56:44Z",
    "note": "Ok!",
    "customer_note": false
  }
}

Delete an Order Note

This API helps you delete an order note.

HTTP Request

DELETE
/wc-api/v3/orders/<id>/notes/<note_id>
curl -X DELETE https://example.com/wc-api/v3/orders/645/notes/416 \
    -u consumer_key:consumer_secret

WooCommerce.delete('orders/645/notes/416', function(err, data, res) {
  console.log(res);
});

<?php print_r($woocommerce->delete('orders/645/notes/416')); ?>

print(wcapi.delete("orders/645/notes/416").json())

woocommerce.delete("orders/645/notes/416").parsed_response

JSON response example:

{
  "message": "Permanently deleted order note"
}
← 返回文档中心