WooCommerce API Documentation
This is the complete API documentation for connecting to the WooCommerce API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet WooCommerce: Manage WooCommerce products, orders, customers, and store settings. Keep reading to get started.
Quickstart
Before you run your first WooCommerce request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one WooCommerce connection — create or choose one in Connections. Note its
connectionId.
Every WooCommerce action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/wooCommerce/latest/actions/{actionSlug}You need a MindCloud API Key and a WooCommerce connection. Then call an action such as Get Order Note:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/wooCommerce/latest/actions/get-order-note" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--get \
--data-urlencode "connectionId=$CONNECTION_ID"Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authentication
Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected WooCommerce account that should run the action. MindCloud stores and refreshes the WooCommerce credentials behind that connection, so you never send provider tokens with your requests.
Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.
Connect your WooCommerce store
You need WordPress admin access to the store and an HTTPS store URL.
- Open WooCommerce REST API keys
In your WordPress admin, go to WooCommerce > Settings > Advanced > REST API keys. This is the screen where WooCommerce lets you create and manage REST API keys.
- Create a new API key
Select Create an API key or Add key. Enter a description, choose the WordPress user the key belongs to, and choose the access level. Use Read for read-only actions, or Read/Write if you plan to use write actions later.
- Copy the values into MindCloud
Enter your store URL in Site URL. Paste the Consumer Key into Username and the Consumer Secret into Password.
WooCommerce actions
All 26 published actions for this WooCommerce version. Each page documents the endpoint, arguments, and response controls.
- POSTCreate Coupon
- POSTCreate Customer
- POSTCreate Order
- PUTCreate Order Note
- POSTCreate Product
- POSTCreate Product Category
- DELETEDelete Coupon
- DELETEDelete Customer
- DELETEDelete Order
- DELETEDelete Product
- POSTDuplicate Product
- GETGet Order Note
- GETList Coupons
- GETList Customers
- GETList Orders
- GETList Product Categories
- GETList Products
- GETRetrieve Coupon
- GETRetrieve Customer
- GETRetrieve Order
- GETRetrieve Product
- GETRetrieve Product Category
- PUTUpdate Coupon
- PUTUpdate Customer
- PUTUpdate Order
- PUTUpdate Product
Related apps
More Commerce apps on the Universal API, behind the same REST shape. Or browse all apps.