Add a shipping method to a zone. Valid method_id values: 'flat_rate', 'free_shipping', 'local_pickup'. Configure rates via settings after adding.

Batch create, update, or delete attribute terms in a single request. More efficient than individual create/delete calls for multiple terms.

Batch create, update, or delete variations in a single request. More efficient than individual calls for setting up a variable product.

Find orphaned media not used by any product or category. Dry run by default; set delete=true to remove them. Scans all products and categories.

Create a global product attribute. After creating, use create_attribute_term to add values (e.g. 500g, 1kg for a Weight attribute).

Add a new value to a product attribute (e.g. add '2kg' to Weight). Use batch_update_attribute_terms for multiple values at once.

Create a product brand. Brands are hierarchical and can have images. Assign to products via update_product with brands array.

Create a product category. Set parent ID to create a subcategory. Categories are hierarchical.

Create a discount coupon. Code must be unique. Supports percent, fixed cart, and fixed product discount types. Use fields param to request only needed fields.

Create a new customer account. Email is required and must be unique. Use fields param to request only needed fields.

Create a new order. Requires line_items with product_id and quantity. Use variation_id for variable product variants.

Add a note to an order. Set customer_note=true to send an email notification to the customer with the note content. Default is a private admin note.

Create a refund for an order. Can refund full or partial amount. Set api_refund=true (default) to automatically refund via payment gateway, or false for manual refund.

Create a new WooCommerce product. For variable products, set type='variable' and include attributes array, then use create_variation to add variants.

Create a product shipping class. Assign to products via update_product to group similar shipping needs (e.g. 'bulky', 'fragile').

Create a new shipping zone. After creating, add locations and shipping methods to it.

Create a product tag. Tags are flat labels like 'Bestseller' or 'New Arrival' — unlike categories, they have no hierarchy.

Create a custom tax class. After creating, add tax rates to it. Example: 'GST 5%' for food items.

Create a tax rate. Set country/state/postcode for region, rate as percentage string (e.g. '18.0000'), and class for tax class.

Create a variation for a variable product. Parent product must have type='variable' with matching attributes. Use batch_update_variations for multiple at once.

Create a webhook. Topic format: 'resource.event' (e.g. 'order.created', 'product.updated', 'coupon.deleted'). Resources: order, product, customer, coupon. Events: created, updated, deleted, restored.

Delete a global product attribute and all its terms. Also removes the attribute from all products that use it.

Delete a value from a product attribute. Removes the term from all products using it.

Delete a product brand. Does NOT delete products with this brand; they simply lose the brand association.

Delete a product category. Does NOT delete products in the category; they become uncategorized.

Delete a coupon. Moves to trash by default; set force=true to permanently delete.

Permanently delete a media item from WordPress. This is irreversible. Use cleanup_orphaned_media to find unused items first.

Delete an order. Moves to trash by default; set force=true to permanently delete.

Delete a note from an order. This permanently removes the note.

Delete a refund record from an order. This removes the refund entry but does not reverse the payment — use with caution.

Delete a product. Moves to trash by default; set force=true to permanently delete. Does not delete associated media.

Delete a product review. By default moves to trash (force=false). Set force=true to permanently delete.

Delete a product shipping class. Products using this class will revert to no shipping class.

Delete a shipping zone. This also removes all methods and locations in the zone.

Remove a shipping method from a zone.

Delete a product tag. Does NOT affect products that had this tag; they simply lose the tag association.

Delete a tax class by slug. Cannot delete the Standard class. Rates in this class will be orphaned.

Delete a tax rate. This is permanent and cannot be undone.

Delete a webhook. Set force=true to permanently delete.

Get details of a global product attribute. Use list_attribute_terms with the attribute ID to see its values. Use fields param to request only needed fields.

Get full details of a product brand including description, image, and product count. Use fields param to request only needed fields.

Get full details of a category including description and product count. Use fields param to request only needed fields.

Get full coupon details including usage limits, product restrictions, and expiry date. Use fields param to request only needed fields.

Get full customer details including billing and shipping addresses, order history stats. Use fields param to request only needed fields.

Get customer counts grouped by WordPress role. Shows total registered customers and their roles.

Get full details of a single order including billing, shipping, line items, and payment info. Use fields param to request only needed fields.

Get order counts grouped by status (pending, processing, completed, etc.). Useful for a quick store health overview.

Get full details of a payment gateway by ID. Common IDs: bacs (bank transfer), cheque, cod (cash on delivery), paypal, stripe, razorpay.

Get full details of a single product by ID. Returns more fields than list_products including description, tags, brands, and variations. Use fields param to request only needed fields.

Get full details of a product review by ID including reviewer email and verification status.

Get product counts grouped by status (publish, draft, pending, private). Quick catalog size overview.

Get sales report for a period. Returns total sales, orders, items, tax, shipping, refunds, and daily/weekly totals breakdown.

