Reference

coupon.created

Coupon Created

customer.created

Customer Created

customer.updated

Customer Updated

order.created

Order Created

order.updated

Order Updated

product.created

Product Created

product.updated

Product Updated

coupon.deleted

Coupon Deleted

coupon.restored

Coupon Restored

coupon.updated

Coupon Updated

customer.deleted

Customer Deleted

order.deleted

Order Deleted

order.restored

Order Restored

product.deleted

Product Deleted

product.restored

Product Restored

Create a new coupon

Create a discount coupon for your store

Batch create, update, or delete coupons

Process multiple coupon operations in a single request. Use this to bulk-import promotional codes, update expiry dates across campaigns, or clean up expired coupons efficiently.

Delete a coupon

Permanently removes a coupon from the store, helping you maintain a clean list of active promotional codes by eliminating expired, invalid, or unused discounts.

List all coupons

Retrieves a paginated list of all discount coupons in your store, making it easy to review, manage, and export your promotions for external tools or reporting.

Retrieve a coupon by ID

Fetch the full details of a specific coupon including its discount type, amount, usage count, and restrictions. Use this to verify coupon status or display coupon details in external systems.

Update a coupon

Modify an existing coupon's settings such as discount amount, usage limits, or expiry date. Useful for adjusting promotions in response to sales performance or extending campaign durations.

List all customers

List all customers with search and filtering

Batch create, update, or delete customers

Process multiple customer operations in a single request. Use this for bulk customer imports from external CRM systems, mass profile updates, or cleaning up inactive accounts.

Create a new customer

Register a new customer account with billing and shipping addresses, email, and optional metadata. Use this to import customers from external systems or create accounts during third-party checkout flows.

Delete a customer

Permanently remove a customer account. Optionally reassign their orders to another customer. Use this for GDPR compliance, removing duplicate accounts, or cleaning up test data.

Retrieve a customer by ID

Fetch the full profile of a specific customer including billing and shipping addresses, order count, and total spent. Use this to display customer details or verify account information before processing orders.

Update a customer

Modify a customer's profile including name, email, billing address, shipping address, or metadata. Use this to keep customer records in sync across multiple systems or update addresses from external forms.

Create a new order

Create a new order in your WooCommerce store

Create a refund for an order

Process a full or partial refund for an order

Create an order note

Add a note to an order for tracking or customer communication

List all orders

List all orders with filtering and pagination

Update an order

Update order status, details, or metadata

Batch create, update, or delete orders

Process multiple order operations in a single request. Use this for bulk status updates, importing orders from external systems, or cleaning up test orders.

Delete a refund record

Remove a refund record from an order. Note that this only deletes the refund record in WooCommerce and does not reverse the actual payment refund.

Delete an order

Move an order to the trash or permanently delete it. Use this to remove test orders or clean up cancelled transactions that are no longer needed.

Delete an order note

Remove a note from an order. Use this to clean up incorrect notes or remove outdated internal messages that no longer apply.

List all notes for an order

Retrieve all notes attached to a specific order, including private internal notes and customer-facing messages. Use this to review the history of communications and status changes for an order.

List all refunds for an order

Retrieve all refunds issued for a specific order. Use this to track refund history, reconcile financial records, or display refund status to customers.

Retrieve a refund by ID

Fetch the details of a specific refund including the refunded amount, reason, and line items. Use this to verify refund details for accounting or customer support purposes.

Retrieve an order by ID

Fetch the full details of a specific order including line items, totals, shipping address, and payment status. Use this to display order information in dashboards or trigger fulfillment workflows.

Retrieve an order note by ID

Fetch a specific note attached to an order. Use this to verify the content or visibility of a particular note when auditing order communications.

List all payment gateways

Retrieves all configured payment gateways and their current settings, enabling you to verify which payment methods are active and review their configurations.

Retrieve a payment gateway by ID

Fetch the full configuration of a specific payment gateway including its title, description, and enabled status. Use this to verify gateway settings or display payment method details.

Update a payment gateway

Modify the settings of a payment gateway such as its title, description, or enabled status. Use this to toggle payment methods on or off, or update gateway display settings.

Batch create, update, or delete attribute terms

Process multiple attribute term operations in a single request. Use this to populate all values for an attribute at once, such as adding all available sizes or colors in bulk.

Create a term for a product attribute

Add a new value to a product attribute, such as adding 'Green' to the 'Color' attribute. These terms can then be used for product variations and catalog filtering.

