REST API v3
The current and recommended version of the WooCommerce REST API. Use /wp-json/wc/v3/ endpoints for all new integrations.
When WooPayments is active, it adds /wp-json/wc/v3/payments/ endpoints for payment reports, authorizations, and payouts. See the WooPayments REST API reference for their response formats.
API Reference
By default, the API provides information about all available endpoints on the site. Authentication is not required to access the API index.
Coupons
The coupons API allows you to create, view, update, and delete individual, or a batch, of coupon codes.
Customers
The customer API allows you to create, view, update, and delete individual, or a batch, of customers.
Orders
The orders API allows you to create, view, update, and delete individual, or a batch, of orders.
Order Actions
The order actions API allows you to perform specific actions with existing orders like you can from the Edit Order screen in the web app.
Order Notes
The order notes API allows you to create, view, and delete individual order notes.
Order Refunds
The order refunds API allows you to create, view, and delete individual refunds, based on an existing order.
Order Fulfillments
The order fulfillments API allows you to create, view, update, and delete fulfillments for an order, along with their metadata (tracking numbers, shipment provider, and any custom data you want to attach).
Products
The products API allows you to create, view, update, and delete individual, or a batch, of products.
Product Variations
The product variations API allows you to create, view, update, and delete individual, or a batch, of product variations.
Product Attributes
The product attributes API allows you to create, view, update, and delete individual, or a batch, of product attributes.
Product Attribute Terms
The product attribute terms API allows you to create, view, update, and delete individual, or a batch, of attribute terms.
Product Categories
The product categories API allows you to create, view, update, and delete individual, or a batch, of categories.
Product Custom Fields
The product custom fields API allows you to view the custom field names that have been recorded.
Product Shipping Classes
The product shipping class API allows you to create, view, update, and delete individual, or a batch, of shipping classes.
Product Tags
The product tags API allows you to create, view, update, and delete individual, or a batch, of product tags.
Product Reviews
The product reviews API allows you to create, view, update, and delete individual, or a batch, of product reviews.
Reports
The reports API allows you to view all types of reports available.
Refunds
The refunds API is a simple, read-only endpoint that allows you to retrieve a list of refunds outside the context of an existing order. To create, view, and delete individual refunds, check out the order refunds API.
Taxes
The taxes API allows you to create, view, update, and delete individual tax rates, or a batch of tax rates.
Tax Classes
The tax classes API allows you to create, view, and delete individual tax classes.
Webhooks
The webhooks API allows you to create, view, update, and delete individual, or a batch, of webhooks.
Settings
The settings API allows you to view all groups of settings available.
Setting Options
Setting option properties
Payment Gateways
The payment gateways API allows you to view, and update individual payment gateways. Results are not paginated - all gateways will be returned.
Shipping Zones
The shipping zones API allows you to create, view, update, and delete individual shipping zones.
Shipping Zone Locations
The shipping zone locations API allows you to view and batch update locations of a shipping zone.
Shipping Zone Methods
The shipping zone methods API allows you to create, view, update, and delete individual methods of a shipping zone.
Shipping Methods
The shipping methods API allows you to view individual shipping methods.
System Status
The system status API allows you to view all system status items.
System Status Tools
The system status tools API allows you to view and run tools from system status.
Data
The data API allows you to view all types of data available.