Get all settings in a group. Common groups: 'general' (store address, currency), 'products' (measurements, reviews), 'tax' (tax options), 'shipping' (shipping options).

Get a shipping zone by ID. Use list_shipping_zones to find zone IDs.

Get WooCommerce system status including environment, database, active plugins, theme, settings, and security info.

Get full details of a product tag including description and product count. Use fields param to request only needed fields.

Get a single tax rate by ID with full details.

Get top-selling products ranked by quantity sold. Filterable by period or date range.

Get full details of a single variation including price, stock, weight, and attributes. Use fields param to request only needed fields.

Get full details of a webhook by ID including secret and API version.

List global product attributes (e.g. Weight, Volume, Size). Use list_attribute_terms to see values for each attribute. Use fields param to request only needed fields.

List values (terms) for a product attribute, e.g. '500g', '1kg' for Weight. Use fields param to request only needed fields.

List product brands (WooCommerce 9.6+ core feature). Supports filtering by parent and hide_empty. Use fields param to request only needed fields.

List product categories. Supports filtering by parent for subcategories, and hide_empty to skip unused categories. Use fields param to request only needed fields.

List all countries available in WooCommerce with their states/provinces. Useful for setting up shipping zones and tax rules.

List discount coupons. Shows code, type (percent/fixed_cart/fixed_product), amount, and usage stats. Use fields param to request only needed fields.

List all currencies supported by WooCommerce with their codes and symbols.

Search and filter customers by name, email, or role. Returns order count and total spent per customer. Use fields param to request only needed fields.

List WordPress media library items. Supports search and MIME type filtering (e.g. image/jpeg). Use fields param to request only needed fields.

List all notes for an order. Includes both private admin notes and customer-visible notes. Use fields param to request only needed fields.

List all refunds for an order. Shows refund amounts, reasons, and who processed them. Use fields param to request only needed fields.

Search and filter orders. Supports filtering by status, customer, date range, and search term. Use fields param to request only needed fields.

List all available payment gateways. Gateways are provided by plugins and cannot be created or deleted via API.

List product reviews. Filter by product IDs, status, or search term. Use fields param to request only needed fields.

Search and filter the product catalog. Supports filtering by status, category, tag, type, price range, and search term. Use fields param to request only needed fields.

List all WooCommerce setting groups. Groups include: general, products, tax, shipping, checkout, account, email, advanced. Use group ID with get_settings to see options.

List product shipping classes. Classes group products with similar shipping requirements (e.g. heavy, fragile).

List shipping methods for a zone. Methods define how items are shipped (flat rate, free shipping, local pickup).

List all shipping zones. Zones define geographic regions with specific shipping methods and rates.

List available system tools (e.g. clear_transients, recount_terms, db_update_routine). These are maintenance utilities.

List product tags. Tags are flat labels (no hierarchy). Use hide_empty to skip unused tags. Use fields param to request only needed fields.

List all tax classes. WooCommerce includes 'Standard', 'Reduced rate', and 'Zero rate' by default. Tax classes group tax rates.

List tax rates. Filter by tax class to see rates for a specific class. Each rate defines tax for a region.

List all variations for a variable product. Each variation has its own price, SKU, and stock. Use fields param to request only needed fields.

List webhooks. Webhooks send POST requests to a URL when store events occur (e.g. order.created, product.updated).

Run a system maintenance tool. Common tools: clear_transients, clear_template_cache, recount_terms, db_update_routine, install_pages.

Update a brand's name, slug, parent, description, or image. Only include fields you want to change.

Update a category's name, slug, parent, description, or image. Only include fields you want to change.

Update a coupon's code, amount, restrictions, or expiry. Only include fields you want to change. Use fields param to request only needed fields.

Update customer details such as name, email, or addresses. Only include fields you want to change. Use fields param to request only needed fields.

Update an order. Commonly used to change status (e.g. pending -> processing -> completed). See get_order_totals for valid statuses.

Update a payment gateway. Use to enable/disable gateways, change titles, or modify settings. Gateways cannot be created or deleted — they come from plugins.

Update an existing product. Only include fields you want to change. Note: setting images replaces all existing images.

Update a product review. Use to change status (approve/hold/spam/trash), edit review text, or modify rating.

Update a single setting value. Use get_settings first to find the setting ID and valid options. Example: group_id='general', setting_id='woocommerce_currency', value='INR'.

Update a shipping zone name or sort order.

Update a shipping method in a zone. Use to enable/disable, change title, order, or configure settings like cost.

Update a product tag's name, slug, or description. Only include fields you want to change.

Update a tax rate. Only include fields you want to change.

Update a variation's price, stock, SKU, or other details. Only include fields you want to change.

Update a webhook. Use to change delivery URL, topic, status (pause/resume), or secret.