Delete an attribute term

Permanently remove a term from a product attribute. Use with caution as this may affect product variations that reference this term.

List all terms for a product attribute

Retrieve all terms (values) for a specific product attribute, such as all colors under the 'Color' attribute. Use this to build filter dropdowns or sync attribute values with external systems.

Retrieve an attribute term

Fetch the details of a specific attribute term including its name, slug, and sort order. Use this to verify term configuration or look up the term ID for product assignments.

Update an attribute term

Update an existing attribute term's name, slug, description, or sort order to keep product attributes accurate and organized for your store.

Batch create, update, or delete product attributes

Process multiple product attribute operations in a single request. Use this to set up your catalog's attribute structure in bulk when initializing a new store or syncing from an external system.

Create a product attribute

Define a new global product attribute such as color, size, or material. Once created, you can add terms (values) to the attribute and assign it to products for filtering and variations.

Delete a product attribute

Permanently remove a product attribute and all its terms. Use with caution as this will affect any products and variations using this attribute.

List all product attributes

Retrieve all product attributes like color, size, or material that are used across your catalog. Use this to build filter interfaces or sync attribute definitions with external product management tools.

Retrieve a product attribute

Fetches details of a specific product attribute, such as its name, slug, and sort order, so you can verify its configuration before using it with products.

Update a product attribute

Modify a product attribute's name, slug, or sort order. Use this to rename attributes or change how they are displayed in your store's product filters.

Batch create, update, or delete product categories

Lets you create, update, or delete multiple product categories in a single API call, so you can quickly set up or reorganize your entire catalog taxonomy without repetitive manual work.

Create a product category

Add a new category to organize your product catalog. Supports hierarchical categories with parent-child relationships, custom images, and display settings for your storefront.

Delete a product category

Permanently remove a product category. Products in this category will not be deleted but will no longer be associated with it. Child categories may be reassigned.

List all product categories

Retrieve all product categories in your store's catalog hierarchy. Use this to build category navigation, sync taxonomy with external marketplaces, or generate category-based product feeds.

Retrieve a product category by ID

Fetch the details of a specific product category including its name, slug, parent category, image, and product count. Use this to verify category configuration or display category information.

Update a product category

Modify a category's name, description, image, parent, or display settings. Use this to reorganize your catalog structure, update category images for seasonal promotions, or change display order.

Batch create, update, or delete product reviews

Handles multiple review operations—creating, updating, or deleting—in a single request, saving time when managing large volumes of customer feedback for your WooCommerce store.

Create a product review

Add a new review for a product with a rating, reviewer details, and review text. Use this to import reviews from external sources or create reviews from verified purchase feedback.

Delete a product review

Permanently remove a product review. Use this to remove spam, inappropriate content, or duplicate reviews from your store.

List all product reviews

Retrieve all product reviews from your WooCommerce store, enabling you to moderate content, analyze customer feedback, and repurpose reviews in marketing channels.

Retrieve a product review

Fetch the full details of a specific product review including its rating, reviewer information, and verification status. Use this to display individual review details or check moderation status.

Update a product review

Modify a product review's content, rating, or status. Use this for moderation tasks like approving reviews, editing inappropriate content, or marking reviews as verified.

Batch create, update, or delete shipping classes

Process multiple shipping class operations in a single request. Use this to set up shipping classes in bulk when configuring a new store's shipping strategy.

Create a shipping class

Create a new shipping class to group products that share similar shipping costs or requirements, such as heavy items, fragile goods, or oversized packages.

Delete a shipping class

Permanently remove a shipping class. Products previously assigned to this class will no longer have a shipping class and will use the default shipping rates.

List all shipping classes

Retrieve all shipping classes used to group products with similar shipping requirements. Use this to review shipping class assignments or sync with external shipping rate calculators.

Retrieve a shipping class

Fetch the details of a specific shipping class including its name, slug, and description. Use this to verify shipping class configuration before assigning it to products.

Update a shipping class

Modifies the name, slug, or description of an existing shipping class to keep your shipping strategy aligned with evolving product categories or business needs.

Batch create, update, or delete product tags

Process multiple tag operations in a single request. Use this to import tags from another platform, bulk-rename tags for consistency, or remove unused tags.

Create a product tag

Add a new tag for cross-cutting product classification beyond categories. Tags provide flexible labeling for seasonal collections, promotional groupings, or feature-based filtering.

Delete a product tag

