woocommerce.com

•

API Key

About WooCommerce API

The WooCommerce REST API (v3) is a built-in API included with the WooCommerce plugin that enables external systems to create, read, update, and delete store data including products, orders, customers, coupons, and reports. It uses JSON over HTTP and supports WordPress authentication methods including consumer key/secret pairs. The API is free as part of WooCommerce core and is primarily used for integrations, headless storefronts, and automation.

AI Agent Use Cases

- Full CRUD operations on products, orders, customers, and coupons via JSON/HTTP

- Consumer key and secret authentication, plus WordPress cookie auth

- Webhooks for real-time event notifications on order and product changes

- Batch requests to create or update multiple resources in one API call

- Product variations, attributes, and meta data endpoints

- Compatible with headless and composable commerce architectures

Available Actions

These are the specific actions that AI agents can perform with this tool

Create Order

3 inputs

Create a new order in WooCommerce

Inputs

consumer_key

API consumer key generated in WooCommerce

consumer_secret

API consumer secret generated in WooCommerce

order

A dictionary representing the new order to be created

Generate Smart Coupon

5 inputs

Generate a smart coupon without needing a coupon code

Inputs

discount_type

Type of coupon, in this case, should be set to 'smart_coupon'.

amount

The amount of the discount offered by the coupon.

email_restrictions

Email addresses restricted for use of the coupon.

sc_is_send_email

If set to 'yes', the generated coupon will be emailed to the restricted email address.

sc_is_html

If set to 'yes', the response will be in HTML instead of JSON.

Get Customers List

2 inputs

Retrieve a list of all customers

Inputs

consumer_key

The API consumer key for accessing the WooCommerce REST API

consumer_secret

The API consumer secret for accessing the WooCommerce REST API

Get Products

4 inputs

Retrieve a list of products from the WooCommerce store

Inputs

consumer_key

The API consumer key available from WooCommerce settings. It is used as a part of HTTP Basic Auth.

consumer_secret

The API consumer secret available from WooCommerce settings. It is used as a part of HTTP Basic Auth.

per_page

Limit the number of products returned in a single call. Defaults to 10.

page

The page number of the results to retrieve.

Process Refund

5 inputs

Process an automatic refund for a customer using the same payment method as the original order payment

Inputs

order_id

The ID of the order that needs to be refunded

amount

The total amount to be refunded

api_url

The base URL of the WooCommerce API endpoint

consumer_key

Authentication key provided by WooCommerce API

consumer_secret

Authentication secret provided by WooCommerce API