WooCommerce Rest API

Interact with WooCommerce - REST interface

What is WooCommerce Rest API

WooCommerce REST API is an interface that allows external systems to interact with WooCommerce, which is a popular open-source e-commerce plugin for WordPress. It provides developers with a set of endpoints through which they can perform various operations like creating, reading, updating, and deleting data within a WooCommerce store.

Here are some key aspects of the WooCommerce REST API:

  1. Endpoints: The REST API provides endpoints for different resources such as products, orders, customers, coupons, and more. Each endpoint represents a specific type of data within the WooCommerce system.
  2. HTTP Methods: The API supports standard HTTP methods like GET, POST, PUT, PATCH, and DELETE for performing CRUD (Create, Read, Update, Delete) operations on resources.
  3. Authentication: To access the API, authentication is required. WooCommerce REST API supports various authentication methods including OAuth 1.0a, OAuth 2.0, and basic authentication.
  4. Data Formats: The API supports both JSON and XML data formats for requests and responses. JSON is the most commonly used format due to its simplicity and widespread support.
  5. Versioning: WooCommerce REST API is versioned to maintain backward compatibility. Different versions may introduce new features or changes while ensuring compatibility with existing implementations.
  6. Customization: Developers can extend the functionality of the API by creating custom endpoints or integrating additional plugins to enhance specific features.
  7. Security: Security measures such as rate limiting, CORS (Cross-Origin Resource Sharing), and authentication mechanisms are implemented to protect the API from unauthorized access and potential abuse.

Overall, the WooCommerce REST API empowers developers to integrate WooCommerce with external applications, platforms, or services, enabling seamless e-commerce experiences and efficient management of online stores.

WooCommerce Rest API – Doc

In order to use the WooCommerce API you need to create API Credentials. WooCommerce->Setting->Advanced->REST API. Create a user with an associated Consumer Key and Secret Key

WooCommerce-REST-API
WooCommerce-REST-API

Advantages with WordPress REST API

The WooCommerce REST API offers several advantages for developers and businesses looking to integrate WooCommerce with external systems or build custom e-commerce solutions:

  1. Flexibility: The REST API provides a flexible and robust interface for interacting with WooCommerce, allowing developers to perform various operations such as managing products, orders, customers, and more.
  2. Integration: It enables seamless integration of WooCommerce with other systems, platforms, or services, including third-party applications, CRM (Customer Relationship Management) systems, ERP (Enterprise Resource Planning) systems, and more.
  3. Customization: Developers can extend the functionality of WooCommerce by creating custom endpoints or integrating additional plugins, enabling them to tailor the e-commerce experience to specific business requirements.
  4. Automation: The API facilitates automation of tasks such as importing/exporting product data, processing orders, updating inventory, and managing customer information, leading to increased efficiency and productivity.
  5. Scalability: Businesses can scale their e-commerce operations more effectively by leveraging the REST API to automate processes and integrate with other systems, thereby accommodating growth and expanding their reach.
  6. Multi-channel Selling: With the REST API, businesses can easily manage multiple sales channels, including websites, mobile apps, marketplaces, and more, by synchronizing data across different platforms and ensuring consistency in product information and inventory levels.
  7. Headless Commerce: The API supports headless commerce architecture, allowing developers to build custom front-end experiences using technologies like React, Vue.js, or Angular, while still leveraging the powerful backend capabilities of WooCommerce.
  8. Real-time Updates: Developers can implement real-time updates and notifications by leveraging webhooks, enabling businesses to stay informed about important events such as new orders, order status changes, and inventory updates.
  9. Security: The API includes security features such as authentication mechanisms, rate limiting, and CORS support to protect against unauthorized access and potential security threats, ensuring the integrity and confidentiality of data.
  10. Community Support: WooCommerce has a large and active community of developers and contributors who provide support, documentation, and resources for working with the REST API, making it easier for developers to get started and troubleshoot issues.

Overall, the WooCommerce REST API empowers businesses to create custom e-commerce solutions, streamline operations, and deliver seamless shopping experiences to customers across various channels.

Using WooCommerce REST API

WooCommerce REST API Crendential

Get ALL Products – Route

Get ALL Products – Consumer and Secret Key

Create a Product – Route

Create a Product – Auth

Create a Product – Header

Create a Product – Body

Base URL(essentially the root endpoint where all API requests are directed) for accessing the WordPress REST API

[GET]

https://yourdomain.com/wp-json/wc/v3/

  • https://yourdomain.com is the domain of your WordPress website where WooCommerce is installed.
  • /wp-json/ is a standard WordPress REST API endpoint.
  • /wc/v3/ specifies the version of the WooCommerce REST API you’re using. v3 is the version number, and it may vary depending on the version of WooCommerce you have installed.

So, when making requests to the WooCommerce REST API, you’ll append specific endpoints to this base URL to access different resources such as products, orders, customers, etc.

For example, to get a list of products, you would append the /products endpoint to the base URL:

