
Security News
Meet Socket at Black Hat and DEF CON 2025 in Las Vegas
Meet Socket at Black Hat & DEF CON 2025 for 1:1s, insider security talks at Allegiant Stadium, and a private dinner with top minds in software supply chain security.
woocommerce-api
Advanced tools
A Node.js client for the WooCommerce REST API. Easily interact with the WooCommerce REST API using this library.
- 2019-07-29: This client is obsolete and will no longer receive updates, a new JavaScript library is available under the name of @woocommerce/woocommerce-rest-api
.
npm install --save woocommerce-api
Generate API credentials (Consumer Key & Consumer Secret) following this instructions http://docs.woocommerce.com/document/woocommerce-rest-api/ .
Check out the WooCommerce API endpoints and data that can be manipulated in http://woocommerce.github.io/woocommerce-rest-api-docs/.
Setup for the new WP REST API integration (WooCommerce 2.6 or later):
var WooCommerceAPI = require('woocommerce-api');
var WooCommerce = new WooCommerceAPI({
url: 'http://example.com',
consumerKey: 'ck_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
consumerSecret: 'cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
wpAPI: true,
version: 'wc/v1'
});
Setup for the old WooCommerce legacy API:
var WooCommerceAPI = require('woocommerce-api');
var WooCommerce = new WooCommerceAPI({
url: 'http://example.com',
consumerKey: 'ck_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
consumerSecret: 'cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
version: 'v3'
});
Option | Type | Required | Description |
---|---|---|---|
url | String | yes | Your Store URL, example: http://woo.dev/ |
consumerKey | String | yes | Your API consumer key |
consumerSecret | String | yes | Your API consumer secret |
wpAPI | Bool | no | Allow requests to the WP REST API (WooCommerce 2.6 or later) |
wpAPIPrefix | String | no | Custom WP REST API URL prefix, used to support custom prefixes created with the rest_url_prefix filter |
version | String | no | API version, default is v3 |
verifySsl | Bool | no | Verify SSL when connect, use this option as false when need to test with self-signed certificates |
encoding | String | no | Encoding, default is 'utf-8' |
queryStringAuth | Bool | no | When true and using under HTTPS force Basic Authentication as query string, default is false |
port | string | no | Provide support for URLs with ports, eg: 8080 |
timeout | Integer | no | Define the request timeout |
agent | Agent | no | User agent instance. |
Params | Type | Description |
---|---|---|
endpoint | String | WooCommerce API endpoint, example: customers or order/12 |
data | Object | JS object, will be converted to JSON |
callback | Function | Callback function. Returns err , data and res |
.get(endpoint)
.get(endpoint, callback)
.post(endpoint, data)
.post(endpoint, data, callback)
.put(endpoint, data)
.put(endpoint, data, callback)
.delete(endpoint)
.delete(endpoint, callback)
.options(endpoint)
.options(endpoint, callback)
Every method can be used in a promified way just adding Async
to the method name. Like in:
WooCommerce.getAsync('products').then(function(result) {
return JSON.parse(result.toJSON().body);
});
agent
.wpAPIPrefix
option to allow custom WP REST API Url prefix and support for promified methods.timeout
option and updated dependencies.queryStringAuth
option to allow Basic Authentication as query string.FAQs
A Node.js wrapper for the WooCommerce REST API
The npm package woocommerce-api receives a total of 2,098 weekly downloads. As such, woocommerce-api popularity was classified as popular.
We found that woocommerce-api demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Meet Socket at Black Hat & DEF CON 2025 for 1:1s, insider security talks at Allegiant Stadium, and a private dinner with top minds in software supply chain security.
Security News
CAI is a new open source AI framework that automates penetration testing tasks like scanning and exploitation up to 3,600× faster than humans.
Security News
Deno 2.4 brings back bundling, improves dependency updates and telemetry, and makes the runtime more practical for real-world JavaScript projects.