Permanently remove a product tag. Products previously assigned this tag will no longer have it, but the products themselves are not affected.

List all product tags

Retrieve all product tags used for flexible, non-hierarchical product grouping. Use this to build tag clouds, sync tags with external systems, or audit tag usage across your catalog.

Retrieve a product tag by ID

Fetches the name, slug, and product count for a specific product tag to help you verify its details or assess usage before making changes.

Update a product tag

Modify a product tag's name, slug, or description. Use this to rename tags for better clarity or update their descriptions for internal documentation.

Batch create, update, or delete product variations

Process multiple variation operations in a single request. Use this to set up all size and color combinations at once, bulk-update variation prices, or remove discontinued variants.

Create a product variation

Add a new variation to a variable product with its own price, SKU, stock level, and attribute combination. Use this to offer multiple versions of a product, such as different sizes or colors.

Delete a product variation

Permanently remove a variation from a variable product. Use this to discontinue specific size or color options that are no longer available.

List all variations for a product

Retrieve all variations of a variable product, each representing a specific combination of attributes like size and color. Use this to manage inventory levels per variation or sync variation data with external fulfillment systems.

Retrieve a product variation by ID

Fetch the full details of a specific product variation including its price, stock status, SKU, and attribute values. Use this to check inventory for a particular variant or display variation-specific information.

Update a product variation

Modify a product variation's price, stock quantity, SKU, or other settings. Use this to adjust pricing for specific variants, update inventory after restocking, or change variation images.

Create a new product

Create a new product in your store

List all products

List all products with filtering and search

Update a product

Update product details, pricing, or inventory

Batch create, update, or delete products

Process multiple product operations in a single request. Use this for bulk catalog imports, mass price updates, or archiving discontinued products efficiently.

Delete a product

Move a product to the trash or permanently delete it. Use this to remove discontinued items or clean up test products from your catalog.

Duplicate a product

Create a copy of an existing product with all its details including attributes, images, and settings. Use this to quickly create similar products without re-entering all product data from scratch.

Retrieve a product by ID

Fetch the full details of a specific product including pricing, inventory, images, categories, and attributes. Use this to display product information or verify product data before updating.

Get coupons totals report

Retrieve a summary of coupon usage totals grouped by discount type. Use this to understand which types of promotions are most popular and track overall coupon performance.

Get customers totals report

Retrieve customer count totals grouped by role, showing how many customers are paying versus non-paying. Use this for customer segmentation analysis and growth tracking.

Get orders totals report

Retrieve order count totals grouped by status, showing how many orders are pending, processing, completed, refunded, and more. Use this for a quick overview of order pipeline health.

Get products totals report

Provides a breakdown of your product catalog by type, showing how many simple, variable, grouped, and external products you have, so you can monitor your product mix and growth.

Get reviews totals report

Instantly see how many product reviews are approved, pending, spam, or trashed so you can manage moderation workload and keep customer feedback visible.

Get sales report

Provides key sales metrics such as total revenue, order count, average order value, and top-selling products for any date range.

Get top sellers report

Retrieve a ranked list of your best-selling products by quantity sold within a date range. Use this to identify trending products, inform restocking decisions, or feature popular items in marketing.

List all available reports

Retrieve a list of all available report types such as sales, orders, customers, and products. Use this to discover which reports are available for your store analytics.

List all settings groups

Retrieve all WooCommerce settings groups such as general, products, tax, shipping, checkout, and email. Use this to discover available configuration areas before retrieving or updating individual settings.

Retrieve a specific setting

Fetch the current value and configuration of a specific setting within a group. Use this to check individual store settings like the base currency, weight unit, or store address.

Retrieve all settings in a group

Fetch all individual settings within a specific settings group. Use this to read store configuration for a particular area like currency settings, tax options, or email notification preferences.

Update a specific setting

Modify the value of a specific WooCommerce setting. Use this to programmatically configure store options like changing the currency, updating tax display settings, or toggling email notifications.

Add a shipping method to a zone

Add a shipping method (flat rate, free shipping, or local pickup) to a shipping zone. Configure the method's settings like cost and tax status after adding it.

Create a shipping zone

Define a new shipping zone for a geographic region where you want to offer specific shipping methods and rates. Add locations and methods to the zone after creation.

Delete a shipping zone

Permanently remove a shipping zone and its associated methods. Customers in the deleted zone's regions will fall back to the default 'Locations not covered by your other zones' zone.

List all shipping zones

