woocommerce-rest-api

WooCommerce REST API

Overview

WooCommerce ships a versioned REST API (/wp-json/wc/v3/) that exposes products, orders, customers, coupons, and store settings over HTTPS. It uses OAuth 1.0a for non-HTTPS environments and Basic Auth (consumer key/secret) over HTTPS. The official @woocommerce/woocommerce-rest-api Node.js client handles authentication automatically and supports the full CRUD surface.

When to Use This Skill

• When building a headless storefront that reads products and categories from WooCommerce
• When integrating WooCommerce with an ERP, CRM, or fulfillment system
• When creating an order management dashboard outside of WordPress Admin
• When syncing inventory between WooCommerce and a warehouse or POS system
• When automating bulk product imports or price updates from an external catalog
• When building a mobile app that needs access to WooCommerce store data

Core Instructions

1. Generate API credentials

   In WordPress Admin → WooCommerce → Settings → Advanced → REST API → Add Key:

   • Description: My Integration
   • User: (admin user)
   • Permissions: Read/Write

   This generates a Consumer Key (ck_xxx) and Consumer Secret (cs_xxx). Store them in environment variables, never in source code.

   WOOCOMMERCE_URL=https://mystore.com
   WOOCOMMERCE_CONSUMER_KEY=ck_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
   WOOCOMMERCE_CONSUMER_SECRET=cs_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
   

2. Set up the Node.js client

   npm install @woocommerce/woocommerce-rest-api
   

   // lib/woocommerce.ts
   import WooCommerceRestApi from "@woocommerce/woocommerce-rest-api";
   
   export const woo = new WooCommerceRestApi({
     url: process.env.WOOCOMMERCE_URL!,
     consumerKey: process.env.WOOCOMMERCE_CONSUMER_KEY!,
     consumerSecret: process.env.WOOCOMMERCE_CONSUMER_SECRET!,
     version: "wc/v3",
     axiosConfig: {
       timeout: 15000,
     },
   });
   

3. Query products with filtering and pagination