WooCommerce Order Notes API
Manage private and customer-facing notes on orders
WooCommerce Order Notes API is one of 21 APIs that WooCommerce publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 7 JSON Schema definitions.
Tagged areas include Order Notes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and 7 JSON Schemas.
This API exposes 4 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version v3.
Requests are made against a single base URL, https://example.com/wp-json/wc/v3.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
WooCommerce Order Notes API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (basicAuth).
By default, every request must be authenticated.
basicAuth— HTTP Basic Auth using the WooCommerce Consumer Key as the username and Consumer Secret as the password over HTTPS. Over plain HTTP use OAuth 1.0a one-legged au…
Paths & Operations 4
Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Manage private and customer-facing notes on orders
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are OrderNote (5 properties), Error (3 properties), OrderNoteInput (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from WooCommerce 12
Other APIs WooCommerce publishes across the network.