https://yourdomain.com/wp-json/wc/v3/products

Products

[GET]

http://yourdomain.com/wp-json/wc/v3/products

Retrieve information about all  products

[GET]

http://yourdomain.com/wp-json/wc/v3/products/348

Retrieve information about a specific product with the ID 348

  1. Products Endpoint:
    • /wp-json/wc/v3/products: Retrieve a list of products.
    • /wp-json/wc/v3/products/{id}: Retrieve a specific product by its ID.
    • /wp-json/wc/v3/products/?sku=CP-9020262-EU: Retrieve a specific product by its SKU
    • /wp-json/wc/v3/products/categories: Retrieve a list of product categories.
    • /wp-json/wc/v3/products/{id}/variations: Retrieve product variations for a variable product.
    • /wp-json/wc/v3/products?type=variable: Retrieve products that are a variable product.
    • /wp-json/wc/v3/products?type=simple: Retrieve products that are a simple product.

 

Its actualy possible to retrieve (only GET http verb) directly in the browser

All products

https://yourdomain.com/wp-json/wc/v3/products?consumer_key=your_consumer_key&consumer_secret=your_consumer_secret

Single product products

https://yourdomain.com/wp-json/wc/v3/products/388?consumer_key=your_consumer_key&consumer_secret=your_consumer_secret

P.S This follow the same structure for orders, customers and so on. Just replace products with rders, customers…..

Orders

[GET]

http://yourdomain.com/wp-json/wc/v3/orders

Retrieve a list of orders.

[GET]

http://yourdomain.com/wp-json/wc/v3/orders/123

Retrieve information about a specific order with the ID 123

  • Orders Endpoint:
    • /wp-json/wc/v3/orders: Retrieve a list of orders.
    • /wp-json/wc/v3/orders/{id}: Retrieve a specific order by its ID.
    • /wp-json/wc/v3/orders/{id}/notes: Retrieve order notes for a specific order.

Customers

[GET]

http://yourdomain.com/wp-json/wc/v3/customers

Retrieve a list of all customers.

[GET]

http://yourdomain.com/wp-json/wc/v3/customers/123

Retrieve information about a specific customers with the ID 123

  • Customers Endpoint:
    • /wp-json/wc/v3/customers: Retrieve a list of customers.
    • /wp-json/wc/v3/customers/{id}: Retrieve a specific customer by their ID.

Coupons

[GET]

http://yourdomain.com/wp-json/wc/v3/coupons

Retrieve a list of couponss.

[GET]

http://yourdomain.com/wp-json/wc/v3/coupons/123

Retrieve information about a specific coupon ID 123

  • Coupons Endpoint:
    • /wp-json/wc/v3/coupons: Retrieve a list of coupons.
    • /wp-json/wc/v3/coupons/{id}: Retrieve a specific coupon by its ID.

Shipping Zones Endpoint

[GET]

http://yourdomain.com/wp-json/wc/v3/shipping/zones

Retrieve a list of shippping zones.

[GET]

http://yourdomain.com/wp-json/wc/v3/shipping/zones/123

Retrieve information about shipping zone with id 123. No auth requrired.

  • Shipping Zones Endpoint:
    • /wp-json/wc/v3/shipping/zones: Retrieve a list of shipping zones.
    • /wp-json/wc/v3/shipping/zones/{id}: Retrieve a specific shipping zone by its ID.

Webhooks Endpoint

[GET]

http://yourdomain.com/wp-json/wc/v3/webhooks

Retrieve a list of all registrated webhooks . No auth requrired.

[GET]

http://yourdomain.com/wp-json/wc/v3/webhooks/123

Retrieve information about a specific webhook with ID 123

  • Webhooks Endpoint:
    • /wp-json/wc/v3/webhooks: Retrieve a list of registered webhooks.
    • /wp-json/wc/v3/webhooks/{id}: Retrieve a specific webhook by its ID.

API Call From Web Browser - Only GET request

WooCommerce

General form for products
https://your-domain.com/wp-json/wc/v3/products?consumer_key=your_consumer_key&consumer_secret=your_consumer_secret

For product with id 348
https://your-domain.com/wp-json/wc/v3/products/348?consumer_key=your_consumer_key&consumer_secret=your_consumer_secret

 

General form for orders
https://your-domain.com/wp-json/wc/v3/orders?consumer_key=your_consumer_key&consumer_secret=your_consumer_secret

For order with id 377
https://your-domain.com/wp-json/wc/v3/orders/377?consumer_key=your_consumer_key&consumer_secret=your_consumer_secret

 

General form for customers
https://your-domain.com/wp-json/wc/v3/customers?consumer_key=your_consumer_key&consumer_secret=your_consumer_secret

For customer with id 4
https://your-domain.com/wp-json/wc/v3/customers/4?consumer_key=your_consumer_key&consumer_secret=your_consumer_secret

Just replace the value for your_consumer_key and your_consumer_secret