Overview
Add WooCommerce to any ModuleX agent or workflow. Manage orders, products, customers, refunds, and payment methods on self-hosted WooCommerce stores via the WooCommerce REST API ({store_url}/wp-json/wc/v3).
Categories: E-Commerce · Retail · Payments · Auth: WooCommerce REST API Credentials · Actions: 17
Authentication
WooCommerce REST API Credentials
Authenticate using your WooCommerce store URL, consumer key, and consumer secret via HTTP Basic Auth (HTTPS required).Required Credentials
| Field | Description | Required | Format |
|---|---|---|---|
| Store URL | Your WooCommerce store URL (e.g. https://mystore.com) | Yes | https://mystore.example.com |
| Consumer Key | WooCommerce REST API consumer key from WooCommerce > Settings > Advanced > REST API | Yes | ck_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
| Consumer Secret | WooCommerce REST API consumer secret from WooCommerce > Settings > Advanced > REST API | Yes | cs_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
Available Actions
create_order — Create a new order in the WooCommerce store.
create_order — Create a new order in the WooCommerce store.
Parameters
string
Order status. Options: pending, processing, on-hold, completed, cancelled, refunded, failed, trash (Default:
pending)integer
User ID who owns the order. 0 for guests
string
Payment method ID (e.g. bacs, cheque, cod, paypal)
array
Array of line item objects, each with product_id (integer) and quantity (integer)
Response
{
"$defs": {
"OrderSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Number"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"total": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Total"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Currency"
},
"customer_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Customer Id"
},
"payment_method": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Payment Method"
},
"date_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Created"
},
"date_modified": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Modified"
},
"line_items": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Line Items",
"type": "array"
},
"billing": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Billing"
},
"shipping": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Shipping"
}
},
"title": "OrderSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"order": {
"anyOf": [
{
"$ref": "#/$defs/OrderSummary"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "CreateOrderOutput",
"type": "object"
}
get_order — Retrieve a specific order by ID.
get_order — Retrieve a specific order by ID.
Parameters
integer
required
ID of the order to retrieve
Response
{
"$defs": {
"OrderSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Number"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"total": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Total"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Currency"
},
"customer_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Customer Id"
},
"payment_method": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Payment Method"
},
"date_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Created"
},
"date_modified": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Modified"
},
"line_items": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Line Items",
"type": "array"
},
"billing": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Billing"
},
"shipping": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Shipping"
}
},
"title": "OrderSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"order": {
"anyOf": [
{
"$ref": "#/$defs/OrderSummary"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "GetOrderOutput",
"type": "object"
}
list_orders — Retrieve a list of orders with optional filters.
list_orders — Retrieve a list of orders with optional filters.
Parameters
string
Limit results to those matching a string
string
Order status filter. Options: pending, processing, on-hold, completed, cancelled, refunded, failed, trash (Default:
pending)integer
Filter by customer user ID. 0 for guests
string
Limit to orders created after this ISO8601 date (e.g. 2023-01-01T00:00:00)
string
Limit to orders created before this ISO8601 date (e.g. 2023-12-31T23:59:59)
integer
Maximum number of results to return (Default:
20)Response
{
"$defs": {
"OrderSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Number"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"total": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Total"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Currency"
},
"customer_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Customer Id"
},
"payment_method": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Payment Method"
},
"date_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Created"
},
"date_modified": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Modified"
},
"line_items": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Line Items",
"type": "array"
},
"billing": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Billing"
},
"shipping": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Shipping"
}
},
"title": "OrderSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"orders": {
"items": {
"$ref": "#/$defs/OrderSummary"
},
"title": "Orders",
"type": "array"
},
"total": {
"default": 0,
"title": "Total",
"type": "integer"
}
},
"required": [
"success"
],
"title": "ListOrdersOutput",
"type": "object"
}
delete_order — Delete an existing order.
delete_order — Delete an existing order.
Parameters
integer
required
ID of the order to delete
boolean
Whether to bypass trash and permanently delete the order
Response
{
"$defs": {
"OrderSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Number"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"total": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Total"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Currency"
},
"customer_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Customer Id"
},
"payment_method": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Payment Method"
},
"date_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Created"
},
"date_modified": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Modified"
},
"line_items": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Line Items",
"type": "array"
},
"billing": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Billing"
},
"shipping": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Shipping"
}
},
"title": "OrderSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"order": {
"anyOf": [
{
"$ref": "#/$defs/OrderSummary"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "DeleteOrderOutput",
"type": "object"
}
update_order_status — Update the status of a specific order.
update_order_status — Update the status of a specific order.
Parameters
integer
required
ID of the order to update
string
required
New order status. Options: pending, processing, on-hold, completed, cancelled, refunded, failed, trash
Response
{
"$defs": {
"OrderSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Number"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"total": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Total"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Currency"
},
"customer_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Customer Id"
},
"payment_method": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Payment Method"
},
"date_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Created"
},
"date_modified": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Modified"
},
"line_items": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Line Items",
"type": "array"
},
"billing": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Billing"
},
"shipping": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Shipping"
}
},
"title": "OrderSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"order": {
"anyOf": [
{
"$ref": "#/$defs/OrderSummary"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "UpdateOrderStatusOutput",
"type": "object"
}
create_product — Create a new product in the WooCommerce store.
create_product — Create a new product in the WooCommerce store.
Parameters
string
required
Name of the product
string
Product type. Options: simple, grouped, external, variable (Default:
simple)string
Product status. Options: draft, pending, private, publish (Default:
publish)string
Product regular price
string
Product sale price
string
Product description (HTML allowed)
array
Array of category IDs (integers) to assign the product to
string
URL of an image to add to the product
Response
{
"$defs": {
"ProductSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Slug"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Type"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"regular_price": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Regular Price"
},
"sale_price": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sale Price"
},
"price": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Price"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"categories": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Categories",
"type": "array"
},
"images": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Images",
"type": "array"
},
"date_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Created"
}
},
"title": "ProductSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"product": {
"anyOf": [
{
"$ref": "#/$defs/ProductSummary"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "CreateProductOutput",
"type": "object"
}
update_product — Update an existing product.
update_product — Update an existing product.
Parameters
integer
required
ID of the product to update
string
New name for the product
string
Product type. Options: simple, grouped, external, variable
string
Product status. Options: draft, pending, private, publish
string
Product regular price
string
Product sale price
string
Product description (HTML allowed)
array
Array of category IDs (integers) to assign the product to
string
URL of an image to add to the product
Response
{
"$defs": {
"ProductSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Slug"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Type"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"regular_price": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Regular Price"
},
"sale_price": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sale Price"
},
"price": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Price"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"categories": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Categories",
"type": "array"
},
"images": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Images",
"type": "array"
},
"date_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Created"
}
},
"title": "ProductSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"product": {
"anyOf": [
{
"$ref": "#/$defs/ProductSummary"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "UpdateProductOutput",
"type": "object"
}
get_product — Retrieve a specific product by ID.
get_product — Retrieve a specific product by ID.
Parameters
integer
required
ID of the product to retrieve
Response
{
"$defs": {
"ProductSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Slug"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Type"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"regular_price": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Regular Price"
},
"sale_price": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sale Price"
},
"price": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Price"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"categories": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Categories",
"type": "array"
},
"images": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Images",
"type": "array"
},
"date_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Created"
}
},
"title": "ProductSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"product": {
"anyOf": [
{
"$ref": "#/$defs/ProductSummary"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "GetProductOutput",
"type": "object"
}
list_products — Retrieve a list of products with optional filters.
list_products — Retrieve a list of products with optional filters.
Parameters
string
Limit results to those matching a string
string
Product status filter. Options: draft, pending, private, publish (Default:
publish)string
Product type filter. Options: simple, grouped, external, variable (Default:
simple)string
Limit to products created after this ISO8601 date
string
Limit to products created before this ISO8601 date
integer
Maximum number of results to return (Default:
20)Response
{
"$defs": {
"ProductSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Slug"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Type"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"regular_price": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Regular Price"
},
"sale_price": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sale Price"
},
"price": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Price"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"categories": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Categories",
"type": "array"
},
"images": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Images",
"type": "array"
},
"date_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Created"
}
},
"title": "ProductSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"products": {
"items": {
"$ref": "#/$defs/ProductSummary"
},
"title": "Products",
"type": "array"
},
"total": {
"default": 0,
"title": "Total",
"type": "integer"
}
},
"required": [
"success"
],
"title": "ListProductsOutput",
"type": "object"
}
search_customers — Search for customers by email, name, or other criteria.
search_customers — Search for customers by email, name, or other criteria.
Parameters
string
Limit results to those matching a string
string
Filter by exact customer email address
string
Filter by role. Options: all, administrator, editor, author, contributor, subscriber, customer (Default:
customer)integer
Maximum number of results to return (Default:
20)Response
{
"$defs": {
"CustomerSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"first_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "First Name"
},
"last_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Last Name"
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Username"
},
"role": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Role"
},
"date_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Created"
},
"billing": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Billing"
},
"shipping": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Shipping"
},
"is_paying_customer": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Is Paying Customer"
}
},
"title": "CustomerSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"customers": {
"items": {
"$ref": "#/$defs/CustomerSummary"
},
"title": "Customers",
"type": "array"
},
"total": {
"default": 0,
"title": "Total",
"type": "integer"
}
},
"required": [
"success"
],
"title": "SearchCustomersOutput",
"type": "object"
}
get_customer — Retrieve a specific customer by ID.
get_customer — Retrieve a specific customer by ID.
Parameters
integer
required
ID of the customer to retrieve
Response
{
"$defs": {
"CustomerSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"first_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "First Name"
},
"last_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Last Name"
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Username"
},
"role": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Role"
},
"date_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Created"
},
"billing": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Billing"
},
"shipping": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Shipping"
},
"is_paying_customer": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Is Paying Customer"
}
},
"title": "CustomerSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"customer": {
"anyOf": [
{
"$ref": "#/$defs/CustomerSummary"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "GetCustomerOutput",
"type": "object"
}
create_customer — Create a new customer.
create_customer — Create a new customer.
Parameters
string
required
Customer email address
string
Customer first name
string
Customer last name
string
Customer login username
string
Customer password
boolean
Whether the customer is a paying customer
Response
{
"$defs": {
"CustomerSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"first_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "First Name"
},
"last_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Last Name"
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Username"
},
"role": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Role"
},
"date_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Created"
},
"billing": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Billing"
},
"shipping": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Shipping"
},
"is_paying_customer": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Is Paying Customer"
}
},
"title": "CustomerSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"customer": {
"anyOf": [
{
"$ref": "#/$defs/CustomerSummary"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "CreateCustomerOutput",
"type": "object"
}
add_order_note — Create a new note for an order.
add_order_note — Create a new note for an order.
Parameters
integer
required
ID of the order to add a note to
string
required
Content of the order note
Response
{
"$defs": {
"OrderNoteSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"author": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Author"
},
"date_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Created"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Note"
},
"customer_note": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Customer Note"
}
},
"title": "OrderNoteSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"note": {
"anyOf": [
{
"$ref": "#/$defs/OrderNoteSummary"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "AddOrderNoteOutput",
"type": "object"
}
get_order_note — Retrieve a specific order note.
get_order_note — Retrieve a specific order note.
Parameters
integer
required
ID of the order
integer
required
ID of the order note
Response
{
"$defs": {
"OrderNoteSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"author": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Author"
},
"date_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Created"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Note"
},
"customer_note": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Customer Note"
}
},
"title": "OrderNoteSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"note": {
"anyOf": [
{
"$ref": "#/$defs/OrderNoteSummary"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "GetOrderNoteOutput",
"type": "object"
}
list_order_notes — Retrieve all notes for a specific order.
list_order_notes — Retrieve all notes for a specific order.
Parameters
integer
required
ID of the order
string
Filter by note type. Options: any, customer, internal (Default:
any)Response
{
"$defs": {
"OrderNoteSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"author": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Author"
},
"date_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Created"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Note"
},
"customer_note": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Customer Note"
}
},
"title": "OrderNoteSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"notes": {
"items": {
"$ref": "#/$defs/OrderNoteSummary"
},
"title": "Notes",
"type": "array"
}
},
"required": [
"success"
],
"title": "ListOrderNotesOutput",
"type": "object"
}
create_refund — Create a new refund for an order.
create_refund — Create a new refund for an order.
Parameters
integer
required
ID of the order to refund
string
Refund amount. If not specified, calculated from line items
string
Reason for the refund
boolean
When true, the payment gateway API generates the refund. When false, the refund is manual
array
Array of line item refund objects. Each with id (integer), refund_total (string), and optionally refund_tax (array)
Response
{
"$defs": {
"RefundSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"amount": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Amount"
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reason"
},
"refunded_by": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Refunded By"
},
"date_created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Created"
},
"line_items": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Line Items",
"type": "array"
}
},
"title": "RefundSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"refund": {
"anyOf": [
{
"$ref": "#/$defs/RefundSummary"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "CreateRefundOutput",
"type": "object"
}
list_payment_method_options — Retrieve available payment gateway options.
list_payment_method_options — Retrieve available payment gateway options.
Response
{
"$defs": {
"PaymentMethodSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Title"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Enabled"
}
},
"title": "PaymentMethodSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"payment_methods": {
"items": {
"$ref": "#/$defs/PaymentMethodSummary"
},
"title": "Payment Methods",
"type": "array"
}
},
"required": [
"success"
],
"title": "ListPaymentMethodOptionsOutput",
"type": "object"
}
Limits & Quotas
- WooCommerce REST API rate limits depend on the hosting provider and server configuration. Most managed hosts enforce 60-120 requests/minute.
- Pagination is server-controlled; responses include
X-WP-TotalandX-WP-TotalPagesheaders. - Error model: non-2xx responses are caught and returned as
success=False+errorrather than raising. Plan for retries on the agent side based on the error string. - No per-request pricing — WooCommerce is self-hosted.