WooCommerce

About WooCommerce

WooCommerce's REST API integrates with the WordPress REST API, allowing WooCommerce store data to be created, read, updated, and deleted via JSON requests over standard HTTP verbs. It is built on WP REST API v3 and requires WooCommerce 3.5+ and WordPress 4.4+, with pretty permalinks enabled for the custom endpoints to work.

The API covers coupons, customers, orders (including order notes, refunds, and actions like sending order emails), products (including variations, attributes, categories, tags, shipping classes, and reviews), reports, tax rates and classes, webhooks, settings, payment gateways, shipping zones and methods, system status, and reference data such as countries, currencies, and continents. Responses are returned in JSON by default, with dates in ISO8601 format, resource IDs as integers, and monetary amounts as decimal strings.

Authentication is handled through REST API keys, with separate methods documented for use over HTTPS and over HTTP. The API also supports JSONP for GET requests. It is intended for developers building integrations or applications that interact with WooCommerce-powered WordPress stores.

Key features

• REST API for creating, reading, updating, and deleting WooCommerce store data
• Manage products, product variations, attributes, categories, and reviews
• Manage orders, order notes, and order refunds
• Manage customers and retrieve customer downloads
• Configure coupons, tax rates, shipping zones, and payment gateways
• Webhooks support for event-driven notifications

Frequently asked questions