woocommerce/ woocommerce-rest-api-js-lib

JavaScript

Need help with woocommerce-rest-api-js-lib?

Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

woocommerce

175 Stars

43 Forks

MIT License

93 Commits

59 Opened issues

Description

New JavaScript library for WooCommerce REST API

Services available

Need anything else?

Contributors list

Readme

WooCommerce REST API - JavaScript Library

Name: woocommerce-rest-api-js-lib
Brand: woocommerce-rest-api-js-lib
SKU: //woocommerce/woocommerce-rest-api-js-lib
Rating: 2.1875 (175 reviews)

New JavaScript library for WooCommerce REST API, supports CommonJS (CJS) and Embedded System Module (ESM).

Requests are made with Axios library with support to promises.

Installation

npm install --save @woocommerce/woocommerce-rest-api

Getting started

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

ESM example:

import WooCommerceRestApi from "@woocommerce/woocommerce-rest-api";

const api = new WooCommerceRestApi({
  url: "http://example.com",
  consumerKey: "ck_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  consumerSecret: "cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  version: "wc/v3"
});

CJS example:

const WooCommerceRestApi = require("@woocommerce/woocommerce-rest-api").default;

const api = new WooCommerceRestApi({
  url: "http://example.com",
  consumerKey: "ck_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  consumerSecret: "cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  version: "wc/v3"
});

Options

| 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 | |

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

| |

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:

| |

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

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

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

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

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

orders/12

| |

params

Object

| Query strings params |

Example of use

// import WooCommerceRestApi from "@woocommerce/woocommerce-rest-api";
const WooCommerceRestApi = require("@woocommerce/woocommerce-rest-api").default;

const api = new WooCommerceRestApi({
  url: "http://example.com",
  consumerKey: "ck_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  consumerSecret: "cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  version: "wc/v3"
});
// List products
api.get("products", {
  per_page: 20, // 20 products per page
})
  .then((response) => {
    // Successful request
    console.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 statuses
    console.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 product
api.post("products", {
  name: "Premium Quality", // See more in https://woocommerce.github.io/woocommerce-rest-api-docs/#product-properties
  type: "simple",
  regular_price: "21.99",
})
  .then((response) => {
    // Successful request
    console.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 statuses
    console.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 product
api.put("products/1", {
  sale_price: "11.99", // See more in https://woocommerce.github.io/woocommerce-rest-api-docs/#product-properties
})
  .then((response) => {
    // Successful request
    console.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 statuses
    console.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 product
api.delete("products/1", {
  force: true, // Forces to delete instead of move to the Trash
})
  .then((response) => {
    // Successful request
    console.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 statuses
    console.log("Response Status:", error.response.status);
    console.log("Response Headers:", error.response.headers);
    console.log("Response Data:", error.response.data);
  })
  .finally(() => {
    // Always executed.
  });

Changelog

See changelog for details