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

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

订单备注

订单备注 API 允许您创建、查看和删除单个订单备注。
订单备注由管理员或通过程序添加，用于存储订单或订单事件的相关数据。

Order note properties

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
date_created_gmt date-time The date the order note was created, as GMT. read-only
note string Order note content. mandatory
customer_note boolean If true, the note will be shown to customers and they will be notified. If false, the note will be for admin reference only. Default is false.

创建订单备注

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

HTTP 请求

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

const data = {
  note: "Order ok!!!"
};

WooCommerce.post("orders/723/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/723/notes', $data));
?>

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

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

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

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

JSON 响应示例：

{
  "id": 281,
  "date_created": "2017-03-21T16:46:41",
  "date_created_gmt": "2017-03-21T19:46:41",
  "note": "Order ok!!!",
  "customer_note": false,
  "_links": {
    "self": [
      {
        "href": "https://example.com/wp-json/wc/v2/orders/723/notes/281"
      }
    ],
    "collection": [
      {
        "href": "https://example.com/wp-json/wc/v2/orders/723/notes"
      }
    ],
    "up": [
      {
        "href": "https://example.com/wp-json/wc/v2/orders/723"
      }
    ]
  }
}

获取订单备注

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

HTTP 请求

GET
/wp-json/wc/v2/orders/<id>/notes/<note_id>
curl https://example.com/wp-json/wc/v2/orders/723/notes/281 \
    -u consumer_key:consumer_secret

WooCommerce.get("orders/723/notes/281")
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.log(error.response.data);
  });

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

print(wcapi.get("orders/723/notes/281").json())

woocommerce.get("orders/723/notes/281").parsed_response

JSON 响应示例：

{
  "id": 281,
  "date_created": "2017-03-21T16:46:41",
  "date_created_gmt": "2017-03-21T19:46:41",
  "note": "Order ok!!!",
  "customer_note": false,
  "_links": {
    "self": [
      {
        "href": "https://example.com/wp-json/wc/v2/orders/723/notes/281"
      }
    ],
    "collection": [
      {
        "href": "https://example.com/wp-json/wc/v2/orders/723/notes"
      }
    ],
    "up": [
      {
        "href": "https://example.com/wp-json/wc/v2/orders/723"
      }
    ]
  }
}

列出所有订单备注

此 API 可帮助您查看订单的所有备注。

HTTP 请求

GET
/wp-json/wc/v2/orders/<id>/notes
curl https://example.com/wp-json/wc/v2/orders/723/notes \
    -u consumer_key:consumer_secret

WooCommerce.get("orders/723/notes")
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.log(error.response.data);
  });

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

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

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

JSON 响应示例：

[
  {
    "id": 281,
    "date_created": "2017-03-21T16:46:41",
    "date_created_gmt": "2017-03-21T19:46:41",
    "note": "Order ok!!!",
    "customer_note": false,
    "_links": {
      "self": [
        {
          "href": "https://example.com/wp-json/wc/v2/orders/723/notes/281"
        }
      ],
      "collection": [
        {
          "href": "https://example.com/wp-json/wc/v2/orders/723/notes"
        }
      ],
      "up": [
        {
          "href": "https://example.com/wp-json/wc/v2/orders/723"
        }
      ]
    }
  },
  {
    "id": 280,
    "date_created": "2017-03-21T16:16:58",
    "date_created_gmt": "2017-03-21T19:16:58",
    "note": "Order status changed from On hold to Completed.",
    "customer_note": false,
    "_links": {
      "self": [
        {
          "href": "https://example.com/wp-json/wc/v2/orders/723/notes/280"
        }
      ],
      "collection": [
        {
          "href": "https://example.com/wp-json/wc/v2/orders/723/notes"
        }
      ],
      "up": [
        {
          "href": "https://example.com/wp-json/wc/v2/orders/723"
        }
      ]
    }
  },
  {
    "id": 279,
    "date_created": "2017-03-21T16:16:46",
    "date_created_gmt": "2017-03-21T19:16:46",
    "note": "Awaiting BACS payment Order status changed from Pending payment to On hold.",
    "customer_note": false,
    "_links": {
      "self": [
        {
          "href": "https://example.com/wp-json/wc/v2/orders/723/notes/279"
        }
      ],
      "collection": [
        {
          "href": "https://example.com/wp-json/wc/v2/orders/723/notes"
        }
      ],
      "up": [
        {
          "href": "https://example.com/wp-json/wc/v2/orders/723"
        }
      ]
    }
  }
]

Available parameters

Parameter Type Description
context string Scope under which the request is made; determines fields present in response. Options: view and edit. Default is view.
type string Limit result to customers or internal notes. Options: any, customer and internal. Default is any.

删除订单备注

此 API 可帮助您删除订单备注。

HTTP 请求

DELETE
/wp-json/wc/v2/orders/<id>/notes/<note_id>
curl -X DELETE https://example.com/wp-json/wc/v2/orders/723/notes/281?force=true \
    -u consumer_key:consumer_secret

WooCommerce.delete("orders/723/notes/281", {
  force: true
})
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.log(error.response.data);
  });

<?php print_r($woocommerce->delete('orders/723/notes/281', ['force' => true])); ?>

print(wcapi.delete("orders/723/notes/281", params={"force": True}).json())

woocommerce.delete("orders/723/notes/281", force: true).parsed_response

JSON 响应示例：

{
  "id": 281,
  "date_created": "2017-03-21T16:46:41",
  "date_created_gmt": "2017-03-21T19:46:41",
  "note": "Order ok!!!",
  "customer_note": false,
  "_links": {
    "self": [
      {
        "href": "https://example.com/wp-json/wc/v2/orders/723/notes/281"
      }
    ],
    "collection": [
      {
        "href": "https://example.com/wp-json/wc/v2/orders/723/notes"
      }
    ],
    "up": [
      {
        "href": "https://example.com/wp-json/wc/v2/orders/723"
      }
    ]
  }
}

Available parameters

Parameter Type Description
force string Required to be true, as resource does not support trashing.
← 返回文档中心