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
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
axiosConfig
Object
no
Define the custom Axios config, also override this library options
Methods
GET
.get(endpoint)
.get(endpoint, params)
Params
Type
Description
endpoint
String
WooCommerce API endpoint, example: customers or orders/12
params
Object
Query strings params, example: { per_page: 20 }
POST
.post(endpoint, data)
.post(endpoint, data, params)
Params
Type
Description
endpoint
String
WooCommerce API endpoint, example: customers or orders
data
Object
JS object to be converted into JSON and sent in the request
params
Object
Query strings params
PUT
.put(endpoint, data)
.put(endpoint, data, params)
Params
Type
Description
endpoint
String
WooCommerce API endpoint, example: customers/1 or orders/1234
data
Object
JS object to be converted into JSON and sent in the request
params
Object
Query strings params
DELETE
.delete(endpoint)
.delete(endpoint, params)
Params
Type
Description
endpoint
String
WooCommerce API endpoint, example: customers/2 or orders/12
params
Object
Query strings params, example: { force: true }
OPTIONS
.options(endpoint)
.options(endpoint, params)
Params
Type
Description
endpoint
String
WooCommerce API endpoint, example: customers/2 or orders/12
params
Object
Query strings params
Example of use
// import WooCommerceRestApi from "@woocommerce/woocommerce-rest-api";constWooCommerceRestApi=require("@woocommerce/woocommerce-rest-api").default;constapi=newWooCommerceRestApi({url: "http://example.com",consumerKey: "ck_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",consumerSecret: "cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",version: "wc/v3"});// List productsapi.get("products",{per_page: 20,// 20 products per page}).then((response)=>{// Successful requestconsole.log("Response Status:",response.status);console.log("Response Headers:",response.headers);console.log("Response Data:",response.data);console.log("Total of pages:",response.headers['x-wp-totalpages']);console.log("Total of items:",response.headers['x-wp-total']);}).catch((error)=>{// Invalid request, for 4xx and 5xx statusesconsole.log("Response Status:",error.response.status);console.log("Response Headers:",error.response.headers);console.log("Response Data:",error.response.data);}).finally(()=>{// Always executed.});// Create a productapi.post("products",{name: "Premium Quality",// See more in https://woocommerce.github.io/woocommerce-rest-api-docs/#product-propertiestype: "simple",regular_price: "21.99",}).then((response)=>{// Successful requestconsole.log("Response Status:",response.status);console.log("Response Headers:",response.headers);console.log("Response Data:",response.data);}).catch((error)=>{// Invalid request, for 4xx and 5xx statusesconsole.log("Response Status:",error.response.status);console.log("Response Headers:",error.response.headers);console.log("Response Data:",error.response.data);}).finally(()=>{// Always executed.});// Edit a productapi.put("products/1",{sale_price: "11.99",// See more in https://woocommerce.github.io/woocommerce-rest-api-docs/#product-properties}).then((response)=>{// Successful requestconsole.log("Response Status:",response.status);console.log("Response Headers:",response.headers);console.log("Response Data:",response.data);}).catch((error)=>{// Invalid request, for 4xx and 5xx statusesconsole.log("Response Status:",error.response.status);console.log("Response Headers:",error.response.headers);console.log("Response Data:",error.response.data);}).finally(()=>{// Always executed.});// Delete a productapi.delete("products/1",{force: true,// Forces to delete instead of move to the Trash}).then((response)=>{// Successful requestconsole.log("Response Status:",response.status);console.log("Response Headers:",response.headers);console.log("Response Data:",response.data);}).catch((error)=>{// Invalid request, for 4xx and 5xx statusesconsole.log("Response Status:",error.response.status);console.log("Response Headers:",error.response.headers);console.log("Response Data:",error.response.data);}).finally(()=>{// Always executed.});