Retrieve all shipping zones configured in your store. Shipping zones define geographic regions and the shipping methods available to customers in those areas.

List locations for a shipping zone

Retrieves all countries, states, postcodes, or continents assigned to a specific shipping zone, allowing you to verify which regions are covered by that zone's shipping methods.

List shipping methods for a zone

Retrieve all shipping methods available in a specific shipping zone, such as flat rate, free shipping, or local pickup. Use this to review the shipping options customers see during checkout.

Remove a shipping method from a zone

Delete a shipping method instance from a zone. Customers in this zone will no longer see this shipping option during checkout.

Retrieve a shipping method from a zone

Fetch the full configuration of a specific shipping method instance within a zone, including its cost, tax status, and enabled state.

Retrieve a shipping zone by ID

Fetch the details of a specific shipping zone including its name and sort order. Use this with the locations and methods endpoints to get the full zone configuration.

Update a shipping method in a zone

Allows you to adjust individual shipping method settings within a zone, such as updating costs, toggling availability, or modifying tax options without recreating the entire method.

Update a shipping zone

Modify a shipping zone's name or sort order. Use this to rename zones or change the priority in which zones are evaluated during checkout.

Update locations for a shipping zone

Replace all locations for a shipping zone with a new set of countries, states, postcodes, or continents. This is a full replacement, so include all desired locations in the request.

Get system status overview

Retrieve a comprehensive overview of your WooCommerce installation including environment details, database info, active plugins, theme data, and security checks. Use this for diagnostics and monitoring store health.

List all system status tools

Retrieve all available system maintenance tools such as clearing transients, resetting usage tracking, or regenerating thumbnails. Use this to discover available maintenance actions.

Retrieve a system status tool

Fetch the details of a specific system status tool including its name, description, and whether a confirmation is required before running it.

Run a system status tool

Triggers built-in maintenance tasks like clearing cached data or rebuilding product tables to keep your store running smoothly without manual effort

Batch create, update, or delete tax rates

Manage multiple tax rate entries in a single API call, enabling efficient setup or updates of tax rules across different jurisdictions.

Create a tax class

Define a new tax class for products that require different tax treatment, such as digital goods, luxury items, or food products. After creation, assign tax rates to the new class.

Create a tax rate

Define a new tax rate for a specific country, state, or postcode. Specify the rate percentage, tax name, priority, and whether it applies to shipping. Use this to set up tax rules for new sales regions.

Delete a tax class

Permanently remove a tax class. Products assigned to this class will need to be reassigned to another tax class. The default 'Standard' class cannot be deleted.

Delete a tax rate

Permanently removes a tax rate from your store. Previously placed orders remain unchanged, but future transactions will not apply this rate.

List all tax classes

Retrieve all tax classes such as standard, reduced rate, and zero rate. Tax classes group products that share the same tax rate rules and are assigned at the product level.

List all tax rates

Retrieves all tax rates currently configured in your WooCommerce store, allowing you to review, audit, or export them for external use.

Retrieve a tax class by slug

Fetch the details of a specific tax class by its slug identifier. Use this to verify tax class configuration or look up class details before assigning it to products.

Retrieve a tax rate by ID

Fetch the full details of a specific tax rate including its country, state, rate percentage, and applicable tax class. Use this to verify tax configuration for a particular jurisdiction.

Update a tax rate

Modify a tax rate's percentage, applicable region, or settings. Use this to adjust rates when tax laws change or to correct misconfigured tax rules for specific jurisdictions.

Batch create, update, or delete webhooks

Process multiple webhook operations in a single request. Use this to set up all required event subscriptions at once during integration setup, or to clean up stale webhook registrations.

Create a new webhook

Register a webhook to receive real-time notifications when specific events occur in your store, such as new orders, product updates, or customer registrations. Specify the topic, delivery URL, and secret for signature verification.

Delete a webhook

Permanently remove a webhook subscription. Use this during integration teardown to stop receiving event notifications at the registered endpoint.

List all webhooks

Retrieve all registered webhooks and their delivery status. Use this to audit active webhook subscriptions, check for failed deliveries, or verify that all required events are being monitored.

Retrieve a webhook by ID

Fetch the full details of a specific webhook including its topic, delivery URL, status, and recent delivery history. Use this to troubleshoot webhook delivery issues.

Update a webhook

Modify a webhook's delivery URL, topic, status, or secret. Use this to update the endpoint when migrating services, or to temporarily pause a webhook by setting its status to disabled.